diff --git a/discovery/accesscontextmanager-v1.json b/discovery/accesscontextmanager-v1.json index c475b3e72b..3003b9c071 100644 --- a/discovery/accesscontextmanager-v1.json +++ b/discovery/accesscontextmanager-v1.json @@ -1290,7 +1290,7 @@ } } }, - "revision": "20240623", + "revision": "20240811", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1332,6 +1332,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -1704,7 +1705,7 @@ "id": "EgressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -1903,7 +1904,7 @@ "id": "IngressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, diff --git a/discovery/addressvalidation-v1.json b/discovery/addressvalidation-v1.json index 62bbdf7378..8b20f509ea 100644 --- a/discovery/addressvalidation-v1.json +++ b/discovery/addressvalidation-v1.json @@ -151,7 +151,7 @@ } } }, - "revision": "20240430", + "revision": "20240703", "rootUrl": "https://addressvalidation.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -489,7 +489,7 @@ "type": "string" }, "dpvEnhancedDeliveryCode": { - "description": "Indicates that more than one DPV return code is valid for the address. Returns a single character. * `Y`: Address was DPV confirmed for primary and any secondary numbers. * `N`: Primary and any secondary number information failed to DPV confirm. * `S`: Address was DPV confirmed for the primary number only, and the secondary number information was present by not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required. * `D`: Address was DPV confirmed for the primary number only, and the secondary number information was missing. * `R`: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.", + "description": "Indicates that more than one DPV return code is valid for the address. Returns a single character. * `Y`: Address was DPV confirmed for primary and any secondary numbers. * `N`: Primary and any secondary number information failed to DPV confirm. * `S`: Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required. * `D`: Address was DPV confirmed for the primary number only, and the secondary number information was missing. * `R`: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.", "type": "string" }, "dpvFootnote": { diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 6d1b7ee3f3..63989910ca 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -3931,7 +3931,7 @@ ] }, "insert": { - "description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case.", + "description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.", "flatPath": "admin/directory/v1/users", "httpMethod": "POST", "id": "directory.users.insert", @@ -4671,7 +4671,7 @@ } } }, - "revision": "20240618", + "revision": "20240709", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/discovery/adsenseplatform-v1.json b/discovery/adsenseplatform-v1.json new file mode 100644 index 0000000000..c0c646b06b --- /dev/null +++ b/discovery/adsenseplatform-v1.json @@ -0,0 +1,721 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/adsense": { + "description": "View and manage your AdSense data" + }, + "https://www.googleapis.com/auth/adsense.readonly": { + "description": "View your AdSense data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://adsenseplatform.googleapis.com/", + "batchPath": "batch", + "canonicalName": "AdSense Platform", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/adsense/platforms/", + "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": "adsenseplatform:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", + "name": "adsenseplatform", + "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": { + "platforms": { + "resources": { + "accounts": { + "methods": { + "close": { + "description": "Closes a sub-account.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}:close", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.close", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:close", + "request": { + "$ref": "CloseAccountRequest" + }, + "response": { + "$ref": "CloseAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "create": { + "description": "Creates a sub-account.", + "flatPath": "v1/platforms/{platformsId}/accounts", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Platform to create an account for. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/accounts", + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "get": { + "description": "Gets information about the selected sub-account.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists a partial view of sub-accounts for a specific parent account.", + "flatPath": "v1/platforms/{platformsId}/accounts", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Platform who parents the accounts. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/accounts", + "response": { + "$ref": "ListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "lookup": { + "description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", + "flatPath": "v1/platforms/{platformsId}/accounts:lookup", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "creationRequestId": { + "description": "Optional. The creation_request_id provided when calling createAccount.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Platform who parents the account. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/accounts:lookup", + "response": { + "$ref": "LookupAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + }, + "resources": { + "events": { + "methods": { + "create": { + "description": "Creates an account event.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/events", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.events.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/events", + "request": { + "$ref": "Event" + }, + "response": { + "$ref": "Event" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + } + } + }, + "sites": { + "methods": { + "create": { + "description": "Creates a site for a specified account.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.sites.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "delete": { + "description": "Deletes a site from a specified account.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "adsenseplatform.platforms.accounts.sites.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "get": { + "description": "Gets a site from a specified sub-account.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.sites.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists sites for a specific account.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.sites.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "requestReview": { + "description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", + "flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.sites.requestReview", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:requestReview", + "response": { + "$ref": "RequestSiteReviewResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + } + } + } + } + } + } + } + }, + "revision": "20240722", + "rootUrl": "https://adsenseplatform.googleapis.com/", + "schemas": { + "Account": { + "description": "Representation of an Account.", + "id": "Account", + "properties": { + "createTime": { + "description": "Output only. Creation time of the account.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creationRequestId": { + "description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", + "type": "string" + }, + "displayName": { + "description": "Display name of this account.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", + "type": "string" + }, + "state": { + "description": "Output only. Approval state of the account.", + "enum": [ + "STATE_UNSPECIFIED", + "UNCHECKED", + "APPROVED", + "DISAPPROVED" + ], + "enumDescriptions": [ + "Unspecified.", + "Unchecked.", + "The account is ready to serve ads.", + "The account has been blocked from serving ads." + ], + "readOnly": true, + "type": "string" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." + } + }, + "type": "object" + }, + "Address": { + "description": "Address data.", + "id": "Address", + "properties": { + "address1": { + "description": "First line of address. Max length 64 bytes or 30 characters.", + "type": "string" + }, + "address2": { + "description": "Second line of address. Max length 64 bytes or 30 characters.", + "type": "string" + }, + "city": { + "description": "City. Max length 60 bytes or 30 characters.", + "type": "string" + }, + "company": { + "description": "Name of the company. Max length 255 bytes or 34 characters.", + "type": "string" + }, + "contact": { + "description": "Contact name of the company. Max length 128 bytes or 34 characters.", + "type": "string" + }, + "fax": { + "description": "Fax number with international code (i.e. +441234567890).", + "type": "string" + }, + "phone": { + "description": "Phone number with international code (i.e. +441234567890).", + "type": "string" + }, + "regionCode": { + "description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", + "type": "string" + }, + "state": { + "description": "State. Max length 60 bytes or 30 characters.", + "type": "string" + }, + "zip": { + "description": "Zip/post code. Max length 10 bytes or 10 characters.", + "type": "string" + } + }, + "type": "object" + }, + "CloseAccountRequest": { + "description": "Request definition for the account close rpc.", + "id": "CloseAccountRequest", + "properties": {}, + "type": "object" + }, + "CloseAccountResponse": { + "description": "Response definition for the account close rpc.", + "id": "CloseAccountResponse", + "properties": {}, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Event": { + "description": "A platform sub-account event to record spam signals.", + "id": "Event", + "properties": { + "eventInfo": { + "$ref": "EventInfo", + "description": "Required. Information associated with the event." + }, + "eventTime": { + "description": "Required. Event timestamp.", + "format": "google-datetime", + "type": "string" + }, + "eventType": { + "description": "Required. Event type.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "LOG_IN_VIA_PLATFORM", + "SIGN_UP_VIA_PLATFORM" + ], + "enumDescriptions": [ + "Do not use. You must set an event type explicitly.", + "Log in via platform.", + "Sign up via platform." + ], + "type": "string" + } + }, + "type": "object" + }, + "EventInfo": { + "description": "Private information for partner recorded events (PII).", + "id": "EventInfo", + "properties": { + "billingAddress": { + "$ref": "Address", + "description": "The billing address of the publisher associated with this event, if available." + }, + "email": { + "description": "Required. The email address that is associated with the publisher when performing the event.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountsResponse": { + "description": "Response definition for the list accounts rpc.", + "id": "ListAccountsResponse", + "properties": { + "accounts": { + "description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response definition for the site list rpc.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + }, + "sites": { + "description": "The sites returned in this list response.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "LookupAccountResponse": { + "description": "Response definition for the lookup account rpc.", + "id": "LookupAccountResponse", + "properties": { + "name": { + "description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", + "type": "string" + } + }, + "type": "object" + }, + "RequestSiteReviewResponse": { + "description": "Response definition for the site request review rpc.", + "id": "RequestSiteReviewResponse", + "properties": {}, + "type": "object" + }, + "Site": { + "description": "Representation of a Site.", + "id": "Site", + "properties": { + "domain": { + "description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of a site.", + "enum": [ + "STATE_UNSPECIFIED", + "REQUIRES_REVIEW", + "GETTING_READY", + "READY", + "NEEDS_ATTENTION" + ], + "enumDescriptions": [ + "State unspecified.", + "Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", + "Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", + "The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", + "Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "AdSense Platform API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/adsenseplatform-v1alpha.json b/discovery/adsenseplatform-v1alpha.json new file mode 100644 index 0000000000..e3a4b08718 --- /dev/null +++ b/discovery/adsenseplatform-v1alpha.json @@ -0,0 +1,721 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/adsense": { + "description": "View and manage your AdSense data" + }, + "https://www.googleapis.com/auth/adsense.readonly": { + "description": "View your AdSense data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://adsenseplatform.googleapis.com/", + "batchPath": "batch", + "canonicalName": "AdSense Platform", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/adsense/platforms/", + "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": "adsenseplatform:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", + "name": "adsenseplatform", + "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": { + "platforms": { + "resources": { + "accounts": { + "methods": { + "close": { + "description": "Closes a sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}:close", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.close", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:close", + "request": { + "$ref": "CloseAccountRequest" + }, + "response": { + "$ref": "CloseAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "create": { + "description": "Creates a sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Platform to create an account for. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/accounts", + "request": { + "$ref": "Account" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "get": { + "description": "Gets information about the selected sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists a partial view of sub-accounts for a specific parent account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Platform who parents the accounts. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/accounts", + "response": { + "$ref": "ListAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "lookup": { + "description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts:lookup", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.lookup", + "parameterOrder": [ + "parent" + ], + "parameters": { + "creationRequestId": { + "description": "Optional. The creation_request_id provided when calling createAccount.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Platform who parents the account. Format: platforms/{platform}", + "location": "path", + "pattern": "^platforms/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/accounts:lookup", + "response": { + "$ref": "LookupAccountResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + } + }, + "resources": { + "events": { + "methods": { + "create": { + "description": "Creates an account event.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/events", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.events.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/events", + "request": { + "$ref": "Event" + }, + "response": { + "$ref": "Event" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + } + } + }, + "sites": { + "methods": { + "create": { + "description": "Creates a site for a specified account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.sites.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sites", + "request": { + "$ref": "Site" + }, + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "delete": { + "description": "Deletes a site from a specified account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "DELETE", + "id": "adsenseplatform.platforms.accounts.sites.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + }, + "get": { + "description": "Gets a site from a specified sub-account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.sites.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Site" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "list": { + "description": "Lists sites for a specific account.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", + "httpMethod": "GET", + "id": "adsenseplatform.platforms.accounts.sites.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sites", + "response": { + "$ref": "ListSitesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense", + "https://www.googleapis.com/auth/adsense.readonly" + ] + }, + "requestReview": { + "description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", + "flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", + "httpMethod": "POST", + "id": "adsenseplatform.platforms.accounts.sites.requestReview", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "location": "path", + "pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:requestReview", + "response": { + "$ref": "RequestSiteReviewResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adsense" + ] + } + } + } + } + } + } + } + }, + "revision": "20240710", + "rootUrl": "https://adsenseplatform.googleapis.com/", + "schemas": { + "Account": { + "description": "Representation of an Account.", + "id": "Account", + "properties": { + "createTime": { + "description": "Output only. Creation time of the account.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creationRequestId": { + "description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", + "type": "string" + }, + "displayName": { + "description": "Display name of this account.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", + "readOnly": true, + "type": "string" + }, + "regionCode": { + "description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", + "type": "string" + }, + "state": { + "description": "Output only. Approval state of the account.", + "enum": [ + "STATE_UNSPECIFIED", + "UNCHECKED", + "APPROVED", + "DISAPPROVED" + ], + "enumDescriptions": [ + "Unspecified.", + "Unchecked.", + "The account is ready to serve ads.", + "The account has been blocked from serving ads." + ], + "readOnly": true, + "type": "string" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." + } + }, + "type": "object" + }, + "Address": { + "description": "Address data.", + "id": "Address", + "properties": { + "address1": { + "description": "First line of address. Max length 64 bytes or 30 characters.", + "type": "string" + }, + "address2": { + "description": "Second line of address. Max length 64 bytes or 30 characters.", + "type": "string" + }, + "city": { + "description": "City. Max length 60 bytes or 30 characters.", + "type": "string" + }, + "company": { + "description": "Name of the company. Max length 255 bytes or 34 characters.", + "type": "string" + }, + "contact": { + "description": "Contact name of the company. Max length 128 bytes or 34 characters.", + "type": "string" + }, + "fax": { + "description": "Fax number with international code (i.e. +441234567890).", + "type": "string" + }, + "phone": { + "description": "Phone number with international code (i.e. +441234567890).", + "type": "string" + }, + "regionCode": { + "description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", + "type": "string" + }, + "state": { + "description": "State. Max length 60 bytes or 30 characters.", + "type": "string" + }, + "zip": { + "description": "Zip/post code. Max length 10 bytes or 10 characters.", + "type": "string" + } + }, + "type": "object" + }, + "CloseAccountRequest": { + "description": "Request definition for the account close rpc.", + "id": "CloseAccountRequest", + "properties": {}, + "type": "object" + }, + "CloseAccountResponse": { + "description": "Response definition for the account close rpc.", + "id": "CloseAccountResponse", + "properties": {}, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Event": { + "description": "A platform sub-account event to record spam signals.", + "id": "Event", + "properties": { + "eventInfo": { + "$ref": "EventInfo", + "description": "Required. Information associated with the event." + }, + "eventTime": { + "description": "Required. Event timestamp.", + "format": "google-datetime", + "type": "string" + }, + "eventType": { + "description": "Required. Event type.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "LOG_IN_VIA_PLATFORM", + "SIGN_UP_VIA_PLATFORM" + ], + "enumDescriptions": [ + "Do not use. You must set an event type explicitly.", + "Log in via platform.", + "Sign up via platform." + ], + "type": "string" + } + }, + "type": "object" + }, + "EventInfo": { + "description": "Private information for partner recorded events (PII).", + "id": "EventInfo", + "properties": { + "billingAddress": { + "$ref": "Address", + "description": "The billing address of the publisher associated with this event, if available." + }, + "email": { + "description": "Required. The email address that is associated with the publisher when performing the event.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountsResponse": { + "description": "Response definition for the list accounts rpc.", + "id": "ListAccountsResponse", + "properties": { + "accounts": { + "description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response definition for the site list rpc.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", + "type": "string" + }, + "sites": { + "description": "The sites returned in this list response.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "LookupAccountResponse": { + "description": "Response definition for the lookup account rpc.", + "id": "LookupAccountResponse", + "properties": { + "name": { + "description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", + "type": "string" + } + }, + "type": "object" + }, + "RequestSiteReviewResponse": { + "description": "Response definition for the site request review rpc.", + "id": "RequestSiteReviewResponse", + "properties": {}, + "type": "object" + }, + "Site": { + "description": "Representation of a Site.", + "id": "Site", + "properties": { + "domain": { + "description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", + "type": "string" + }, + "name": { + "description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of a site.", + "enum": [ + "STATE_UNSPECIFIED", + "REQUIRES_REVIEW", + "GETTING_READY", + "READY", + "NEEDS_ATTENTION" + ], + "enumDescriptions": [ + "State unspecified.", + "Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", + "Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", + "The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", + "Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "AdSense Platform API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 9af8ff67b9..eb39f7551b 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,74 +20,74 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "location": "africa-south1", + "description": "Locational Endpoint", "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "africa-south1" }, { - "location": "asia-east1", + "description": "Locational Endpoint", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "asia-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "location": "asia-east2" }, { - "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", "location": "asia-northeast1" }, { - "location": "asia-northeast2", + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "asia-northeast2" }, { - "location": "asia-northeast3", "description": "Locational Endpoint", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", + "location": "asia-northeast3" }, { "description": "Locational Endpoint", - "location": "asia-south1", - "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", + "location": "asia-south1" }, { "description": "Locational Endpoint", - "location": "asia-southeast1", - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", + "location": "asia-southeast1" }, { - "location": "asia-southeast2", "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", + "location": "asia-southeast2" }, { - "location": "australia-southeast1", "description": "Locational Endpoint", - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", + "location": "australia-southeast1" }, { "description": "Locational Endpoint", - "location": "australia-southeast2", - "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "location": "australia-southeast2" }, { - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", "location": "europe-central2" }, { - "location": "europe-north1", + "description": "Locational Endpoint", "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-north1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "location": "europe-southwest1", - "description": "Locational Endpoint" + "location": "europe-southwest1" }, { "description": "Locational Endpoint", @@ -100,9 +100,9 @@ "location": "europe-west2" }, { - "location": "europe-west3", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west3" }, { "description": "Locational Endpoint", @@ -111,58 +111,58 @@ }, { "description": "Locational Endpoint", - "location": "europe-west6", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", + "location": "europe-west6" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "location": "europe-west8" }, { - "location": "europe-west9", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west9" }, { - "location": "europe-west12", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west12" }, { - "location": "me-central1", + "description": "Locational Endpoint", "endpointUrl": "https://me-central1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "me-central1" }, { - "location": "me-central2", + "description": "Locational Endpoint", "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "me-central2" }, { - "location": "me-west1", + "description": "Locational Endpoint", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "me-west1" }, { - "location": "northamerica-northeast1", "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", + "location": "northamerica-northeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Locational Endpoint" + "location": "northamerica-northeast2" }, { - "location": "southamerica-east1", + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "southamerica-east1" }, { - "location": "southamerica-west1", "description": "Locational Endpoint", - "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", + "location": "southamerica-west1" }, { "description": "Locational Endpoint", @@ -170,49 +170,49 @@ "location": "us-central1" }, { - "location": "us-central2", + "description": "Locational Endpoint", "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-central2" }, { - "location": "us-east1", + "description": "Locational Endpoint", "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-east1" }, { - "location": "us-east4", + "description": "Locational Endpoint", "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-east4" }, { - "location": "us-south1", + "description": "Locational Endpoint", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-south1" }, { "description": "Locational Endpoint", - "location": "us-west1", - "endpointUrl": "https://us-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", + "location": "us-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "location": "us-west2", - "description": "Locational Endpoint" + "location": "us-west2" }, { - "location": "us-west3", + "description": "Locational Endpoint", "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-west3" }, { "description": "Locational Endpoint", - "location": "us-west4", - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4" }, { - "location": "us-east5", "description": "Locational Endpoint", - "endpointUrl": "https://us-east5-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", + "location": "us-east5" } ], "fullyEncodeReservedExpansion": true, @@ -1391,7 +1391,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the Dataset.", + "description": "Output only. Identifier. The resource name of the Dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -2268,7 +2268,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the DatasetVersion.", + "description": "Output only. Identifier. The resource name of the DatasetVersion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, @@ -2822,6 +2822,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1DeploymentResourcePool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "queryDeployedModels": { "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", @@ -3893,7 +3927,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4072,7 +4106,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4500,7 +4534,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4700,7 +4734,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6067,7 +6101,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -11145,6 +11179,167 @@ } }, "notebookExecutionJobs": { + "methods": { + "create": { + "description": "Creates a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.notebookExecutionJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "notebookExecutionJobId": { + "description": "Optional. User specified ID for the NotebookExecutionJob.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notebookExecutionJobs", + "request": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.notebookExecutionJobs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookExecutionJob resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a NotebookExecutionJob.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the NotebookExecutionJob resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "enum": [ + "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", + "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", + "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "When unspecified, the API defaults to the BASIC view.", + "Includes all fields except for direct notebook inputs.", + "Includes all fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists NotebookExecutionJobs in a Location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.notebookExecutionJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", + "enum": [ + "NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", + "NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", + "NOTEBOOK_EXECUTION_JOB_VIEW_FULL" + ], + "enumDescriptions": [ + "When unspecified, the API defaults to the BASIC view.", + "Includes all fields except for direct notebook inputs.", + "Includes all fields." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/notebookExecutionJobs", + "response": { + "$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -16733,8 +16928,18 @@ "name" ], "parameters": { + "huggingFaceToken": { + "description": "Optional. Token used to access Hugging Face gated models.", + "location": "query", + "type": "string" + }, + "isHuggingFaceModel": { + "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query", "type": "string" }, @@ -16776,7 +16981,7 @@ } } }, - "revision": "20240617", + "revision": "20240809", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -16801,10 +17006,6 @@ "type": "string" }, "type": "array" - }, - "reportingMetrics": { - "$ref": "IntelligenceCloudAutomlXpsReportingMetrics", - "description": "Billable prediction metrics." } }, "type": "object" @@ -16817,6 +17018,11 @@ "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", "type": "string" }, + "generationSeed": { + "description": "Generation seed for the sampled image. This parameter is exposed to the user only if one of the following is true: 1. The user specified per-example seeds in the request. 2. The user doesn't specify the generation seed in the request.", + "format": "int32", + "type": "integer" + }, "image": { "description": "Raw bytes.", "format": "byte", @@ -17913,6 +18119,16 @@ "description": "Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.", "readOnly": true }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "serviceAccount": { "description": "The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -18246,7 +18462,12 @@ "GoogleCloudAiplatformV1BleuSpec": { "description": "Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.", "id": "GoogleCloudAiplatformV1BleuSpec", - "properties": {}, + "properties": { + "useEffectiveOrder": { + "description": "Optional. Whether to use_effective_order to compute bleu score.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1Blob": { @@ -18343,6 +18564,12 @@ "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1Candidate", "properties": { + "avgLogprobs": { + "description": "Output only. Average log probability score of the candidate.", + "format": "double", + "readOnly": true, + "type": "number" + }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1CitationMetadata", "description": "Output only. Source attribution of the generated content.", @@ -18374,14 +18601,14 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Natural stop point of the model or provided stop sequence.", - "The maximum number of tokens as specified in the request was reached.", - "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", - "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation", - "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", - "The token generation was stopped as the response was flagged for the prohibited contents.", - "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", + "Token generation reached a natural stopping point or a configured stop sequence.", + "Token generation reached the configured maximum output tokens.", + "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, Candidate.content is empty if content filters blocks the output.", + "Token generation stopped because the content potentially contains copyright violations.", + "All other reasons that stopped the token generation.", + "Token generation stopped because the content contains forbidden terms.", + "Token generation stopped for potentially containing prohibited content.", + "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid." ], "readOnly": true, @@ -18615,12 +18842,23 @@ "description": "Request message for ComputeTokens RPC call.", "id": "GoogleCloudAiplatformV1ComputeTokensRequest", "properties": { + "contents": { + "description": "Optional. Input content.", + "items": { + "$ref": "GoogleCloudAiplatformV1Content" + }, + "type": "array" + }, "instances": { - "description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", + "description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" + }, + "model": { + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", + "type": "string" } }, "type": "object" @@ -18821,22 +19059,33 @@ "id": "GoogleCloudAiplatformV1CountTokensRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { - "description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", + "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1Content", + "description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." + }, + "tools": { + "description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", + "items": { + "$ref": "GoogleCloudAiplatformV1Tool" + }, + "type": "array" } }, "type": "object" @@ -19039,6 +19288,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { + "description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", + "id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", + "description": "The operation generic information." + }, + "progressMessage": { + "description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", @@ -19222,6 +19486,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "startTime": { "description": "Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -19380,6 +19654,16 @@ "description": "Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field.", "type": "any" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this DataItem was last updated.", "format": "google-datetime", @@ -19598,10 +19882,20 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the Dataset.", + "description": "Output only. Identifier. The resource name of the Dataset.", "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "savedQueries": { "description": "All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.", "items": { @@ -19652,10 +19946,20 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the DatasetVersion.", + "description": "Output only. Identifier. The resource name of the DatasetVersion.", "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this DatasetVersion was last updated.", "format": "google-datetime", @@ -19689,6 +19993,10 @@ "description": "Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.", "format": "int32", "type": "integer" + }, + "spot": { + "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).", + "type": "boolean" } }, "type": "object" @@ -20126,6 +20434,16 @@ "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "serviceAccount": { "description": "The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -20263,6 +20581,15 @@ "readOnly": true, "type": "string" }, + "dedicatedEndpointDns": { + "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", + "readOnly": true, + "type": "string" + }, + "dedicatedEndpointEnabled": { + "description": "If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.", + "type": "boolean" + }, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "items": { @@ -20321,6 +20648,16 @@ "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "trafficSplit": { "additionalProperties": { "format": "int32", @@ -20391,6 +20728,16 @@ "format": "int32", "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this EntityType was most recently updated.", "format": "google-datetime", @@ -20499,6 +20846,10 @@ "$ref": "GoogleCloudAiplatformV1GroundednessInput", "description": "Input for groundedness metric." }, + "pairwiseMetricInput": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricInput", + "description": "Input for pairwise metric." + }, "pairwiseQuestionAnsweringQualityInput": { "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", "description": "Input for pairwise question answering quality metric." @@ -20507,6 +20858,10 @@ "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityInput", "description": "Input for pairwise summarization quality metric." }, + "pointwiseMetricInput": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricInput", + "description": "Input for pointwise metric." + }, "questionAnsweringCorrectnessInput": { "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessInput", "description": "Input for question answering correctness metric." @@ -20590,6 +20945,10 @@ "$ref": "GoogleCloudAiplatformV1GroundednessResult", "description": "Result for groundedness metric." }, + "pairwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricResult", + "description": "Result for pairwise metric." + }, "pairwiseQuestionAnsweringQualityResult": { "$ref": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityResult", "description": "Result for pairwise question answering quality metric." @@ -20598,6 +20957,10 @@ "$ref": "GoogleCloudAiplatformV1PairwiseSummarizationQualityResult", "description": "Result for pairwise summarization quality metric." }, + "pointwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricResult", + "description": "Generic metrics. Result for pointwise metric." + }, "questionAnsweringCorrectnessResult": { "$ref": "GoogleCloudAiplatformV1QuestionAnsweringCorrectnessResult", "description": "Result for question answering correctness metric." @@ -21916,6 +22279,20 @@ "type": "string" }, "type": "array" + }, + "timeSeries": { + "$ref": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", + "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries": { + "id": "GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries", + "properties": { + "timestampColumn": { + "description": "Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used.", + "type": "string" } }, "type": "object" @@ -22018,6 +22395,16 @@ "$ref": "GoogleCloudAiplatformV1FeatureOnlineStoreOptimized", "description": "Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. State of the featureOnlineStore.", "enum": [ @@ -22077,10 +22464,19 @@ "description": "The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default.", "id": "GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint", "properties": { + "privateServiceConnectConfig": { + "$ref": "GoogleCloudAiplatformV1PrivateServiceConnectConfig", + "description": "Optional. Private service connect config. The private service connection is available only for Optimized storage type, not for embedding management now. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request. Otherwise, the connection will set to public endpoint." + }, "publicEndpointDomainName": { "description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore", "readOnly": true, "type": "string" + }, + "serviceAttachment": { + "description": "Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -22278,6 +22674,16 @@ "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "syncConfig": { "$ref": "GoogleCloudAiplatformV1FeatureViewSyncConfig", "description": "Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving." @@ -22467,6 +22873,16 @@ "description": "Output only. Time when this FeatureViewSync is finished.", "readOnly": true }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "syncSummary": { "$ref": "GoogleCloudAiplatformV1FeatureViewSyncSyncSummary", "description": "Output only. Summary of the sync job.", @@ -22544,6 +22960,16 @@ "format": "int32", "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. State of the featurestore.", "enum": [ @@ -23124,7 +23550,7 @@ ], "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", - "Default model behavior, model decides to predict either a function call or a natural language repspose.", + "Default model behavior, model decides to predict either a function call or a natural language response.", "Model is constrained to always predicting a function call only. If \"allowed_function_names\" are set, the predicted function call will be limited to any one of \"allowed_function_names\", else the predicted function call will be any one of the provided \"function_declarations\".", "Model will not predict any function call. Model behavior is same as when not passing any function declarations." ], @@ -23309,7 +23735,7 @@ "type": "integer" }, "promptTokenCount": { - "description": "Number of tokens in the request.", + "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, @@ -23352,6 +23778,15 @@ "$ref": "GoogleCloudAiplatformV1Schema", "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." }, + "routingConfig": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", + "description": "Optional. Routing configuration." + }, + "seed": { + "description": "Optional. Seed.", + "format": "int32", + "type": "integer" + }, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -23377,6 +23812,55 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GenerationConfigRoutingConfig": { + "description": "Routing config.", + "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfig", + "properties": { + "autoMode": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", + "description": "Automated routing." + }, + "manualMode": { + "$ref": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", + "description": "Manual routing." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode": { + "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode", + "properties": { + "modelRoutingPreference": { + "description": "The model routing preference.", + "enum": [ + "UNKNOWN", + "PRIORITIZE_QUALITY", + "BALANCED", + "PRIORITIZE_COST" + ], + "enumDescriptions": [ + "Unspecified model routing preference.", + "Prefer higher quality over low cost.", + "Balanced model routing preference.", + "Prefer lower cost over higher quality." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode": { + "description": "When manual routing is set, the specified model will be used directly.", + "id": "GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode", + "properties": { + "modelName": { + "description": "The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GenericOperationMetadata": { "description": "Generic Metadata shared by all operations.", "id": "GoogleCloudAiplatformV1GenericOperationMetadata", @@ -23487,10 +23971,69 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GroundingChunk": { + "description": "Grounding chunk.", + "id": "GoogleCloudAiplatformV1GroundingChunk", + "properties": { + "retrievedContext": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", + "description": "Grounding chunk from context retrieved by the retrieval tools." + }, + "web": { + "$ref": "GoogleCloudAiplatformV1GroundingChunkWeb", + "description": "Grounding chunk from the web." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GroundingChunkRetrievedContext": { + "description": "Chunk from context retrieved by the retrieval tools.", + "id": "GoogleCloudAiplatformV1GroundingChunkRetrievedContext", + "properties": { + "title": { + "description": "Title of the attribution.", + "type": "string" + }, + "uri": { + "description": "URI reference of the attribution.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1GroundingChunkWeb": { + "description": "Chunk from the web.", + "id": "GoogleCloudAiplatformV1GroundingChunkWeb", + "properties": { + "title": { + "description": "Title of the chunk.", + "type": "string" + }, + "uri": { + "description": "URI reference of the chunk.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1GroundingMetadata": { "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { + "groundingChunks": { + "description": "List of supporting references retrieved from specified grounding source.", + "items": { + "$ref": "GoogleCloudAiplatformV1GroundingChunk" + }, + "type": "array" + }, + "groundingSupports": { + "description": "Optional. List of grounding support.", + "items": { + "$ref": "GoogleCloudAiplatformV1GroundingSupport" + }, + "type": "array" + }, "searchEntryPoint": { "$ref": "GoogleCloudAiplatformV1SearchEntryPoint", "description": "Optional. Google search entry for the following-up web searches." @@ -23505,6 +24048,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1GroundingSupport": { + "description": "Grounding support.", + "id": "GoogleCloudAiplatformV1GroundingSupport", + "properties": { + "confidenceScores": { + "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "groundingChunkIndices": { + "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "segment": { + "$ref": "GoogleCloudAiplatformV1Segment", + "description": "Segment of the content this support belongs to." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1HyperparameterTuningJob": { "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", "id": "GoogleCloudAiplatformV1HyperparameterTuningJob", @@ -23561,6 +24131,16 @@ "format": "int32", "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "startTime": { "description": "Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -23920,6 +24500,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.", "format": "google-datetime", @@ -24145,6 +24735,16 @@ "description": "Optional. If true, the deployed index will be accessible through public endpoint.", "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.", "format": "google-datetime", @@ -24891,6 +25491,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { + "description": "Response message for [NotebookService.CreateNotebookExecutionJob]", + "id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.", + "type": "string" + }, + "notebookExecutionJobs": { + "description": "List of NotebookExecutionJobs in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", @@ -25218,9 +25836,25 @@ "TPU_V4_POD", "TPU_V5_LITEPOD" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified accelerator type, which means no accelerator.", - "Nvidia Tesla K80 GPU.", + "Deprecated: Nvidia Tesla K80 GPU has reached end of support, see https://cloud.google.com/compute/docs/eol/k80-eol.", "Nvidia Tesla P100 GPU.", "Nvidia Tesla V100 GPU.", "Nvidia Tesla P4 GPU.", @@ -25240,6 +25874,10 @@ "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1ReservationAffinity", + "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation." + }, "tpuTopology": { "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", "type": "string" @@ -25769,6 +26407,16 @@ "$ref": "GoogleCloudAiplatformV1PredictSchemata", "description": "The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "supportedDeploymentResourcesTypes": { "description": "Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.", "items": { @@ -26121,6 +26769,16 @@ "description": "Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.", "type": "any" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "scheduleState": { "description": "Output only. Schedule state when the monitoring job is in Running state.", "enum": [ @@ -26905,6 +27563,16 @@ "$ref": "GoogleCloudAiplatformV1NasJobSpec", "description": "Required. The specification of a NasJob." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "startTime": { "description": "Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -27203,6 +27871,13 @@ "format": "int32", "type": "integer" }, + "numericFilters": { + "description": "Optional. The list of numeric filters.", + "items": { + "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter" + }, + "type": "array" + }, "parameters": { "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", "description": "Optional. Parameters that can be set to tune query on the fly." @@ -27237,6 +27912,54 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter": { + "description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1", + "id": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter", + "properties": { + "name": { + "description": "Required. Column name in BigQuery that used as filters.", + "type": "string" + }, + "op": { + "description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "LESS", + "LESS_EQUAL", + "EQUAL", + "GREATER_EQUAL", + "GREATER", + "NOT_EQUAL" + ], + "enumDescriptions": [ + "Unspecified operator.", + "Entities are eligible if their value is < the query's.", + "Entities are eligible if their value is <= the query's.", + "Entities are eligible if their value is == the query's.", + "Entities are eligible if their value is >= the query's.", + "Entities are eligible if their value is > the query's.", + "Entities are eligible if their value is != the query's." + ], + "type": "string" + }, + "valueDouble": { + "description": "double value type.", + "format": "double", + "type": "number" + }, + "valueFloat": { + "description": "float value type.", + "format": "float", + "type": "number" + }, + "valueInt": { + "description": "int value type.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1NearestNeighborQueryParameters": { "description": "Parameters that can be overrided in each query to tune query latency and recall.", "id": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", @@ -27507,6 +28230,163 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1NotebookExecutionJob": { + "description": "NotebookExecutionJob represents an instance of a notebook execution.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJob", + "properties": { + "createTime": { + "description": "Output only. Timestamp when this NotebookExecutionJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataformRepositorySource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", + "description": "The Dataform Repository pointing to a single file notebook repository." + }, + "directNotebookSource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", + "description": "The contents of an input notebook file." + }, + "displayName": { + "description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", + "type": "string" + }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1EncryptionSpec", + "description": "Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec." + }, + "executionTimeout": { + "description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", + "format": "google-duration", + "type": "string" + }, + "executionUser": { + "description": "The user email to run the execution as. Only supported by Colab runtimes.", + "type": "string" + }, + "gcsNotebookSource": { + "$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", + "description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`" + }, + "gcsOutputUri": { + "description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", + "type": "string" + }, + "jobState": { + "description": "Output only. The state of the NotebookExecutionJob.", + "enum": [ + "JOB_STATE_UNSPECIFIED", + "JOB_STATE_QUEUED", + "JOB_STATE_PENDING", + "JOB_STATE_RUNNING", + "JOB_STATE_SUCCEEDED", + "JOB_STATE_FAILED", + "JOB_STATE_CANCELLING", + "JOB_STATE_CANCELLED", + "JOB_STATE_PAUSED", + "JOB_STATE_EXPIRED", + "JOB_STATE_UPDATING", + "JOB_STATE_PARTIALLY_SUCCEEDED" + ], + "enumDescriptions": [ + "The job state is unspecified.", + "The job has been just created or resumed and processing has not yet begun.", + "The service is preparing to run the job.", + "The job is in progress.", + "The job completed successfully.", + "The job failed.", + "The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", + "The job has been cancelled.", + "The job has been stopped, and can be resumed.", + "The job has expired.", + "The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", + "The job is partially succeeded, some results may be missing due to errors." + ], + "readOnly": true, + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", + "type": "object" + }, + "name": { + "description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", + "readOnly": true, + "type": "string" + }, + "notebookRuntimeTemplateResourceName": { + "description": "The NotebookRuntimeTemplate to source compute configuration from.", + "type": "string" + }, + "scheduleResourceName": { + "description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", + "readOnly": true, + "type": "string" + }, + "serviceAccount": { + "description": "The service account to run the execution as.", + "type": "string" + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", + "readOnly": true + }, + "updateTime": { + "description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { + "description": "The Dataform Repository containing the input notebook.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", + "properties": { + "commitSha": { + "description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", + "type": "string" + }, + "dataformRepositoryResourceName": { + "description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { + "description": "The content of the input notebook in ipynb format.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", + "properties": { + "content": { + "description": "The base64-encoded contents of the input notebook file.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { + "description": "The Cloud Storage uri for the input notebook.", + "id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", + "properties": { + "generation": { + "description": "The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.", + "type": "string" + }, + "uri": { + "description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", @@ -27790,6 +28670,72 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PairwiseMetricInput": { + "description": "Input for pairwise metric.", + "id": "GoogleCloudAiplatformV1PairwiseMetricInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricInstance", + "description": "Required. Pairwise metric instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1PairwiseMetricSpec", + "description": "Required. Spec for pairwise metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PairwiseMetricInstance": { + "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1PairwiseMetricInstance", + "properties": { + "jsonInstance": { + "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PairwiseMetricResult": { + "description": "Spec for pairwise metric result.", + "id": "GoogleCloudAiplatformV1PairwiseMetricResult", + "properties": { + "explanation": { + "description": "Output only. Explanation for pairwise metric score.", + "readOnly": true, + "type": "string" + }, + "pairwiseChoice": { + "description": "Output only. Pairwise metric choice.", + "enum": [ + "PAIRWISE_CHOICE_UNSPECIFIED", + "BASELINE", + "CANDIDATE", + "TIE" + ], + "enumDescriptions": [ + "Unspecified prediction choice.", + "Baseline prediction wins", + "Candidate prediction wins", + "Winner cannot be determined" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PairwiseMetricSpec": { + "description": "Spec for pairwise metric.", + "id": "GoogleCloudAiplatformV1PairwiseMetricSpec", + "properties": { + "metricPromptTemplate": { + "description": "Required. Metric prompt template for pairwise metric.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput": { "description": "Input for pairwise question answering quality metric.", "id": "GoogleCloudAiplatformV1PairwiseQuestionAnsweringQualityInput", @@ -28603,6 +29549,61 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PointwiseMetricInput": { + "description": "Input for pointwise metric.", + "id": "GoogleCloudAiplatformV1PointwiseMetricInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricInstance", + "description": "Required. Pointwise metric instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1PointwiseMetricSpec", + "description": "Required. Spec for pointwise metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PointwiseMetricInstance": { + "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1PointwiseMetricInstance", + "properties": { + "jsonInstance": { + "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PointwiseMetricResult": { + "description": "Spec for pointwise metric result.", + "id": "GoogleCloudAiplatformV1PointwiseMetricResult", + "properties": { + "explanation": { + "description": "Output only. Explanation for pointwise metric score.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. Pointwise metric score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1PointwiseMetricSpec": { + "description": "Spec for pointwise metric.", + "id": "GoogleCloudAiplatformV1PointwiseMetricSpec", + "properties": { + "metricPromptTemplate": { + "description": "Required. Metric prompt template for pointwise metric.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1Port": { "description": "Represents a network port in a container.", "id": "GoogleCloudAiplatformV1Port", @@ -28797,6 +29798,11 @@ "type": "string" }, "type": "array" + }, + "serviceAttachment": { + "description": "Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -29023,6 +30029,10 @@ "$ref": "GoogleCloudAiplatformV1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, + "deployMetadata": { + "$ref": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", + "description": "Optional. Metadata information about this deployment config." + }, "deployTaskName": { "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", "type": "string" @@ -29050,6 +30060,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata": { + "description": "Metadata information about the deployment for managing deployment config.", + "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc.", + "type": "object" + }, + "sampleRequest": { + "description": "Optional. Sample request for deployed endpoint.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke": { "description": "Configurations for PublisherModel GKE deployment", "id": "GoogleCloudAiplatformV1PublisherModelCallToActionDeployGke", @@ -29710,6 +30738,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1RayLogsSpec": { + "description": "Configuration for the Ray OSS Logs.", + "id": "GoogleCloudAiplatformV1RayLogsSpec", + "properties": { + "disabled": { + "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1RayMetricSpec", @@ -29733,6 +30772,10 @@ "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, + "rayLogsSpec": { + "$ref": "GoogleCloudAiplatformV1RayLogsSpec", + "description": "Optional. OSS Ray logging configurations." + }, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -30013,13 +31056,47 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1ReservationAffinity": { + "description": "A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity.", + "id": "GoogleCloudAiplatformV1ReservationAffinity", + "properties": { + "key": { + "description": "Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "reservationAffinityType": { + "description": "Required. Specifies the reservation affinity type.", + "enum": [ + "TYPE_UNSPECIFIED", + "NO_RESERVATION", + "ANY_RESERVATION", + "SPECIFIC_RESERVATION" + ], + "enumDescriptions": [ + "Default value. This should not be used.", + "Do not consume from any reserved capacity, only use on-demand.", + "Consume any reservation available, falling back to on-demand.", + "Consume from a specific reservation. When chosen, the reservation must be identified via the `key` and `values` fields." + ], + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ResourcePool": { "description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", "id": "GoogleCloudAiplatformV1ResourcePool", "properties": { "autoscalingSpec": { "$ref": "GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec", - "description": "Optional. Optional spec to configure GKE autoscaling" + "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling" }, "diskSpec": { "$ref": "GoogleCloudAiplatformV1DiskSpec", @@ -30057,7 +31134,7 @@ "type": "string" }, "minReplicaCount": { - "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error", + "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be > 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java.", "format": "int64", "type": "string" } @@ -30140,7 +31217,8 @@ "id": "GoogleCloudAiplatformV1Retrieval", "properties": { "disableAttribution": { - "description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", + "deprecated": true, + "description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -30700,6 +31778,31 @@ "description": "Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, + "strategy": { + "description": "Optional. This determines which type of scheduling strategy to use.", + "enum": [ + "STRATEGY_UNSPECIFIED", + "ON_DEMAND", + "LOW_COST", + "STANDARD", + "SPOT" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false + ], + "enumDescriptions": [ + "Strategy will default to STANDARD.", + "Regular on-demand provisioning strategy.", + "Low cost by making potential use of spot resources.", + "Standard provisioning strategy uses regular on-demand resources.", + "Spot provisioning strategy uses spot resources." + ], + "type": "string" + }, "timeout": { "description": "The maximum job running time. The default is 7 days.", "format": "google-duration", @@ -31958,6 +33061,7 @@ "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", "properties": { "disableAttribution": { + "deprecated": true, "description": "If set, skip finding claim attributions (i.e not generate grounding citation).", "type": "boolean" }, @@ -34809,6 +35913,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1Segment": { + "description": "Segment of the content.", + "id": "GoogleCloudAiplatformV1Segment", + "properties": { + "endIndex": { + "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "partIndex": { + "description": "Output only. The index of a Part object within its parent Content object.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "startIndex": { + "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "text": { + "description": "Output only. The text corresponding to the segment from the response.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1ServiceAccountSpec", @@ -35867,14 +37001,16 @@ "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", - "ADAPTER_SIZE_SIXTEEN" + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" ], "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 4.", "Adapter size 8.", - "Adapter size 16." + "Adapter size 16.", + "Adapter size 32." ], "type": "string" }, @@ -35896,11 +37032,18 @@ "id": "GoogleCloudAiplatformV1SupervisedTuningDataStats", "properties": { "totalBillableCharacterCount": { + "deprecated": true, "description": "Output only. Number of billable characters in the tuning dataset.", "format": "int64", "readOnly": true, "type": "string" }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "totalTuningCharacterCount": { "description": "Output only. Number of tuning characters in the tuning dataset.", "format": "int64", @@ -35949,6 +37092,12 @@ "description": "Dataset distribution for Supervised Tuning.", "id": "GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution", "properties": { + "billableSum": { + "description": "Output only. Sum of a given population of values that are billable.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "buckets": { "description": "Output only. Defines the histogram bucket.", "items": { @@ -36265,6 +37414,16 @@ "readOnly": true, "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this Tensorboard was last updated.", "format": "google-datetime", @@ -36608,6 +37767,10 @@ "description": "Tokens info with a list of tokens and the corresponding list of token ids.", "id": "GoogleCloudAiplatformV1TokensInfo", "properties": { + "role": { + "description": "Optional. Optional fields for the role from the corresponding Content.", + "type": "string" + }, "tokenIds": { "description": "A list of token ids from the input.", "items": { @@ -37152,7 +38315,6 @@ "type": "object" }, "GoogleCloudAiplatformV1TrialContext": { - "description": "Next ID: 3", "id": "GoogleCloudAiplatformV1TrialContext", "properties": { "description": { @@ -38194,70 +39356,6 @@ } }, "type": "object" - }, - "IntelligenceCloudAutomlXpsMetricEntry": { - "id": "IntelligenceCloudAutomlXpsMetricEntry", - "properties": { - "argentumMetricId": { - "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", - "type": "string" - }, - "doubleValue": { - "description": "A double value.", - "format": "double", - "type": "number" - }, - "int64Value": { - "description": "A signed 64-bit integer value.", - "format": "int64", - "type": "string" - }, - "metricName": { - "description": "The metric name defined in the service configuration.", - "type": "string" - }, - "systemLabels": { - "description": "Billing system labels for this (metric, value) pair.", - "items": { - "$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" - }, - "type": "array" - } - }, - "type": "object" - }, - "IntelligenceCloudAutomlXpsMetricEntryLabel": { - "id": "IntelligenceCloudAutomlXpsMetricEntryLabel", - "properties": { - "labelName": { - "description": "The name of the label.", - "type": "string" - }, - "labelValue": { - "description": "The value of the label.", - "type": "string" - } - }, - "type": "object" - }, - "IntelligenceCloudAutomlXpsReportingMetrics": { - "id": "IntelligenceCloudAutomlXpsReportingMetrics", - "properties": { - "effectiveTrainingDuration": { - "deprecated": true, - "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", - "format": "google-duration", - "type": "string" - }, - "metricEntries": { - "description": "One entry per metric name. The values must be aggregated per metric name.", - "items": { - "$ref": "IntelligenceCloudAutomlXpsMetricEntry" - }, - "type": "array" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index e89cb69035..6efad981fe 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -20,24 +20,24 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://africa-south1-aiplatform.googleapis.com/", "location": "africa-south1" }, { - "location": "asia-east1", + "description": "Locational Endpoint", "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "asia-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "location": "asia-east2" }, { - "location": "asia-northeast1", + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "asia-northeast1" }, { "description": "Locational Endpoint", @@ -45,9 +45,9 @@ "location": "asia-northeast2" }, { - "location": "asia-northeast3", "description": "Locational Endpoint", - "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/", + "location": "asia-northeast3" }, { "description": "Locational Endpoint", @@ -55,44 +55,44 @@ "location": "asia-south1" }, { - "location": "asia-southeast1", + "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "asia-southeast1" }, { - "location": "asia-southeast2", "description": "Locational Endpoint", - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", + "location": "asia-southeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", - "location": "australia-southeast1", - "description": "Locational Endpoint" + "location": "australia-southeast1" }, { "description": "Locational Endpoint", - "location": "australia-southeast2", - "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "location": "australia-southeast2" }, { "description": "Locational Endpoint", - "location": "europe-central2", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", + "location": "europe-central2" }, { "description": "Locational Endpoint", - "location": "europe-north1", - "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", + "location": "europe-north1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "location": "europe-southwest1", - "description": "Locational Endpoint" + "location": "europe-southwest1" }, { "description": "Locational Endpoint", - "location": "europe-west1", - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", + "location": "europe-west1" }, { "description": "Locational Endpoint", @@ -100,34 +100,34 @@ "location": "europe-west2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" + "location": "europe-west3" }, { - "location": "europe-west4", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west4" }, { "description": "Locational Endpoint", - "location": "europe-west6", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", + "location": "europe-west6" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", - "location": "europe-west8", - "description": "Locational Endpoint" + "location": "europe-west8" }, { - "location": "europe-west9", + "description": "Locational Endpoint", "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "europe-west9" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west12-aiplatform.googleapis.com/", - "location": "europe-west12", - "description": "Locational Endpoint" + "location": "europe-west12" }, { "description": "Locational Endpoint", @@ -135,84 +135,84 @@ "location": "me-central1" }, { - "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://me-central2-aiplatform.googleapis.com/", "location": "me-central2" }, { - "location": "me-west1", "description": "Locational Endpoint", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", + "location": "me-west1" }, { - "location": "northamerica-northeast1", "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", + "location": "northamerica-northeast1" }, { - "location": "northamerica-northeast2", + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "northamerica-northeast2" }, { - "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", "location": "southamerica-east1" }, { - "location": "southamerica-west1", + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "southamerica-west1" }, { - "location": "us-central1", + "description": "Locational Endpoint", "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-central1" }, { - "location": "us-central2", "description": "Locational Endpoint", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "location": "us-central2" }, { "description": "Locational Endpoint", - "location": "us-east1", - "endpointUrl": "https://us-east1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", + "location": "us-east1" }, { - "location": "us-east4", "description": "Locational Endpoint", - "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east4-aiplatform.googleapis.com/", + "location": "us-east4" }, { - "location": "us-south1", + "description": "Locational Endpoint", "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", - "location": "us-west1", - "description": "Locational Endpoint" + "location": "us-west1" }, { - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", "location": "us-west2" }, { - "location": "us-west3", + "description": "Locational Endpoint", "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "location": "us-west3" }, { - "location": "us-west4", "description": "Locational Endpoint", - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4" }, { - "location": "us-east5", "description": "Locational Endpoint", - "endpointUrl": "https://us-east5-aiplatform.googleapis.com/" + "endpointUrl": "https://us-east5-aiplatform.googleapis.com/", + "location": "us-east5" } ], "fullyEncodeReservedExpansion": true, @@ -1980,7 +1980,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the Dataset.", + "description": "Output only. Identifier. The resource name of the Dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -2857,7 +2857,7 @@ ], "parameters": { "name": { - "description": "Output only. The resource name of the DatasetVersion.", + "description": "Output only. Identifier. The resource name of the DatasetVersion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, @@ -3411,6 +3411,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "patch": { + "description": "Update a DeploymentResourcePool.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.deploymentResourcePools.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/deploymentResourcePools/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DeploymentResourcePool" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "queryDeployedModels": { "description": "List DeployedModels that have been deployed on this DeploymentResourcePool.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/deploymentResourcePools/{deploymentResourcePoolsId}:queryDeployedModels", @@ -5567,7 +5601,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -5746,7 +5780,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6205,7 +6239,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -6495,7 +6529,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType`", + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -7943,7 +7977,7 @@ "type": "string" }, "updateMask": { - "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature)", + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore)", "format": "google-fieldmask", "location": "query", "type": "string" @@ -20302,8 +20336,18 @@ "name" ], "parameters": { + "huggingFaceToken": { + "description": "Optional. Token used to access Hugging Face gated models.", + "location": "query", + "type": "string" + }, + "isHuggingFaceModel": { + "description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", + "location": "query", + "type": "boolean" + }, "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query", "type": "string" }, @@ -20355,7 +20399,7 @@ "type": "string" }, "languageCode": { - "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).", + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", "location": "query", "type": "string" }, @@ -20413,7 +20457,7 @@ } } }, - "revision": "20240617", + "revision": "20240809", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -20438,10 +20482,6 @@ "type": "string" }, "type": "array" - }, - "reportingMetrics": { - "$ref": "IntelligenceCloudAutomlXpsReportingMetrics", - "description": "Billable prediction metrics." } }, "type": "object" @@ -20454,6 +20494,11 @@ "description": "Image encoding, encoded as \"image/png\" or \"image/jpg\".", "type": "string" }, + "generationSeed": { + "description": "Generation seed for the sampled image. This parameter is exposed to the user only if one of the following is true: 1. The user specified per-example seeds in the request. 2. The user doesn't specify the generation seed in the request.", + "format": "int32", + "type": "integer" + }, "image": { "description": "Raw bytes.", "format": "byte", @@ -20968,6 +21013,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig": { + "description": "The API secret.", + "id": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", + "properties": { + "apiKeySecretVersion": { + "description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Artifact": { "description": "Instance of a general artifact.", "id": "GoogleCloudAiplatformV1beta1Artifact", @@ -21730,6 +21786,16 @@ "description": "Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models.", "readOnly": true }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "serviceAccount": { "description": "The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -22063,7 +22129,12 @@ "GoogleCloudAiplatformV1beta1BleuSpec": { "description": "Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1.", "id": "GoogleCloudAiplatformV1beta1BleuSpec", - "properties": {}, + "properties": { + "useEffectiveOrder": { + "description": "Optional. Whether to use_effective_order to compute bleu score.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudAiplatformV1beta1Blob": { @@ -22238,6 +22309,12 @@ "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { + "avgLogprobs": { + "description": "Output only. Average log probability score of the candidate.", + "format": "double", + "readOnly": true, + "type": "number" + }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", "description": "Output only. Source attribution of the generated content.", @@ -22269,14 +22346,14 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Natural stop point of the model or provided stop sequence.", - "The maximum number of tokens as specified in the request was reached.", - "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", - "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation", - "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", - "The token generation was stopped as the response was flagged for the prohibited contents.", - "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", + "Token generation reached a natural stopping point or a configured stop sequence.", + "Token generation reached the configured maximum output tokens.", + "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, Candidate.content is empty if content filters blocks the output.", + "Token generation stopped because the content potentially contains copyright violations.", + "All other reasons that stopped the token generation.", + "Token generation stopped because the content contains forbidden terms.", + "Token generation stopped for potentially containing prohibited content.", + "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid." ], "readOnly": true, @@ -22510,12 +22587,23 @@ "description": "Request message for ComputeTokens RPC call.", "id": "GoogleCloudAiplatformV1beta1ComputeTokensRequest", "properties": { + "contents": { + "description": "Optional. Input content.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "type": "array" + }, "instances": { - "description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", + "description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" + }, + "model": { + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", + "type": "string" } }, "type": "object" @@ -22716,22 +22804,33 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { - "description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", + "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." + }, + "tools": { + "description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" } }, "type": "object" @@ -23203,6 +23302,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "startTime": { "description": "Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -23361,6 +23470,16 @@ "description": "Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field.", "type": "any" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this DataItem was last updated.", "format": "google-datetime", @@ -23579,10 +23698,20 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the Dataset.", + "description": "Output only. Identifier. The resource name of the Dataset.", "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "savedQueries": { "description": "All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.", "items": { @@ -23599,6 +23728,142 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DatasetDistribution": { + "description": "Distribution computed over a tuning dataset.", + "id": "GoogleCloudAiplatformV1beta1DatasetDistribution", + "properties": { + "buckets": { + "description": "Output only. Defines the histogram bucket.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket" + }, + "readOnly": true, + "type": "array" + }, + "max": { + "description": "Output only. The maximum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "mean": { + "description": "Output only. The arithmetic mean of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "median": { + "description": "Output only. The median of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "min": { + "description": "Output only. The minimum of the population values.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "p5": { + "description": "Output only. The 5th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "p95": { + "description": "Output only. The 95th percentile of the values in the population.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "sum": { + "description": "Output only. Sum of a given population of values.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket": { + "description": "Dataset bucket used to create a histogram for the distribution given a population of values.", + "id": "GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket", + "properties": { + "count": { + "description": "Output only. Number of values in the bucket.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "left": { + "description": "Output only. Left bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "right": { + "description": "Output only. Right bound of the bucket.", + "format": "double", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DatasetStats": { + "description": "Statistics computed over a tuning dataset.", + "id": "GoogleCloudAiplatformV1beta1DatasetStats", + "properties": { + "totalBillableCharacterCount": { + "description": "Output only. Number of billable characters in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "totalTuningCharacterCount": { + "description": "Output only. Number of tuning characters in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tuningDatasetExampleCount": { + "description": "Output only. Number of examples in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "tuningStepCount": { + "description": "Output only. Number of tuning steps for this Tuning Job.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "userDatasetExamples": { + "description": "Output only. Sample user messages in the training dataset uri.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Content" + }, + "readOnly": true, + "type": "array" + }, + "userInputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", + "description": "Output only. Dataset distributions for the user input tokens.", + "readOnly": true + }, + "userMessagePerExampleDistribution": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", + "description": "Output only. Dataset distributions for the messages per example.", + "readOnly": true + }, + "userOutputTokenDistribution": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetDistribution", + "description": "Output only. Dataset distributions for the user output tokens.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DatasetVersion": { "description": "Describes the dataset version.", "id": "GoogleCloudAiplatformV1beta1DatasetVersion", @@ -23633,10 +23898,20 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the DatasetVersion.", + "description": "Output only. Identifier. The resource name of the DatasetVersion.", "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this DatasetVersion was last updated.", "format": "google-datetime", @@ -23670,6 +23945,10 @@ "description": "Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed.", "format": "int32", "type": "integer" + }, + "spot": { + "description": "Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms).", + "type": "boolean" } }, "type": "object" @@ -24118,6 +24397,16 @@ "description": "Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "serviceAccount": { "description": "The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account.", "type": "string" @@ -24225,6 +24514,90 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DistillationDataStats": { + "description": "Statistics computed for datasets used for distillation.", + "id": "GoogleCloudAiplatformV1beta1DistillationDataStats", + "properties": { + "trainingDatasetStats": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetStats", + "description": "Output only. Statistics computed for the training dataset.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DistillationHyperParameters": { + "description": "Hyperparameters for Distillation.", + "id": "GoogleCloudAiplatformV1beta1DistillationHyperParameters", + "properties": { + "adapterSize": { + "description": "Optional. Adapter size for distillation.", + "enum": [ + "ADAPTER_SIZE_UNSPECIFIED", + "ADAPTER_SIZE_ONE", + "ADAPTER_SIZE_FOUR", + "ADAPTER_SIZE_EIGHT", + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" + ], + "enumDescriptions": [ + "Adapter size is unspecified.", + "Adapter size 1.", + "Adapter size 4.", + "Adapter size 8.", + "Adapter size 16.", + "Adapter size 32." + ], + "type": "string" + }, + "epochCount": { + "description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", + "format": "int64", + "type": "string" + }, + "learningRateMultiplier": { + "description": "Optional. Multiplier for adjusting the default learning rate.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1DistillationSpec": { + "description": "Tuning Spec for Distillation.", + "id": "GoogleCloudAiplatformV1beta1DistillationSpec", + "properties": { + "baseTeacherModel": { + "description": "The base teacher model that is being distilled, e.g., \"gemini-1.0-pro-002\".", + "type": "string" + }, + "hyperParameters": { + "$ref": "GoogleCloudAiplatformV1beta1DistillationHyperParameters", + "description": "Optional. Hyperparameters for Distillation." + }, + "pipelineRootDirectory": { + "description": "Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts.", + "type": "string" + }, + "studentModel": { + "description": "The student model that is being tuned, e.g., \"google/gemma-2b-1.1-it\".", + "type": "string" + }, + "trainingDatasetUri": { + "description": "Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + }, + "tunedTeacherModelSource": { + "description": "The resource name of the Tuned teacher model. Format: `projects/{project}/locations/{location}/models/{model}`.", + "type": "string" + }, + "validationDatasetUri": { + "description": "Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DoubleArray": { "description": "A list of double values.", "id": "GoogleCloudAiplatformV1beta1DoubleArray", @@ -24261,6 +24634,15 @@ "readOnly": true, "type": "string" }, + "dedicatedEndpointDns": { + "description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", + "readOnly": true, + "type": "string" + }, + "dedicatedEndpointEnabled": { + "description": "If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.", + "type": "boolean" + }, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "items": { @@ -24319,6 +24701,16 @@ "$ref": "GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig", "description": "Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "trafficSplit": { "additionalProperties": { "format": "int32", @@ -24389,6 +24781,16 @@ "format": "int32", "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this EntityType was most recently updated.", "format": "google-datetime", @@ -24497,6 +24899,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundednessInput", "description": "Input for groundedness metric." }, + "pairwiseMetricInput": { + "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricInput", + "description": "Input for pairwise metric." + }, "pairwiseQuestionAnsweringQualityInput": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput", "description": "Input for pairwise question answering quality metric." @@ -24505,6 +24911,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput", "description": "Input for pairwise summarization quality metric." }, + "pointwiseMetricInput": { + "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricInput", + "description": "Input for pointwise metric." + }, "questionAnsweringCorrectnessInput": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessInput", "description": "Input for question answering correctness metric." @@ -24588,6 +24998,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GroundednessResult", "description": "Result for groundedness metric." }, + "pairwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", + "description": "Result for pairwise metric." + }, "pairwiseQuestionAnsweringQualityResult": { "$ref": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityResult", "description": "Result for pairwise question answering quality metric." @@ -24596,6 +25010,10 @@ "$ref": "GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult", "description": "Result for pairwise summarization quality metric." }, + "pointwiseMetricResult": { + "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", + "description": "Generic metrics. Result for pointwise metric." + }, "questionAnsweringCorrectnessResult": { "$ref": "GoogleCloudAiplatformV1beta1QuestionAnsweringCorrectnessResult", "description": "Result for question answering correctness metric." @@ -26073,6 +26491,20 @@ "type": "string" }, "type": "array" + }, + "timeSeries": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", + "description": "Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries": { + "id": "GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries", + "properties": { + "timestampColumn": { + "description": "Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used.", + "type": "string" } }, "type": "object" @@ -26180,6 +26612,16 @@ "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized", "description": "Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. State of the featureOnlineStore.", "enum": [ @@ -26461,6 +26903,16 @@ "description": "Identifier. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "serviceAccountEmail": { "description": "Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store.", "readOnly": true, @@ -26674,6 +27126,16 @@ "description": "Output only. Time when this FeatureViewSync is finished.", "readOnly": true }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "syncSummary": { "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSyncSyncSummary", "description": "Output only. Summary of the sync job.", @@ -26819,6 +27281,16 @@ "format": "int32", "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "state": { "description": "Output only. State of the featurestore.", "enum": [ @@ -27425,7 +27897,7 @@ ], "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", - "Default model behavior, model decides to predict either a function call or a natural language repspose.", + "Default model behavior, model decides to predict either a function call or a natural language response.", "Model is constrained to always predicting a function call only. If \"allowed_function_names\" are set, the predicted function call will be limited to any one of \"allowed_function_names\", else the predicted function call will be any one of the provided \"function_declarations\".", "Model will not predict any function call. Model behavior is same as when not passing any function declarations." ], @@ -27653,7 +28125,7 @@ "type": "integer" }, "promptTokenCount": { - "description": "Number of tokens in the request.", + "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, @@ -27664,6 +28136,32 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerateVideoResponse": { + "description": "Generate video response.", + "id": "GoogleCloudAiplatformV1beta1GenerateVideoResponse", + "properties": { + "generatedSamples": { + "description": "The cloud storage uris of the generated videos.", + "items": { + "type": "string" + }, + "type": "array" + }, + "raiMediaFilteredCount": { + "description": "Returns if any videos were filtered due to RAI policies.", + "format": "int32", + "type": "integer" + }, + "raiMediaFilteredReasons": { + "description": "Returns rai failure reasons if any.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenerationConfig": { "description": "Generation config.", "id": "GoogleCloudAiplatformV1beta1GenerationConfig", @@ -27696,6 +28194,15 @@ "$ref": "GoogleCloudAiplatformV1beta1Schema", "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." }, + "routingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", + "description": "Optional. Routing configuration." + }, + "seed": { + "description": "Optional. Seed.", + "format": "int32", + "type": "integer" + }, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -27721,6 +28228,55 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { + "description": "Routing config.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", + "properties": { + "autoMode": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", + "description": "Automated routing." + }, + "manualMode": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", + "description": "Manual routing." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { + "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", + "properties": { + "modelRoutingPreference": { + "description": "The model routing preference.", + "enum": [ + "UNKNOWN", + "PRIORITIZE_QUALITY", + "BALANCED", + "PRIORITIZE_COST" + ], + "enumDescriptions": [ + "Unspecified model routing preference.", + "Prefer higher quality over low cost.", + "Balanced model routing preference.", + "Prefer lower cost over higher quality." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { + "description": "When manual routing is set, the specified model will be used directly.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", + "properties": { + "modelName": { + "description": "The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GenericOperationMetadata": { "description": "Generic Metadata shared by all operations.", "id": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", @@ -27870,10 +28426,69 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GroundingChunk": { + "description": "Grounding chunk.", + "id": "GoogleCloudAiplatformV1beta1GroundingChunk", + "properties": { + "retrievedContext": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", + "description": "Grounding chunk from context retrieved by the retrieval tools." + }, + "web": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", + "description": "Grounding chunk from the web." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext": { + "description": "Chunk from context retrieved by the retrieval tools.", + "id": "GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext", + "properties": { + "title": { + "description": "Title of the attribution.", + "type": "string" + }, + "uri": { + "description": "URI reference of the attribution.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1GroundingChunkWeb": { + "description": "Chunk from the web.", + "id": "GoogleCloudAiplatformV1beta1GroundingChunkWeb", + "properties": { + "title": { + "description": "Title of the chunk.", + "type": "string" + }, + "uri": { + "description": "URI reference of the chunk.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GroundingMetadata": { "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { + "groundingChunks": { + "description": "List of supporting references retrieved from specified grounding source.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingChunk" + }, + "type": "array" + }, + "groundingSupports": { + "description": "Optional. List of grounding support.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1GroundingSupport" + }, + "type": "array" + }, "retrievalQueries": { "description": "Optional. Queries executed by the retrieval tools.", "items": { @@ -27895,6 +28510,33 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GroundingSupport": { + "description": "Grounding support.", + "id": "GoogleCloudAiplatformV1beta1GroundingSupport", + "properties": { + "confidenceScores": { + "description": "Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + }, + "groundingChunkIndices": { + "description": "A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "segment": { + "$ref": "GoogleCloudAiplatformV1beta1Segment", + "description": "Segment of the content this support belongs to." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1HyperparameterTuningJob": { "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", "id": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob", @@ -27951,6 +28593,16 @@ "format": "int32", "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "startTime": { "description": "Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -28260,6 +28912,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." }, + "jiraSource": { + "$ref": "GoogleCloudAiplatformV1beta1JiraSource", + "description": "Jira queries with their corresponding authentication." + }, "maxEmbeddingRequestsPerMin": { "description": "Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.", "format": "int32", @@ -28268,6 +28924,14 @@ "ragFileChunkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after importing RagFiles." + }, + "ragFileParsingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", + "description": "Specifies the parsing config for RagFiles." + }, + "slackSource": { + "$ref": "GoogleCloudAiplatformV1beta1SlackSource", + "description": "Slack channels with their corresponding access tokens." } }, "type": "object" @@ -28356,6 +29020,16 @@ "readOnly": true, "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.", "format": "google-datetime", @@ -28581,6 +29255,16 @@ "description": "Optional. If true, the deployed index will be accessible through public endpoint.", "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.", "format": "google-datetime", @@ -28781,6 +29465,53 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1JiraSource": { + "description": "The Jira source for the ImportRagFilesRequest.", + "id": "GoogleCloudAiplatformV1beta1JiraSource", + "properties": { + "jiraQueries": { + "description": "Required. The Jira queries.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries": { + "description": "JiraQueries contains the Jira queries and corresponding authentication.", + "id": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", + "description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)." + }, + "customQueries": { + "description": "A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/", + "items": { + "type": "string" + }, + "type": "array" + }, + "email": { + "description": "Required. The Jira email address.", + "type": "string" + }, + "projects": { + "description": "A list of Jira projects to import in their entirety.", + "items": { + "type": "string" + }, + "type": "array" + }, + "serverUri": { + "description": "Required. The Jira server URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1beta1LargeModelReference", @@ -29867,9 +30598,25 @@ "TPU_V4_POD", "TPU_V5_LITEPOD" ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], "enumDescriptions": [ "Unspecified accelerator type, which means no accelerator.", - "Nvidia Tesla K80 GPU.", + "Deprecated: Nvidia Tesla K80 GPU has reached end of support, see https://cloud.google.com/compute/docs/eol/k80-eol.", "Nvidia Tesla P100 GPU.", "Nvidia Tesla V100 GPU.", "Nvidia Tesla P4 GPU.", @@ -29889,6 +30636,10 @@ "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" }, + "reservationAffinity": { + "$ref": "GoogleCloudAiplatformV1beta1ReservationAffinity", + "description": "Optional. Immutable. Configuration controlling how this resource pool consumes reservation." + }, "tpuTopology": { "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", "type": "string" @@ -30410,6 +31161,16 @@ "$ref": "GoogleCloudAiplatformV1beta1PredictSchemata", "description": "The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "supportedDeploymentResourcesTypes": { "description": "Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats.", "items": { @@ -30725,6 +31486,16 @@ "description": "Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.", "type": "any" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "scheduleState": { "description": "Output only. Schedule state when the monitoring job is in Running state.", "enum": [ @@ -31144,6 +31915,16 @@ "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec", "description": "Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "tabularObjective": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective", "description": "Optional default tabular model monitoring objective." @@ -32311,6 +33092,16 @@ "$ref": "GoogleCloudAiplatformV1beta1NasJobSpec", "description": "Required. The specification of a NasJob." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "startTime": { "description": "Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -32609,6 +33400,13 @@ "format": "int32", "type": "integer" }, + "numericFilters": { + "description": "Optional. The list of numeric filters.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter" + }, + "type": "array" + }, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", "description": "Optional. Parameters that can be set to tune query on the fly." @@ -32643,6 +33441,54 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter": { + "description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1", + "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter", + "properties": { + "name": { + "description": "Required. Column name in BigQuery that used as filters.", + "type": "string" + }, + "op": { + "description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", + "enum": [ + "OPERATOR_UNSPECIFIED", + "LESS", + "LESS_EQUAL", + "EQUAL", + "GREATER_EQUAL", + "GREATER", + "NOT_EQUAL" + ], + "enumDescriptions": [ + "Unspecified operator.", + "Entities are eligible if their value is < the query's.", + "Entities are eligible if their value is <= the query's.", + "Entities are eligible if their value is == the query's.", + "Entities are eligible if their value is >= the query's.", + "Entities are eligible if their value is > the query's.", + "Entities are eligible if their value is != the query's." + ], + "type": "string" + }, + "valueDouble": { + "description": "double value type.", + "format": "double", + "type": "number" + }, + "valueFloat": { + "description": "float value type.", + "format": "float", + "type": "number" + }, + "valueInt": { + "description": "int value type.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters": { "description": "Parameters that can be overrided in each query to tune query latency and recall.", "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", @@ -32935,6 +33781,10 @@ "description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", "type": "string" }, + "encryptionSpec": { + "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", + "description": "Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec." + }, "executionTimeout": { "description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", "format": "google-duration", @@ -33349,6 +34199,72 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PairwiseMetricInput": { + "description": "Input for pairwise metric.", + "id": "GoogleCloudAiplatformV1beta1PairwiseMetricInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance", + "description": "Required. Pairwise metric instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", + "description": "Required. Spec for pairwise metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PairwiseMetricInstance": { + "description": "Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1beta1PairwiseMetricInstance", + "properties": { + "jsonInstance": { + "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PairwiseMetricResult": { + "description": "Spec for pairwise metric result.", + "id": "GoogleCloudAiplatformV1beta1PairwiseMetricResult", + "properties": { + "explanation": { + "description": "Output only. Explanation for pairwise metric score.", + "readOnly": true, + "type": "string" + }, + "pairwiseChoice": { + "description": "Output only. Pairwise metric choice.", + "enum": [ + "PAIRWISE_CHOICE_UNSPECIFIED", + "BASELINE", + "CANDIDATE", + "TIE" + ], + "enumDescriptions": [ + "Unspecified prediction choice.", + "Baseline prediction wins", + "Candidate prediction wins", + "Winner cannot be determined" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PairwiseMetricSpec": { + "description": "Spec for pairwise metric.", + "id": "GoogleCloudAiplatformV1beta1PairwiseMetricSpec", + "properties": { + "metricPromptTemplate": { + "description": "Required. Metric prompt template for pairwise metric.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput": { "description": "Input for pairwise question answering quality metric.", "id": "GoogleCloudAiplatformV1beta1PairwiseQuestionAnsweringQualityInput", @@ -33632,6 +34548,10 @@ "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, + "pscInterfaceConfig": { + "$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", + "description": "Optional. Configuration for PSC-I for PersistentResource." + }, "reservedIpRanges": { "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -33766,6 +34686,16 @@ "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig", "description": "Runtime config of the pipeline." }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "scheduleName": { "description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.", "readOnly": true, @@ -34162,6 +35092,61 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PointwiseMetricInput": { + "description": "Input for pointwise metric.", + "id": "GoogleCloudAiplatformV1beta1PointwiseMetricInput", + "properties": { + "instance": { + "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance", + "description": "Required. Pointwise metric instance." + }, + "metricSpec": { + "$ref": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", + "description": "Required. Spec for pointwise metric." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PointwiseMetricInstance": { + "description": "Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset.", + "id": "GoogleCloudAiplatformV1beta1PointwiseMetricInstance", + "properties": { + "jsonInstance": { + "description": "Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PointwiseMetricResult": { + "description": "Spec for pointwise metric result.", + "id": "GoogleCloudAiplatformV1beta1PointwiseMetricResult", + "properties": { + "explanation": { + "description": "Output only. Explanation for pointwise metric score.", + "readOnly": true, + "type": "string" + }, + "score": { + "description": "Output only. Pointwise metric score.", + "format": "float", + "readOnly": true, + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PointwiseMetricSpec": { + "description": "Spec for pointwise metric.", + "id": "GoogleCloudAiplatformV1beta1PointwiseMetricSpec", + "properties": { + "metricPromptTemplate": { + "description": "Required. Metric prompt template for pointwise metric.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Port": { "description": "Represents a network port in a container.", "id": "GoogleCloudAiplatformV1beta1Port", @@ -34185,6 +35170,23 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PredictLongRunningMetadata": { + "description": "Metadata for PredictLongRunning long running operations.", + "id": "GoogleCloudAiplatformV1beta1PredictLongRunningMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1PredictLongRunningResponse": { + "description": "Response message for [PredictionService.PredictLongRunning]", + "id": "GoogleCloudAiplatformV1beta1PredictLongRunningResponse", + "properties": { + "generateVideoResponse": { + "$ref": "GoogleCloudAiplatformV1beta1GenerateVideoResponse", + "description": "The response of the video generation prediction." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PredictRequest": { "description": "Request message for PredictionService.Predict.", "id": "GoogleCloudAiplatformV1beta1PredictRequest", @@ -34356,6 +35358,11 @@ "type": "string" }, "type": "array" + }, + "serviceAttachment": { + "description": "Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect.", + "readOnly": true, + "type": "string" } }, "type": "object" @@ -34414,6 +35421,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PscInterfaceConfig": { + "description": "Configuration for PSC-I.", + "id": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", + "properties": { + "networkAttachment": { + "description": "Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1beta1PublisherModel", @@ -34586,6 +35604,10 @@ "$ref": "GoogleCloudAiplatformV1beta1DedicatedResources", "description": "A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration." }, + "deployMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata", + "description": "Optional. Metadata information about this deployment config." + }, "deployTaskName": { "description": "Optional. The name of the deploy task (e.g., \"text to image generation\").", "type": "string" @@ -34613,6 +35635,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata": { + "description": "Metadata information about the deployment for managing deployment config.", + "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc.", + "type": "object" + }, + "sampleRequest": { + "description": "Optional. Sample request for deployed endpoint.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke": { "description": "Configurations for PublisherModel GKE deployment", "id": "GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployGke", @@ -35354,7 +36394,7 @@ "id": "GoogleCloudAiplatformV1beta1RagContextsContext", "properties": { "distance": { - "description": "The distance between the query vector and the context text vector.", + "description": "The distance between the query dense embedding vector and the context text vector.", "format": "double", "type": "number" }, @@ -35362,6 +36402,11 @@ "description": "For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name.", "type": "string" }, + "sparseDistance": { + "description": "The distance between the query sparse embedding vector and the context text vector.", + "format": "double", + "type": "number" + }, "text": { "description": "The text chunk.", "type": "string" @@ -35409,9 +36454,60 @@ "description": "Config for the embedding model to use for RAG.", "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig", "properties": { + "hybridSearchConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig", + "description": "Configuration for hybrid search." + }, "vertexPredictionEndpoint": { "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint", - "description": "The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported." + "description": "The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig": { + "description": "Config for hybrid search.", + "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig", + "properties": { + "denseEmbeddingModelPredictionEndpoint": { + "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint", + "description": "Required. The Vertex AI Prediction Endpoint that hosts the embedding model for dense embedding generations." + }, + "sparseEmbeddingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig", + "description": "Optional. The configuration for sparse embedding generation. This field is optional the default behavior depends on the vector database choice on the RagCorpus." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig": { + "description": "Configuration for sparse emebdding generation.", + "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig", + "properties": { + "bm25": { + "$ref": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25", + "description": "Use BM25 scoring algorithm." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25": { + "description": "Message for BM25 parameters.", + "id": "GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25", + "properties": { + "b": { + "description": "Optional. The parameter to control document length normalization. It determines how much the document length affects the final score. b is in the range of [0, 1]. The default value is 0.75.", + "format": "float", + "type": "number" + }, + "k1": { + "description": "Optional. The parameter to control term frequency saturation. It determines the scaling between the matching term frequency and final score. k1 is in the range of [1.2, 3]. The default value is 1.2.", + "format": "float", + "type": "number" + }, + "multilingual": { + "description": "Optional. Use multilingual tokenizer if set to true.", + "type": "boolean" } }, "type": "object" @@ -35470,6 +36566,10 @@ "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", "readOnly": true }, + "jiraSource": { + "$ref": "GoogleCloudAiplatformV1beta1JiraSource", + "description": "The RagFile is imported from a Jira query." + }, "name": { "description": "Output only. The resource name of the RagFile.", "readOnly": true, @@ -35496,6 +36596,10 @@ "readOnly": true, "type": "string" }, + "slackSource": { + "$ref": "GoogleCloudAiplatformV1beta1SlackSource", + "description": "The RagFile is imported from a Slack channel." + }, "updateTime": { "description": "Output only. Timestamp when this RagFile was last updated.", "format": "google-datetime", @@ -35522,6 +36626,21 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagFileParsingConfig": { + "description": "Specifies the parsing config for RagFiles.", + "id": "GoogleCloudAiplatformV1beta1RagFileParsingConfig", + "properties": { + "parsePdfsUsingOcr": { + "description": "Whether to use OCR for PDFs.", + "type": "boolean" + }, + "useAdvancedPdfParsing": { + "description": "Whether to use advanced PDF parsing.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RagQuery": { "description": "A query to retrieve relevant contexts.", "id": "GoogleCloudAiplatformV1beta1RagQuery", @@ -35534,11 +36653,6 @@ "text": { "description": "Optional. The query in text format to get relevant contexts.", "type": "string" - }, - "vectorDistanceThreshold": { - "description": "Optional. Only return contexts with vector distance smaller than the threshold.", - "format": "double", - "type": "number" } }, "type": "object" @@ -35554,6 +36668,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RayLogsSpec": { + "description": "Configuration for the Ray OSS Logs.", + "id": "GoogleCloudAiplatformV1beta1RayLogsSpec", + "properties": { + "disabled": { + "description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1beta1RayMetricSpec", @@ -35577,6 +36702,10 @@ "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, + "rayLogsSpec": { + "$ref": "GoogleCloudAiplatformV1beta1RayLogsSpec", + "description": "Optional. OSS Ray logging configurations." + }, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -36036,13 +37165,47 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReservationAffinity": { + "description": "A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity.", + "id": "GoogleCloudAiplatformV1beta1ReservationAffinity", + "properties": { + "key": { + "description": "Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value.", + "type": "string" + }, + "reservationAffinityType": { + "description": "Required. Specifies the reservation affinity type.", + "enum": [ + "TYPE_UNSPECIFIED", + "NO_RESERVATION", + "ANY_RESERVATION", + "SPECIFIC_RESERVATION" + ], + "enumDescriptions": [ + "Default value. This should not be used.", + "Do not consume from any reserved capacity, only use on-demand.", + "Consume any reservation available, falling back to on-demand.", + "Consume from a specific reservation. When chosen, the reservation must be identified via the `key` and `values` fields." + ], + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ResourcePool": { "description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", "id": "GoogleCloudAiplatformV1beta1ResourcePool", "properties": { "autoscalingSpec": { "$ref": "GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec", - "description": "Optional. Optional spec to configure GKE autoscaling" + "description": "Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling" }, "diskSpec": { "$ref": "GoogleCloudAiplatformV1beta1DiskSpec", @@ -36080,7 +37243,7 @@ "type": "string" }, "minReplicaCount": { - "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error", + "description": "Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be > 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java.", "format": "int64", "type": "string" } @@ -36169,7 +37332,8 @@ "id": "GoogleCloudAiplatformV1beta1Retrieval", "properties": { "disableAttribution": { - "description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", + "deprecated": true, + "description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -36217,6 +37381,10 @@ }, "type": "array" }, + "ranking": { + "$ref": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking", + "description": "Optional. Configurations for hybrid search results ranking." + }, "vectorDistanceThreshold": { "description": "Optional. Only return contexts with vector distance smaller than the threshold.", "format": "double", @@ -36243,6 +37411,18 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking": { + "description": "Configurations for hybrid search results ranking.", + "id": "GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking", + "properties": { + "alpha": { + "description": "Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1RetrieveContextsResponse": { "description": "Response message for VertexRagService.RetrieveContexts.", "id": "GoogleCloudAiplatformV1beta1RetrieveContextsResponse", @@ -36352,7 +37532,7 @@ }, "vertexAiSearchRuntimeConfig": { "$ref": "GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig", - "description": "Runtime configuration for Vertext AI Search extension." + "description": "Runtime configuration for Vertex AI Search extension." } }, "type": "object" @@ -36863,6 +38043,31 @@ "description": "Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, + "strategy": { + "description": "Optional. This determines which type of scheduling strategy to use.", + "enum": [ + "STRATEGY_UNSPECIFIED", + "ON_DEMAND", + "LOW_COST", + "STANDARD", + "SPOT" + ], + "enumDeprecated": [ + false, + true, + true, + false, + false + ], + "enumDescriptions": [ + "Strategy will default to STANDARD.", + "Regular on-demand provisioning strategy.", + "Low cost by making potential use of spot resources.", + "Standard provisioning strategy uses regular on-demand resources.", + "Spot provisioning strategy uses spot resources." + ], + "type": "string" + }, "timeout": { "description": "The maximum job running time. The default is 7 days.", "format": "google-duration", @@ -40973,6 +42178,36 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1Segment": { + "description": "Segment of the content.", + "id": "GoogleCloudAiplatformV1beta1Segment", + "properties": { + "endIndex": { + "description": "Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "partIndex": { + "description": "Output only. The index of a Part object within its parent Content object.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "startIndex": { + "description": "Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "text": { + "description": "Output only. The text corresponding to the segment from the response.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1beta1ServiceAccountSpec", @@ -40999,6 +42234,59 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SlackSource": { + "description": "The Slack source for the ImportRagFilesRequest.", + "id": "GoogleCloudAiplatformV1beta1SlackSource", + "properties": { + "channels": { + "description": "Required. The Slack channels.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels": { + "description": "SlackChannels contains the Slack channels and corresponding access token.", + "id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels", + "properties": { + "apiKeyConfig": { + "$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", + "description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token." + }, + "channels": { + "description": "Required. The Slack channel IDs.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel": { + "description": "SlackChannel contains the Slack channel ID and the time range to import.", + "id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel", + "properties": { + "channelId": { + "description": "Required. The Slack channel ID.", + "type": "string" + }, + "endTime": { + "description": "Optional. The ending timestamp for messages to import.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Optional. The starting timestamp for messages to import.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1SmoothGradConfig": { "description": "Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf", "id": "GoogleCloudAiplatformV1beta1SmoothGradConfig", @@ -42140,14 +43428,16 @@ "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", - "ADAPTER_SIZE_SIXTEEN" + "ADAPTER_SIZE_SIXTEEN", + "ADAPTER_SIZE_THIRTY_TWO" ], "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 4.", "Adapter size 8.", - "Adapter size 16." + "Adapter size 16.", + "Adapter size 32." ], "type": "string" }, @@ -42169,11 +43459,18 @@ "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats", "properties": { "totalBillableCharacterCount": { + "deprecated": true, "description": "Output only. Number of billable characters in the tuning dataset.", "format": "int64", "readOnly": true, "type": "string" }, + "totalBillableTokenCount": { + "description": "Output only. Number of billable tokens in the tuning dataset.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "totalTuningCharacterCount": { "description": "Output only. Number of tuning characters in the tuning dataset.", "format": "int64", @@ -42222,6 +43519,12 @@ "description": "Dataset distribution for Supervised Tuning.", "id": "GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution", "properties": { + "billableSum": { + "description": "Output only. Sum of a given population of values that are billable.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "buckets": { "description": "Output only. Defines the histogram bucket.", "items": { @@ -42538,6 +43841,16 @@ "readOnly": true, "type": "integer" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "updateTime": { "description": "Output only. Timestamp when this Tensorboard was last updated.", "format": "google-datetime", @@ -42881,6 +44194,10 @@ "description": "Tokens info with a list of tokens and the corresponding list of token ids.", "id": "GoogleCloudAiplatformV1beta1TokensInfo", "properties": { + "role": { + "description": "Optional. Optional fields for the role from the corresponding Content.", + "type": "string" + }, "tokenIds": { "description": "A list of token ids from the input.", "items": { @@ -43483,7 +44800,6 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1TrialContext": { - "description": "Next ID: 3", "id": "GoogleCloudAiplatformV1beta1TrialContext", "properties": { "description": { @@ -43538,6 +44854,11 @@ "description": "The tuning data statistic values for TuningJob.", "id": "GoogleCloudAiplatformV1beta1TuningDataStats", "properties": { + "distillationDataStats": { + "$ref": "GoogleCloudAiplatformV1beta1DistillationDataStats", + "description": "Output only. Statistics for distillation.", + "readOnly": true + }, "supervisedTuningDataStats": { "$ref": "GoogleCloudAiplatformV1beta1SupervisedTuningDataStats", "description": "The SFT Tuning data stats." @@ -43563,6 +44884,10 @@ "description": "Optional. The description of the TuningJob.", "type": "string" }, + "distillationSpec": { + "$ref": "GoogleCloudAiplatformV1beta1DistillationSpec", + "description": "Tuning Spec for Distillation." + }, "encryptionSpec": { "$ref": "GoogleCloudAiplatformV1beta1EncryptionSpec", "description": "Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key." @@ -43595,6 +44920,11 @@ "readOnly": true, "type": "string" }, + "pipelineJob": { + "description": "Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project}/locations/{location}/pipelineJobs/{pipeline_job}`.", + "readOnly": true, + "type": "string" + }, "startTime": { "description": "Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state.", "format": "google-datetime", @@ -44675,70 +46005,6 @@ } }, "type": "object" - }, - "IntelligenceCloudAutomlXpsMetricEntry": { - "id": "IntelligenceCloudAutomlXpsMetricEntry", - "properties": { - "argentumMetricId": { - "description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", - "type": "string" - }, - "doubleValue": { - "description": "A double value.", - "format": "double", - "type": "number" - }, - "int64Value": { - "description": "A signed 64-bit integer value.", - "format": "int64", - "type": "string" - }, - "metricName": { - "description": "The metric name defined in the service configuration.", - "type": "string" - }, - "systemLabels": { - "description": "Billing system labels for this (metric, value) pair.", - "items": { - "$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" - }, - "type": "array" - } - }, - "type": "object" - }, - "IntelligenceCloudAutomlXpsMetricEntryLabel": { - "id": "IntelligenceCloudAutomlXpsMetricEntryLabel", - "properties": { - "labelName": { - "description": "The name of the label.", - "type": "string" - }, - "labelValue": { - "description": "The value of the label.", - "type": "string" - } - }, - "type": "object" - }, - "IntelligenceCloudAutomlXpsReportingMetrics": { - "id": "IntelligenceCloudAutomlXpsReportingMetrics", - "properties": { - "effectiveTrainingDuration": { - "deprecated": true, - "description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", - "format": "google-duration", - "type": "string" - }, - "metricEntries": { - "description": "One entry per metric name. The values must be aggregated per metric name.", - "items": { - "$ref": "IntelligenceCloudAutomlXpsMetricEntry" - }, - "type": "array" - } - }, - "type": "object" } }, "servicePath": "", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index ba1d375993..84463b90b0 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -1489,7 +1489,7 @@ } } }, - "revision": "20240612", + "revision": "20240627", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1968,6 +1968,25 @@ "readOnly": true, "type": "string" }, + "subscriptionType": { + "description": "Optional. Subscription type of the cluster.", + "enum": [ + "SUBSCRIPTION_TYPE_UNSPECIFIED", + "STANDARD", + "TRIAL" + ], + "enumDescriptions": [ + "This is an unknown Subscription type (By default, Subscription Type is STANDARD)", + "Standard subscription.", + "Trial subscription." + ], + "type": "string" + }, + "trialMetadata": { + "$ref": "TrialMetadata", + "description": "Output only. Metadata for free trial clusters", + "readOnly": true + }, "uid": { "description": "Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.", "readOnly": true, @@ -4577,6 +4596,28 @@ }, "type": "object" }, + "TrialMetadata": { + "description": "Contains information and all metadata related to TRIAL clusters.", + "id": "TrialMetadata", + "properties": { + "endTime": { + "description": "End time of the trial cluster.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "start time of the trial cluster.", + "format": "google-datetime", + "type": "string" + }, + "upgradeTime": { + "description": "Upgrade time of trial cluster to Standard cluster.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "User": { "description": "Message describing User object.", "id": "User", diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 37445d0c50..a6a1f07edc 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -735,6 +735,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "upgrade": { + "description": "Upgrades a single Cluster. Imperative only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade", + "httpMethod": "PATCH", + "id": "alloydb.projects.locations.clusters.upgrade", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the cluster.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:upgrade", + "request": { + "$ref": "UpgradeClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1489,7 +1517,7 @@ } } }, - "revision": "20240612", + "revision": "20240806", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1578,19 +1606,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1783,6 +1814,26 @@ }, "type": "object" }, + "CloudSQLBackupRunSource": { + "description": "The source CloudSQL backup resource.", + "id": "CloudSQLBackupRunSource", + "properties": { + "backupRunId": { + "description": "Required. The CloudSQL backup run ID.", + "format": "int64", + "type": "string" + }, + "instanceId": { + "description": "Required. The CloudSQL instance ID.", + "type": "string" + }, + "project": { + "description": "The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.", + "type": "string" + } + }, + "type": "object" + }, "Cluster": { "description": "A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.", "id": "Cluster", @@ -1803,6 +1854,11 @@ "description": "Output only. Cluster created from backup.", "readOnly": true }, + "cloudsqlBackupRunSource": { + "$ref": "CloudSQLBackupRunSource", + "description": "Output only. Cluster created from CloudSQL snapshot.", + "readOnly": true + }, "clusterType": { "description": "Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`", "enum": [ @@ -1839,19 +1895,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -2015,6 +2074,86 @@ }, "type": "object" }, + "ClusterUpgradeDetails": { + "description": "Upgrade details of a cluster. This cluster can be primary or secondary.", + "id": "ClusterUpgradeDetails", + "properties": { + "clusterType": { + "description": "Cluster type which can either be primary or secondary.", + "enum": [ + "CLUSTER_TYPE_UNSPECIFIED", + "PRIMARY", + "SECONDARY" + ], + "enumDescriptions": [ + "The type of the cluster is unknown.", + "Primary cluster that support read and write operations.", + "Secondary cluster that is replicating from another region. This only supports read." + ], + "type": "string" + }, + "databaseVersion": { + "description": "Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.", + "enum": [ + "DATABASE_VERSION_UNSPECIFIED", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "DEPRECATED - The database version is Postgres 13.", + "The database version is Postgres 14.", + "The database version is Postgres 15.", + "The database version is Postgres 16." + ], + "type": "string" + }, + "instanceUpgradeDetails": { + "description": "Upgrade details of the instances directly associated with this cluster.", + "items": { + "$ref": "InstanceUpgradeDetails" + }, + "type": "array" + }, + "name": { + "description": "Normalized name of the cluster", + "type": "string" + }, + "stageInfo": { + "description": "Array containing stage info associated with this cluster.", + "items": { + "$ref": "StageInfo" + }, + "type": "array" + }, + "upgradeStatus": { + "description": "Upgrade status of the cluster.", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS" + ], + "enumDescriptions": [ + "Unspecified status.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded." + ], + "type": "string" + } + }, + "type": "object" + }, "ConnectionInfo": { "description": "ConnectionInfo singleton resource. https://google.aip.dev/156", "id": "ConnectionInfo", @@ -2564,6 +2703,49 @@ }, "type": "object" }, + "InstanceUpgradeDetails": { + "description": "Details regarding the upgrade of instaces associated with a cluster.", + "id": "InstanceUpgradeDetails", + "properties": { + "instanceType": { + "description": "Instance type.", + "enum": [ + "INSTANCE_TYPE_UNSPECIFIED", + "PRIMARY", + "READ_POOL", + "SECONDARY" + ], + "enumDescriptions": [ + "The type of the instance is unknown.", + "PRIMARY instances support read and write operations.", + "READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).", + "SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica" + ], + "type": "string" + }, + "name": { + "description": "Normalized name of the instance.", + "type": "string" + }, + "upgradeStatus": { + "description": "Upgrade status of the instance.", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS" + ], + "enumDescriptions": [ + "Unspecified status.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded." + ], + "type": "string" + } + }, + "type": "object" + }, "IntegerRestrictions": { "description": "Restrictions on INTEGER type values.", "id": "IntegerRestrictions", @@ -2864,7 +3046,7 @@ "id": "ObservabilityInstanceConfig", "properties": { "enabled": { - "description": "Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned \"off\" by default.", + "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", "type": "boolean" }, "maxQueryStringLength": { @@ -2877,7 +3059,7 @@ "type": "boolean" }, "queryPlansPerMinute": { - "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.", + "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.", "format": "int32", "type": "integer" }, @@ -2889,6 +3071,10 @@ "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.", "type": "boolean" }, + "trackClientAddress": { + "description": "Track client address for an instance. If not set, default value is \"off\".", + "type": "boolean" + }, "trackWaitEventTypes": { "description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.", "readOnly": true, @@ -3120,6 +3306,13 @@ "RestartInstanceRequest": { "id": "RestartInstanceRequest", "properties": { + "nodeIds": { + "description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.", + "items": { + "type": "string" + }, + "type": "array" + }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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).", "type": "string" @@ -3220,6 +3413,51 @@ }, "type": "object" }, + "StageInfo": { + "description": "Stage information for different stages in the upgrade process.", + "id": "StageInfo", + "properties": { + "logsUrl": { + "description": "logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.", + "type": "string" + }, + "stage": { + "description": "The stage.", + "enum": [ + "STAGE_UNSPECIFIED", + "ALLOYDB_PRECHECK", + "PG_UPGRADE_CHECK", + "PRIMARY_INSTANCE_UPGRADE", + "READ_POOL_UPGRADE" + ], + "enumDescriptions": [ + "Unspecified stage.", + "This stage is for the custom checks done before upgrade.", + "This stage is for `pg_upgrade --check` run before upgrade.", + "This stage is primary upgrade.", + "This stage is read pool upgrade." + ], + "type": "string" + }, + "status": { + "description": "Status of the stage.", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS" + ], + "enumDescriptions": [ + "Unspecified status.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded." + ], + "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", @@ -3352,43 +3590,19 @@ "type": "object" }, "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": { - "description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", + "description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData", "properties": { - "databaseMetadata": { + "internalResourceMetadata": { + "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", "items": { - "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata" + "$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata" }, "type": "array" } }, "type": "object" }, - "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata": { - "description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", - "id": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata", - "properties": { - "backupConfiguration": { - "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", - "description": "Backup configuration for this database" - }, - "backupRun": { - "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", - "description": "Information about the last backup attempt for this database" - }, - "product": { - "$ref": "StorageDatabasecenterProtoCommonProduct" - }, - "resourceId": { - "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" - }, - "resourceName": { - "description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", - "type": "string" - } - }, - "type": "object" - }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -3417,8 +3631,7 @@ "type": "string" }, "observabilityMetricData": { - "$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData", - "description": "More feed data would be added in subsequent CLs" + "$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData" }, "recommendationSignalData": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData" @@ -3527,6 +3740,24 @@ "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, + "signalSeverity": { + "description": "The severity of the signal, such as if it's a HIGH or LOW severity.", + "enum": [ + "SIGNAL_SEVERITY_UNSPECIFIED", + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "This value is used for findings when a source doesn't write a severity value.", + "A critical vulnerability is easily discoverable by an external actor, exploitable.", + "A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", + "A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", + "A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." + ], + "type": "string" + }, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -3823,7 +4054,7 @@ "type": "string" }, "resourceType": { - "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", + "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -4321,6 +4552,31 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": { + "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", + "id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata", + "properties": { + "backupConfiguration": { + "$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration", + "description": "Backup configuration for this database" + }, + "backupRun": { + "$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun", + "description": "Information about the last backup attempt for this database" + }, + "product": { + "$ref": "StorageDatabasecenterProtoCommonProduct" + }, + "resourceId": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId" + }, + "resourceName": { + "description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": { "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.", "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration", @@ -4494,7 +4750,9 @@ "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", - "ENGINE_OTHER" + "ENGINE_OTHER", + "ENGINE_FIRESTORE_WITH_NATIVE_MODE", + "ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -4510,6 +4768,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -4526,7 +4786,9 @@ "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", - "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." + "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", + "Firestore with native mode.", + "Firestore with datastore mode." ], "type": "string" }, @@ -4543,7 +4805,8 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER" + "PRODUCT_TYPE_OTHER", + "PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -4556,6 +4819,7 @@ true, false, false, + false, false ], "enumDescriptions": [ @@ -4569,7 +4833,8 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", + "Firestore product area in GCP." ], "type": "string" }, @@ -4654,19 +4919,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -4728,6 +4996,11 @@ "format": "google-datetime", "type": "string" }, + "graceEndTime": { + "description": "grace end time of the cluster.", + "format": "google-datetime", + "type": "string" + }, "startTime": { "description": "start time of the trial cluster.", "format": "google-datetime", @@ -4762,6 +5035,84 @@ }, "type": "object" }, + "UpgradeClusterRequest": { + "description": "Upgrades a cluster.", + "id": "UpgradeClusterRequest", + "properties": { + "etag": { + "description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.", + "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).", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.", + "type": "boolean" + }, + "version": { + "description": "Required. The version the cluster is going to be upgraded to.", + "enum": [ + "DATABASE_VERSION_UNSPECIFIED", + "POSTGRES_13", + "POSTGRES_14", + "POSTGRES_15", + "POSTGRES_16" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false + ], + "enumDescriptions": [ + "This is an unknown database version.", + "DEPRECATED - The database version is Postgres 13.", + "The database version is Postgres 14.", + "The database version is Postgres 15.", + "The database version is Postgres 16." + ], + "type": "string" + } + }, + "type": "object" + }, + "UpgradeClusterResponse": { + "description": "UpgradeClusterResponse contains the response for upgrade cluster operation.", + "id": "UpgradeClusterResponse", + "properties": { + "clusterUpgradeDetails": { + "description": "Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.", + "items": { + "$ref": "ClusterUpgradeDetails" + }, + "type": "array" + }, + "message": { + "description": "A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.", + "type": "string" + }, + "status": { + "description": "Status of upgrade operation.", + "enum": [ + "STATUS_UNSPECIFIED", + "SUCCESS", + "FAILED", + "PARTIAL_SUCCESS" + ], + "enumDescriptions": [ + "Unspecified status.", + "Operation succeeded.", + "Operation failed.", + "Operation partially succeeded." + ], + "type": "string" + } + }, + "type": "object" + }, "User": { "description": "Message describing User object.", "id": "User", diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 03855ea43f..84f5f9355d 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20240612", + "revision": "20240703", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1575,19 +1575,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1825,19 +1828,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, @@ -2840,7 +2846,7 @@ "id": "ObservabilityInstanceConfig", "properties": { "enabled": { - "description": "Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned \"off\" by default.", + "description": "Observability feature status for an instance. This flag is turned \"off\" by default.", "type": "boolean" }, "maxQueryStringLength": { @@ -2853,7 +2859,7 @@ "type": "boolean" }, "queryPlansPerMinute": { - "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid.", + "description": "Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid.", "format": "int32", "type": "integer" }, @@ -4630,19 +4636,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", - "POSTGRES_15" + "POSTGRES_15", + "POSTGRES_16" ], "enumDeprecated": [ false, true, false, + false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", - "The database version is Postgres 15." + "The database version is Postgres 15.", + "The database version is Postgres 16." ], "type": "string" }, diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index 0b6c7a5481..b3d62a72cb 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -209,7 +209,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", + "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`", "location": "path", "pattern": "^accounts/[^/]+/dataSharingSettings$", "required": true, @@ -349,7 +349,7 @@ ], "parameters": { "account": { - "description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: \"accounts/100\"", + "description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -719,24 +719,6 @@ "https://www.googleapis.com/auth/analytics.edit" ] }, - "createSubproperty": { - "description": "Create a subproperty and a subproperty event filter that applies to the created subproperty.", - "flatPath": "v1alpha/properties:createSubproperty", - "httpMethod": "POST", - "id": "analyticsadmin.properties.createSubproperty", - "parameterOrder": [], - "parameters": {}, - "path": "v1alpha/properties:createSubproperty", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] - }, "delete": { "description": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.", "flatPath": "v1alpha/properties/{propertiesId}", @@ -1016,6 +998,24 @@ "https://www.googleapis.com/auth/analytics.edit" ] }, + "provisionSubproperty": { + "description": "Create a subproperty and a subproperty event filter that applies to the created subproperty.", + "flatPath": "v1alpha/properties:provisionSubproperty", + "httpMethod": "POST", + "id": "analyticsadmin.properties.provisionSubproperty", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha/properties:provisionSubproperty", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, "runAccessReport": { "description": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).", "flatPath": "v1alpha/properties/{propertiesId}:runAccessReport", @@ -1710,6 +1710,59 @@ }, "bigQueryLinks": { "methods": { + "create": { + "description": "Creates a BigQueryLink.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks", + "httpMethod": "POST", + "id": "analyticsadmin.properties.bigQueryLinks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/1234", + "location": "path", + "pattern": "^properties/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/bigQueryLinks", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes a BigQueryLink on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.bigQueryLinks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678", + "location": "path", + "pattern": "^properties/[^/]+/bigQueryLinks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, "get": { "description": "Lookup for a single BigQuery Link.", "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", @@ -1772,6 +1825,40 @@ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ] + }, + "patch": { + "description": "Updates a BigQueryLink.", + "flatPath": "v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.bigQueryLinks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'", + "location": "path", + "pattern": "^properties/[^/]+/bigQueryLinks/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaBigQueryLink" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] } } }, @@ -2093,7 +2180,7 @@ "methods": { "create": { "deprecated": true, - "description": "Creates a conversion event with the specified attributes.", + "description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", "id": "analyticsadmin.properties.conversionEvents.create", @@ -2122,7 +2209,7 @@ }, "delete": { "deprecated": true, - "description": "Deletes a conversion event in a property.", + "description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.conversionEvents.delete", @@ -2148,7 +2235,7 @@ }, "get": { "deprecated": true, - "description": "Retrieve a single conversion event.", + "description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.get", @@ -2175,7 +2262,7 @@ }, "list": { "deprecated": true, - "description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", + "description": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.list", @@ -2213,7 +2300,7 @@ }, "patch": { "deprecated": true, - "description": "Updates a conversion event with the specified attributes.", + "description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.conversionEvents.patch", @@ -2705,7 +2792,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: \"properties/123/dataStreams/456/globalSiteTag\"", + "description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag`", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/globalSiteTag$", "required": true, @@ -3018,6 +3105,156 @@ }, "eventEditRules": { "methods": { + "create": { + "description": "Creates an EventEditRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules", + "httpMethod": "POST", + "id": "analyticsadmin.properties.dataStreams.eventEditRules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Example format: properties/123/dataStreams/456", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/eventEditRules", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaEventEditRule" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEventEditRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "delete": { + "description": "Deletes an EventEditRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.dataStreams.eventEditRules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Example format: properties/123/dataStreams/456/eventEditRules/789", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/eventEditRules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "get": { + "description": "Lookup for a single EventEditRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.eventEditRules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/eventEditRules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEventEditRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "list": { + "description": "Lists EventEditRules on a web data stream.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.eventEditRules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListEventEditRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventEditRules` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Example format: properties/123/dataStreams/456", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/eventEditRules", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaListEventEditRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, + "patch": { + "description": "Updates an EventEditRule.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.dataStreams.eventEditRules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/eventEditRules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaEventEditRule" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaEventEditRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, "reorder": { "description": "Changes the processing order of event edit rules on the specified stream.", "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", @@ -3041,7 +3278,10 @@ }, "response": { "$ref": "GoogleProtobufEmpty" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] } } }, @@ -3851,7 +4091,7 @@ ], "parameters": { "parent": { - "description": "Required. Format: properties/{property_id} Example: properties/1234", + "description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -3879,7 +4119,7 @@ ], "parameters": { "name": { - "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", + "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, @@ -3915,7 +4155,7 @@ "type": "string" }, "parent": { - "description": "Required. Format: properties/{property_id} Example: properties/1234", + "description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -4646,7 +4886,7 @@ } } }, - "revision": "20240529", + "revision": "20240731", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -5765,6 +6005,10 @@ "description": "If set true, enables daily data export to the linked Google Cloud project.", "type": "boolean" }, + "datasetLocation": { + "description": "Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.", + "type": "string" + }, "excludedEvents": { "description": "The list of event names that will be excluded from exports.", "items": { @@ -6415,36 +6659,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest": { - "description": "Request message for CreateSubproperty RPC.", - "id": "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest", - "properties": { - "subproperty": { - "$ref": "GoogleAnalyticsAdminV1alphaProperty", - "description": "Required. The subproperty to create." - }, - "subpropertyEventFilter": { - "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", - "description": "Optional. The subproperty event filter to create on an ordinary property." - } - }, - "type": "object" - }, - "GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse": { - "description": "Response message for CreateSubproperty RPC.", - "id": "GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse", - "properties": { - "subproperty": { - "$ref": "GoogleAnalyticsAdminV1alphaProperty", - "description": "The created subproperty." - }, - "subpropertyEventFilter": { - "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", - "description": "The created subproperty event filter." - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaCustomDimension": { "description": "A definition for a CustomDimension.", "id": "GoogleAnalyticsAdminV1alphaCustomDimension", @@ -6963,6 +7177,41 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaEventEditRule": { + "description": "An Event Edit Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Create rules, Event Edit Rules are applied in their defined order. Event Edit rules can't be used to modify an event created from an Event Create rule.", + "id": "GoogleAnalyticsAdminV1alphaEventEditRule", + "properties": { + "displayName": { + "description": "Required. The display name of this event edit rule. Maximum of 255 characters.", + "type": "string" + }, + "eventConditions": { + "description": "Required. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaMatchingCondition" + }, + "type": "array" + }, + "name": { + "description": "Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}", + "type": "string" + }, + "parameterMutations": { + "description": "Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaParameterMutation" + }, + "type": "array" + }, + "processingOrder": { + "description": "Output only. The order for which this rule will be processed. Rules with an order value lower than this will be processed before this rule, rules with an order value higher than this will be processed after this rule. New event edit rules will be assigned an order value at the end of the order. This value does not apply to event create rules.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaEventMapping": { "description": "Event setting conditions to match an event.", "id": "GoogleAnalyticsAdminV1alphaEventMapping", @@ -7717,6 +7966,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListEventEditRulesResponse": { + "description": "Response message for ListEventEditRules RPC.", + "id": "GoogleAnalyticsAdminV1alphaListEventEditRulesResponse", + "properties": { + "eventEditRules": { + "description": "List of EventEditRules. These will be ordered stably, but in an arbitrary order.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaEventEditRule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse": { "description": "Response message for ListExpandedDataSets RPC.", "id": "GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse", @@ -8235,6 +8502,36 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest": { + "description": "Request message for CreateSubproperty RPC.", + "id": "GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest", + "properties": { + "subproperty": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty", + "description": "Required. The subproperty to create." + }, + "subpropertyEventFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", + "description": "Optional. The subproperty event filter to create on an ordinary property." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse": { + "description": "Response message for ProvisionSubproperty RPC.", + "id": "GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse", + "properties": { + "subproperty": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty", + "description": "The created subproperty." + }, + "subpropertyEventFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", + "description": "The created subproperty event filter." + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest": { "description": "Request message for ReorderEventEditRules RPC.", "id": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest", @@ -8486,7 +8783,7 @@ "type": "string" }, "property": { - "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: \"properties/100\"", + "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`", "type": "string" }, "resourceType": { @@ -8511,6 +8808,7 @@ "ATTRIBUTION_SETTINGS", "EXPANDED_DATA_SET", "CHANNEL_GROUP", + "BIGQUERY_LINK", "ENHANCED_MEASUREMENT_SETTINGS", "DATA_REDACTION_SETTINGS", "SKADNETWORK_CONVERSION_VALUE_SCHEMA", @@ -8538,6 +8836,7 @@ "AttributionSettings resource", "ExpandedDataSet resource", "ChannelGroup resource", + "BigQuery link resource", "EnhancedMeasurementSettings resource", "DataRedactionSettings resource", "SKAdNetworkConversionValueSchema resource", diff --git a/discovery/analyticsadmin-v1beta.json b/discovery/analyticsadmin-v1beta.json index 62906b8fda..9e278ec8e6 100644 --- a/discovery/analyticsadmin-v1beta.json +++ b/discovery/analyticsadmin-v1beta.json @@ -203,7 +203,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", + "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`", "location": "path", "pattern": "^accounts/[^/]+/dataSharingSettings$", "required": true, @@ -343,7 +343,7 @@ ], "parameters": { "account": { - "description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: \"accounts/100\"", + "description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -630,7 +630,7 @@ "methods": { "create": { "deprecated": true, - "description": "Creates a conversion event with the specified attributes.", + "description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", "id": "analyticsadmin.properties.conversionEvents.create", @@ -659,7 +659,7 @@ }, "delete": { "deprecated": true, - "description": "Deletes a conversion event in a property.", + "description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.conversionEvents.delete", @@ -685,7 +685,7 @@ }, "get": { "deprecated": true, - "description": "Retrieve a single conversion event.", + "description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.get", @@ -712,7 +712,7 @@ }, "list": { "deprecated": true, - "description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", + "description": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.list", @@ -750,7 +750,7 @@ }, "patch": { "deprecated": true, - "description": "Updates a conversion event with the specified attributes.", + "description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.conversionEvents.patch", @@ -1253,35 +1253,6 @@ } }, "resources": { - "eventEditRules": { - "methods": { - "reorder": { - "description": "Changes the processing order of event edit rules on the specified stream.", - "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", - "httpMethod": "POST", - "id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Example format: properties/123/dataStreams/456", - "location": "path", - "pattern": "^properties/[^/]+/dataStreams/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+parent}/eventEditRules:reorder", - "request": { - "$ref": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - } - } - } - }, "measurementProtocolSecrets": { "methods": { "create": { @@ -1450,7 +1421,7 @@ ], "parameters": { "parent": { - "description": "Required. Format: properties/{property_id} Example: properties/1234", + "description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1478,7 +1449,7 @@ ], "parameters": { "name": { - "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", + "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, @@ -1514,7 +1485,7 @@ "type": "string" }, "parent": { - "description": "Required. Format: properties/{property_id} Example: properties/1234", + "description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1817,7 +1788,7 @@ } } }, - "revision": "20240529", + "revision": "20240722", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -3352,20 +3323,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest": { - "description": "Request message for ReorderEventEditRules RPC.", - "id": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest", - "properties": { - "eventEditRules": { - "description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1betaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1betaRunAccessReportRequest", @@ -3522,7 +3479,7 @@ "type": "string" }, "property": { - "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: \"properties/100\"", + "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`", "type": "string" }, "resourceType": { diff --git a/discovery/analyticsdata-v1beta.json b/discovery/analyticsdata-v1beta.json index 1b61c5d3bd..428d0d50ab 100644 --- a/discovery/analyticsdata-v1beta.json +++ b/discovery/analyticsdata-v1beta.json @@ -440,7 +440,7 @@ } } }, - "revision": "20240529", + "revision": "20240731", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { @@ -2037,7 +2037,7 @@ "type": "string" }, "metricAggregations": { - "description": "Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to \"RESERVED_(MetricAggregation)\".", + "description": "Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to \"RESERVED_(MetricAggregation)\". Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges.", "items": { "enum": [ "METRIC_AGGREGATION_UNSPECIFIED", @@ -2074,7 +2074,7 @@ "type": "string" }, "orderBys": { - "description": "Specifies how rows are ordered in the response.", + "description": "Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons.", "items": { "$ref": "OrderBy" }, diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 553b0364cf..981e3a2d5d 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -422,7 +422,7 @@ ] }, "subscribe": { - "description": "Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.", + "description": "Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:subscribe", "httpMethod": "POST", "id": "analyticshub.projects.locations.dataExchanges.subscribe", @@ -1022,7 +1022,7 @@ } } }, - "revision": "20240624", + "revision": "20240715", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { diff --git a/discovery/androidenterprise-v1.json b/discovery/androidenterprise-v1.json index 2d221af913..30b86fb813 100644 --- a/discovery/androidenterprise-v1.json +++ b/discovery/androidenterprise-v1.json @@ -483,6 +483,11 @@ "id": "androidenterprise.enterprises.generateSignupUrl", "parameterOrder": [], "parameters": { + "adminEmail": { + "description": "Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user.", + "location": "query", + "type": "string" + }, "callbackUrl": { "description": "The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named \"enterpriseToken\" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed.", "location": "query", @@ -2649,7 +2654,7 @@ } } }, - "revision": "20240625", + "revision": "20240703", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 3d67144124..22935ba11e 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -585,7 +585,7 @@ "enrollmentTokens": { "methods": { "create": { - "description": "Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.", + "description": "Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.", "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens", "httpMethod": "POST", "id": "androidmanagement.enterprises.enrollmentTokens.create", @@ -1168,7 +1168,7 @@ } } }, - "revision": "20240626", + "revision": "20240808", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1193,7 +1193,7 @@ "id": "AdvancedSecurityOverrides", "properties": { "commonCriteriaMode": { - "description": "Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required.", + "description": "Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required.", "enum": [ "COMMON_CRITERIA_MODE_UNSPECIFIED", "COMMON_CRITERIA_MODE_DISABLED", @@ -2506,7 +2506,7 @@ }, "commonCriteriaModeInfo": { "$ref": "CommonCriteriaModeInfo", - "description": "Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy." + "description": "Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned." }, "deviceSettings": { "$ref": "DeviceSettings", @@ -4248,9 +4248,9 @@ "DEVICE_INCOMPATIBLE" ], "enumDescriptions": [ - "This value is disallowed.", + "This value is not used.", "The setting is not supported in the API level of the Android version running on the device.", - "The management mode (profile owner, device owner, etc.) doesn't support the setting.", + "The management mode (such as fully managed or work profile) doesn't support the setting.", "The user has not taken required action to comply with the setting.", "The setting has an invalid value.", "The app required to implement the policy is not installed.", @@ -4326,9 +4326,9 @@ "DEVICE_INCOMPATIBLE" ], "enumDescriptions": [ - "This value is disallowed.", + "This value is not used.", "The setting is not supported in the API level of the Android version running on the device.", - "The management mode (profile owner, device owner, etc.) doesn't support the setting.", + "The management mode (such as fully managed or work profile) doesn't support the setting.", "The user has not taken required action to comply with the setting.", "The setting has an invalid value.", "The app required to implement the policy is not installed.", @@ -5751,6 +5751,20 @@ ], "type": "string" }, + "defaultStatus": { + "description": "Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail.", + "enum": [ + "SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED", + "SIGNIN_DETAIL_IS_DEFAULT", + "SIGNIN_DETAIL_IS_NOT_DEFAULT" + ], + "enumDescriptions": [ + "Equivalent to SIGNIN_DETAIL_IS_NOT_DEFAULT.", + "The sign-in URL will be used by default for the enterprise.", + "The sign-in URL will not be used by default for the enterprise." + ], + "type": "string" + }, "qrCode": { "description": "A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server.", "type": "string" @@ -5945,7 +5959,7 @@ "type": "boolean" }, "commonCriteriaModeEnabled": { - "description": "Whether Common Criteria Mode reporting is enabled.", + "description": "Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices.", "type": "boolean" }, "deviceSettingsEnabled": { diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index 15fceb2684..af53c66747 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -277,36 +277,6 @@ "https://www.googleapis.com/auth/androidpublisher" ] }, - "appRecoveries": { - "description": "List all app recovery action resources associated with a particular package name and app version.", - "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", - "httpMethod": "POST", - "id": "androidpublisher.apprecovery.appRecoveries", - "parameterOrder": [ - "packageName" - ], - "parameters": { - "packageName": { - "description": "Required. Package name of the app for which list of recovery actions is requested.", - "location": "path", - "required": true, - "type": "string" - }, - "versionCode": { - "description": "Required. Version code targeted by the list of recovery actions.", - "format": "int64", - "location": "query", - "type": "string" - } - }, - "path": "androidpublisher/v3/applications/{packageName}/appRecoveries", - "response": { - "$ref": "ListAppRecoveriesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/androidpublisher" - ] - }, "cancel": { "description": "Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.", "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel", @@ -403,6 +373,36 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] + }, + "list": { + "description": "List all app recovery action resources associated with a particular package name and app version.", + "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", + "httpMethod": "GET", + "id": "androidpublisher.apprecovery.list", + "parameterOrder": [ + "packageName" + ], + "parameters": { + "packageName": { + "description": "Required. Package name of the app for which list of recovery actions is requested.", + "location": "path", + "required": true, + "type": "string" + }, + "versionCode": { + "description": "Required. Version code targeted by the list of recovery actions.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "androidpublisher/v3/applications/{packageName}/appRecoveries", + "response": { + "$ref": "ListAppRecoveriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/androidpublisher" + ] } } }, @@ -3276,7 +3276,7 @@ ] }, "migratePrices": { - "description": "Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.", + "description": "Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported.", "flatPath": "androidpublisher/v3/applications/{packageName}/subscriptions/{productId}/basePlans/{basePlanId}:migratePrices", "httpMethod": "POST", "id": "androidpublisher.monetization.subscriptions.basePlans.migratePrices", @@ -4731,7 +4731,7 @@ } } }, - "revision": "20240626", + "revision": "20240814", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6299,7 +6299,7 @@ "readOnly": true }, "transactionProgramCode": { - "description": "Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field.", + "description": "Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.", "format": "int32", "type": "integer" }, @@ -7513,7 +7513,7 @@ "type": "object" }, "MultiAbi": { - "description": "Represents a list of apis.", + "description": "Represents a list of ABIs.", "id": "MultiAbi", "properties": { "abi": { @@ -7941,16 +7941,16 @@ "type": "object" }, "RegionalPriceMigrationConfig": { - "description": "Configuration for a price migration.", + "description": "Configuration for migration of a legacy price cohort.", "id": "RegionalPriceMigrationConfig", "properties": { "oldestAllowedPriceVersionTime": { - "description": "Required. The cutoff time for historical prices that subscribers can remain paying. Subscribers on prices which were available at this cutoff time or later will stay on their existing price. Subscribers on older prices will be migrated to the currently-offered price. The migrated subscribers will receive a notification that they will be paying a different price. Subscribers who do not agree to the new price will have their subscription ended at the next renewal.", + "description": "Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type.", "format": "google-datetime", "type": "string" }, "priceIncreaseType": { - "description": "Optional. The behavior the caller wants users to see when there is a price increase during migration. If left unset, the behavior defaults to PRICE_INCREASE_TYPE_OPT_IN. Note that the first opt-out price increase migration for each app must be initiated in Play Console.", + "description": "Optional. The requested type of price increase", "enum": [ "PRICE_INCREASE_TYPE_UNSPECIFIED", "PRICE_INCREASE_TYPE_OPT_IN", @@ -7958,8 +7958,8 @@ ], "enumDescriptions": [ "Unspecified state.", - "Price increase will be presented to users on an opt-in basis.", - "Price increase will be presented to users on an opt-out basis." + "Subscribers must accept the price increase or their subscription is canceled.", + "Subscribers are notified but do not have to accept the price increase. Opt-out price increases not meeting regional, frequency, and amount limits will proceed as opt-in price increase. The first opt-out price increase for each app must be initiated in the Google Play Console." ], "type": "string" }, @@ -8249,6 +8249,10 @@ "description": "Revocation context of the purchases.subscriptionsv2.revoke API.", "id": "RevocationContext", "properties": { + "fullRefund": { + "$ref": "RevocationContextFullRefund", + "description": "Optional. Used when users should be refunded the full amount of the latest order of the subscription." + }, "proratedRefund": { "$ref": "RevocationContextProratedRefund", "description": "Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription." @@ -8256,6 +8260,12 @@ }, "type": "object" }, + "RevocationContextFullRefund": { + "description": "Used to determine if the refund type in the RevocationContext is a full refund.", + "id": "RevocationContextFullRefund", + "properties": {}, + "type": "object" + }, "RevocationContextProratedRefund": { "description": "Used to determine if the refund type in the RevocationContext is a prorated refund.", "id": "RevocationContextProratedRefund", diff --git a/discovery/apikeys-v2.json b/discovery/apikeys-v2.json index 15b2ec052d..5de86b47d3 100644 --- a/discovery/apikeys-v2.json +++ b/discovery/apikeys-v2.json @@ -396,7 +396,7 @@ } } }, - "revision": "20230806", + "revision": "20240811", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { @@ -502,7 +502,7 @@ "type": "array" }, "service": { - "description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.", + "description": "The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project.", "type": "string" } }, diff --git a/discovery/apim-v1alpha.json b/discovery/apim-v1alpha.json index 32e029e485..32f7936099 100644 --- a/discovery/apim-v1alpha.json +++ b/discovery/apim-v1alpha.json @@ -174,6 +174,42 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "listApiObservationTags": { + "description": "ListApiObservationTags lists all extant tags on any observation in the given project.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listApiObservationTags", + "httpMethod": "GET", + "id": "apim.projects.locations.listApiObservationTags", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:listApiObservationTags", + "response": { + "$ref": "ListApiObservationTagsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -324,7 +360,7 @@ ] }, "list": { - "description": "ListObservationJobs gets all ObservationJobs for a given project and location", + "description": "ListObservationJobs gets all ObservationJobs for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.list", @@ -363,6 +399,34 @@ "resources": { "apiObservations": { "methods": { + "batchEditTags": { + "description": "BatchEditTagsApiObservations adds or removes Tags for ApiObservations.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations:batchEditTags", + "httpMethod": "POST", + "id": "apim.projects.locations.observationJobs.apiObservations.batchEditTags", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/apiObservations:batchEditTags", + "request": { + "$ref": "BatchEditTagsApiObservationsRequest" + }, + "response": { + "$ref": "BatchEditTagsApiObservationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "GetApiObservation retrieves a single ApiObservation by name.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}", @@ -389,7 +453,7 @@ ] }, "list": { - "description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob", + "description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.list", @@ -454,7 +518,7 @@ ] }, "list": { - "description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation", + "description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.apiOperations.list", @@ -586,7 +650,7 @@ ] }, "list": { - "description": "ListObservationSources gets all ObservationSources for a given project and location", + "description": "ListObservationSources gets all ObservationSources for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources", "httpMethod": "GET", "id": "apim.projects.locations.observationSources.list", @@ -751,7 +815,7 @@ } } }, - "revision": "20240619", + "revision": "20240717", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { @@ -856,6 +920,34 @@ }, "type": "object" }, + "BatchEditTagsApiObservationsRequest": { + "description": "Message for requesting batch edit tags for ApiObservations", + "id": "BatchEditTagsApiObservationsRequest", + "properties": { + "requests": { + "description": "Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.", + "items": { + "$ref": "EditTagsApiObservationsRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchEditTagsApiObservationsResponse": { + "description": "Message for response to edit Tags for ApiObservations", + "id": "BatchEditTagsApiObservationsResponse", + "properties": { + "apiObservations": { + "description": "ApiObservations that were changed", + "items": { + "$ref": "ApiObservation" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -868,6 +960,24 @@ "properties": {}, "type": "object" }, + "EditTagsApiObservationsRequest": { + "description": "Message for requesting edit tags for ApiObservation", + "id": "EditTagsApiObservationsRequest", + "properties": { + "apiObservationId": { + "description": "Required. Identifier of ApiObservation need to be edit tags Format example: \"apigee.googleapis.com|us-west1|443\"", + "type": "string" + }, + "tagActions": { + "description": "Required. Tag actions to be applied", + "items": { + "$ref": "TagAction" + }, + "type": "array" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1110,6 +1220,24 @@ }, "type": "object" }, + "ListApiObservationTagsResponse": { + "description": "Message for response to listing tags", + "id": "ListApiObservationTagsResponse", + "properties": { + "apiObservationTags": { + "description": "The tags from the specified project", + "items": { + "type": "string" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "ListApiObservationsResponse": { "description": "Message for response to listing ApiObservations", "id": "ListApiObservationsResponse", @@ -1472,6 +1600,31 @@ } }, "type": "object" + }, + "TagAction": { + "description": "Message for edit tag action", + "id": "TagAction", + "properties": { + "action": { + "description": "Required. Action to be applied", + "enum": [ + "ACTION_UNSPECIFIED", + "ADD", + "REMOVE" + ], + "enumDescriptions": [ + "Unspecified.", + "Addition of a Tag.", + "Removal of a Tag." + ], + "type": "string" + }, + "tag": { + "description": "Required. Tag to be added or removed", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/appengine-v1.json b/discovery/appengine-v1.json index cae3ce601a..f2c5befec5 100644 --- a/discovery/appengine-v1.json +++ b/discovery/appengine-v1.json @@ -1718,7 +1718,7 @@ } } }, - "revision": "20240422", + "revision": "20240722", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3699,7 +3699,8 @@ "type": "object" }, "id": { - "description": "Relative name of the service within the application. Example: default.@OutputOnly", + "description": "Output only. Relative name of the service within the application. Example: default.@OutputOnly", + "readOnly": true, "type": "string" }, "labels": { @@ -3710,7 +3711,8 @@ "type": "object" }, "name": { - "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", + "description": "Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", + "readOnly": true, "type": "string" }, "networkSettings": { @@ -4026,7 +4028,8 @@ "type": "string" }, "createdBy": { - "description": "Email address of the user who created this version.@OutputOnly", + "description": "Output only. Email address of the user who created this version.@OutputOnly", + "readOnly": true, "type": "string" }, "defaultExpiration": { @@ -4039,8 +4042,9 @@ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." }, "diskUsageBytes": { - "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", + "description": "Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", "format": "int64", + "readOnly": true, "type": "string" }, "endpointsApiService": { @@ -4145,7 +4149,8 @@ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as \"backends\"." }, "name": { - "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", + "description": "Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", + "readOnly": true, "type": "string" }, "network": { @@ -4203,7 +4208,8 @@ "type": "boolean" }, "versionUrl": { - "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", + "description": "Output only. Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", + "readOnly": true, "type": "string" }, "vm": { diff --git a/discovery/appengine-v1beta.json b/discovery/appengine-v1beta.json index 54efaca398..9eadfbb68d 100644 --- a/discovery/appengine-v1beta.json +++ b/discovery/appengine-v1beta.json @@ -1918,7 +1918,7 @@ } } }, - "revision": "20240422", + "revision": "20240722", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3948,7 +3948,8 @@ "type": "object" }, "id": { - "description": "Relative name of the service within the application. Example: default.@OutputOnly", + "description": "Output only. Relative name of the service within the application. Example: default.@OutputOnly", + "readOnly": true, "type": "string" }, "labels": { @@ -3959,7 +3960,8 @@ "type": "object" }, "name": { - "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", + "description": "Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", + "readOnly": true, "type": "string" }, "networkSettings": { @@ -4273,7 +4275,8 @@ "type": "string" }, "createdBy": { - "description": "Email address of the user who created this version.@OutputOnly", + "description": "Output only. Email address of the user who created this version.@OutputOnly", + "readOnly": true, "type": "string" }, "defaultExpiration": { @@ -4286,8 +4289,9 @@ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." }, "diskUsageBytes": { - "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", + "description": "Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", "format": "int64", + "readOnly": true, "type": "string" }, "endpointsApiService": { @@ -4392,7 +4396,8 @@ "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as \"backends\"." }, "name": { - "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", + "description": "Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", + "readOnly": true, "type": "string" }, "network": { @@ -4450,7 +4455,8 @@ "type": "boolean" }, "versionUrl": { - "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", + "description": "Output only. Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", + "readOnly": true, "type": "string" }, "vm": { diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index f1be1366d3..4fea17a814 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -20,219 +20,219 @@ "documentationLink": "https://cloud.google.com/artifacts/docs/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.africa-south1.rep.googleapis.com/", - "location": "africa-south1", - "description": "Regional Endpoint" + "location": "africa-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-east1.rep.googleapis.com/", - "location": "asia-east1", - "description": "Regional Endpoint" + "location": "asia-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-east2.rep.googleapis.com/", - "location": "asia-east2", - "description": "Regional Endpoint" + "location": "asia-east2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast1.rep.googleapis.com/", - "location": "asia-northeast1", - "description": "Regional Endpoint" + "location": "asia-northeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast2.rep.googleapis.com/", - "location": "asia-northeast2", - "description": "Regional Endpoint" + "location": "asia-northeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast3.rep.googleapis.com/", - "location": "asia-northeast3", - "description": "Regional Endpoint" + "location": "asia-northeast3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-south1.rep.googleapis.com/", - "location": "asia-south1", - "description": "Regional Endpoint" + "location": "asia-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-south2.rep.googleapis.com/", - "location": "asia-south2", - "description": "Regional Endpoint" + "location": "asia-south2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-southeast1.rep.googleapis.com/", - "location": "asia-southeast1", - "description": "Regional Endpoint" + "location": "asia-southeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-southeast2.rep.googleapis.com/", - "location": "asia-southeast2", - "description": "Regional Endpoint" + "location": "asia-southeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.australia-southeast1.rep.googleapis.com/", - "location": "australia-southeast1", - "description": "Regional Endpoint" + "location": "australia-southeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.australia-southeast2.rep.googleapis.com/", - "location": "australia-southeast2", - "description": "Regional Endpoint" + "location": "australia-southeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-central2.rep.googleapis.com/", - "location": "europe-central2", - "description": "Regional Endpoint" + "location": "europe-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-north1.rep.googleapis.com/", - "location": "europe-north1", - "description": "Regional Endpoint" + "location": "europe-north1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-southwest1.rep.googleapis.com/", - "location": "europe-southwest1", - "description": "Regional Endpoint" + "location": "europe-southwest1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west1.rep.googleapis.com/", - "location": "europe-west1", - "description": "Regional Endpoint" + "location": "europe-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west10.rep.googleapis.com/", - "location": "europe-west10", - "description": "Regional Endpoint" + "location": "europe-west10" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west12.rep.googleapis.com/", - "location": "europe-west12", - "description": "Regional Endpoint" + "location": "europe-west12" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west2.rep.googleapis.com/", - "location": "europe-west2", - "description": "Regional Endpoint" + "location": "europe-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west4.rep.googleapis.com/", - "location": "europe-west4", - "description": "Regional Endpoint" + "location": "europe-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west6.rep.googleapis.com/", - "location": "europe-west6", - "description": "Regional Endpoint" + "location": "europe-west6" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central1.rep.googleapis.com/", - "location": "me-central1", - "description": "Regional Endpoint" + "location": "me-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-west1.rep.googleapis.com/", - "location": "me-west1", - "description": "Regional Endpoint" + "location": "me-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.northamerica-northeast1.rep.googleapis.com/", - "location": "northamerica-northeast1", - "description": "Regional Endpoint" + "location": "northamerica-northeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.northamerica-northeast2.rep.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Regional Endpoint" + "location": "northamerica-northeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-east1.rep.googleapis.com/", - "location": "southamerica-east1", - "description": "Regional Endpoint" + "location": "southamerica-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-west1.rep.googleapis.com/", - "location": "southamerica-west1", - "description": "Regional Endpoint" + "location": "southamerica-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west8.rep.googleapis.com/", - "location": "us-west8", - "description": "Regional Endpoint" + "location": "us-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" } ], "fullyEncodeReservedExpansion": true, @@ -1637,7 +1637,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", "location": "query", "type": "string" }, @@ -2013,7 +2013,7 @@ } } }, - "revision": "20240608", + "revision": "20240724", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3351,10 +3351,21 @@ "name": { "description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set", "type": "string" + }, + "pullPercent": { + "description": "The percentage of pull traffic to redirect from GCR to AR when using partial redirection.", + "format": "int32", + "type": "integer" } }, "type": "object" }, + "PromoteArtifactMetadata": { + "description": "The metadata for promote artifact long running operation.", + "id": "PromoteArtifactMetadata", + "properties": {}, + "type": "object" + }, "PythonPackage": { "description": "PythonPackage represents a python artifact.", "id": "PythonPackage", @@ -3735,7 +3746,7 @@ "type": "string" }, "packageId": { - "description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.", + "description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters.", "type": "string" }, "versionId": { diff --git a/discovery/artifactregistry-v1beta1.json b/discovery/artifactregistry-v1beta1.json index fe67ea42a7..022718ebd7 100644 --- a/discovery/artifactregistry-v1beta1.json +++ b/discovery/artifactregistry-v1beta1.json @@ -20,219 +20,219 @@ "documentationLink": "https://cloud.google.com/artifacts/docs/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.africa-south1.rep.googleapis.com/", - "location": "africa-south1", - "description": "Regional Endpoint" + "location": "africa-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-east1.rep.googleapis.com/", - "location": "asia-east1", - "description": "Regional Endpoint" + "location": "asia-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-east2.rep.googleapis.com/", - "location": "asia-east2", - "description": "Regional Endpoint" + "location": "asia-east2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast1.rep.googleapis.com/", - "location": "asia-northeast1", - "description": "Regional Endpoint" + "location": "asia-northeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast2.rep.googleapis.com/", - "location": "asia-northeast2", - "description": "Regional Endpoint" + "location": "asia-northeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast3.rep.googleapis.com/", - "location": "asia-northeast3", - "description": "Regional Endpoint" + "location": "asia-northeast3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-south1.rep.googleapis.com/", - "location": "asia-south1", - "description": "Regional Endpoint" + "location": "asia-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-south2.rep.googleapis.com/", - "location": "asia-south2", - "description": "Regional Endpoint" + "location": "asia-south2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-southeast1.rep.googleapis.com/", - "location": "asia-southeast1", - "description": "Regional Endpoint" + "location": "asia-southeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-southeast2.rep.googleapis.com/", - "location": "asia-southeast2", - "description": "Regional Endpoint" + "location": "asia-southeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.australia-southeast1.rep.googleapis.com/", - "location": "australia-southeast1", - "description": "Regional Endpoint" + "location": "australia-southeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.australia-southeast2.rep.googleapis.com/", - "location": "australia-southeast2", - "description": "Regional Endpoint" + "location": "australia-southeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-central2.rep.googleapis.com/", - "location": "europe-central2", - "description": "Regional Endpoint" + "location": "europe-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-north1.rep.googleapis.com/", - "location": "europe-north1", - "description": "Regional Endpoint" + "location": "europe-north1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-southwest1.rep.googleapis.com/", - "location": "europe-southwest1", - "description": "Regional Endpoint" + "location": "europe-southwest1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west1.rep.googleapis.com/", - "location": "europe-west1", - "description": "Regional Endpoint" + "location": "europe-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west10.rep.googleapis.com/", - "location": "europe-west10", - "description": "Regional Endpoint" + "location": "europe-west10" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west12.rep.googleapis.com/", - "location": "europe-west12", - "description": "Regional Endpoint" + "location": "europe-west12" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west2.rep.googleapis.com/", - "location": "europe-west2", - "description": "Regional Endpoint" + "location": "europe-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west4.rep.googleapis.com/", - "location": "europe-west4", - "description": "Regional Endpoint" + "location": "europe-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west6.rep.googleapis.com/", - "location": "europe-west6", - "description": "Regional Endpoint" + "location": "europe-west6" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central1.rep.googleapis.com/", - "location": "me-central1", - "description": "Regional Endpoint" + "location": "me-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-west1.rep.googleapis.com/", - "location": "me-west1", - "description": "Regional Endpoint" + "location": "me-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.northamerica-northeast1.rep.googleapis.com/", - "location": "northamerica-northeast1", - "description": "Regional Endpoint" + "location": "northamerica-northeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.northamerica-northeast2.rep.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Regional Endpoint" + "location": "northamerica-northeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-east1.rep.googleapis.com/", - "location": "southamerica-east1", - "description": "Regional Endpoint" + "location": "southamerica-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-west1.rep.googleapis.com/", - "location": "southamerica-west1", - "description": "Regional Endpoint" + "location": "southamerica-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west8.rep.googleapis.com/", - "location": "us-west8", - "description": "Regional Endpoint" + "location": "us-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" } ], "fullyEncodeReservedExpansion": true, @@ -937,7 +937,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", "location": "query", "type": "string" }, @@ -1146,7 +1146,7 @@ } } }, - "revision": "20240608", + "revision": "20240724", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/artifactregistry-v1beta2.json b/discovery/artifactregistry-v1beta2.json index 3fe6890623..05bc420988 100644 --- a/discovery/artifactregistry-v1beta2.json +++ b/discovery/artifactregistry-v1beta2.json @@ -20,219 +20,219 @@ "documentationLink": "https://cloud.google.com/artifacts/docs/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.africa-south1.rep.googleapis.com/", - "location": "africa-south1", - "description": "Regional Endpoint" + "location": "africa-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-east1.rep.googleapis.com/", - "location": "asia-east1", - "description": "Regional Endpoint" + "location": "asia-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-east2.rep.googleapis.com/", - "location": "asia-east2", - "description": "Regional Endpoint" + "location": "asia-east2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast1.rep.googleapis.com/", - "location": "asia-northeast1", - "description": "Regional Endpoint" + "location": "asia-northeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast2.rep.googleapis.com/", - "location": "asia-northeast2", - "description": "Regional Endpoint" + "location": "asia-northeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-northeast3.rep.googleapis.com/", - "location": "asia-northeast3", - "description": "Regional Endpoint" + "location": "asia-northeast3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-south1.rep.googleapis.com/", - "location": "asia-south1", - "description": "Regional Endpoint" + "location": "asia-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-south2.rep.googleapis.com/", - "location": "asia-south2", - "description": "Regional Endpoint" + "location": "asia-south2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-southeast1.rep.googleapis.com/", - "location": "asia-southeast1", - "description": "Regional Endpoint" + "location": "asia-southeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.asia-southeast2.rep.googleapis.com/", - "location": "asia-southeast2", - "description": "Regional Endpoint" + "location": "asia-southeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.australia-southeast1.rep.googleapis.com/", - "location": "australia-southeast1", - "description": "Regional Endpoint" + "location": "australia-southeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.australia-southeast2.rep.googleapis.com/", - "location": "australia-southeast2", - "description": "Regional Endpoint" + "location": "australia-southeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-central2.rep.googleapis.com/", - "location": "europe-central2", - "description": "Regional Endpoint" + "location": "europe-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-north1.rep.googleapis.com/", - "location": "europe-north1", - "description": "Regional Endpoint" + "location": "europe-north1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-southwest1.rep.googleapis.com/", - "location": "europe-southwest1", - "description": "Regional Endpoint" + "location": "europe-southwest1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west1.rep.googleapis.com/", - "location": "europe-west1", - "description": "Regional Endpoint" + "location": "europe-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west10.rep.googleapis.com/", - "location": "europe-west10", - "description": "Regional Endpoint" + "location": "europe-west10" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west12.rep.googleapis.com/", - "location": "europe-west12", - "description": "Regional Endpoint" + "location": "europe-west12" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west2.rep.googleapis.com/", - "location": "europe-west2", - "description": "Regional Endpoint" + "location": "europe-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west4.rep.googleapis.com/", - "location": "europe-west4", - "description": "Regional Endpoint" + "location": "europe-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west6.rep.googleapis.com/", - "location": "europe-west6", - "description": "Regional Endpoint" + "location": "europe-west6" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central1.rep.googleapis.com/", - "location": "me-central1", - "description": "Regional Endpoint" + "location": "me-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-west1.rep.googleapis.com/", - "location": "me-west1", - "description": "Regional Endpoint" + "location": "me-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.northamerica-northeast1.rep.googleapis.com/", - "location": "northamerica-northeast1", - "description": "Regional Endpoint" + "location": "northamerica-northeast1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.northamerica-northeast2.rep.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Regional Endpoint" + "location": "northamerica-northeast2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-east1.rep.googleapis.com/", - "location": "southamerica-east1", - "description": "Regional Endpoint" + "location": "southamerica-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.southamerica-west1.rep.googleapis.com/", - "location": "southamerica-west1", - "description": "Regional Endpoint" + "location": "southamerica-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.us-west8.rep.googleapis.com/", - "location": "us-west8", - "description": "Regional Endpoint" + "location": "us-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" } ], "fullyEncodeReservedExpansion": true, @@ -1133,7 +1133,7 @@ ], "parameters": { "filter": { - "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", + "description": "An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0\"` --> Tags that are applied to the version `1.0` in package `pkg1`.", "location": "query", "type": "string" }, @@ -1414,7 +1414,7 @@ } } }, - "revision": "20240608", + "revision": "20240724", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2028,6 +2028,11 @@ "name": { "description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set", "type": "string" + }, + "pullPercent": { + "description": "The percentage of pull traffic to redirect from GCR to AR when using partial redirection.", + "format": "int32", + "type": "integer" } }, "type": "object" diff --git a/discovery/assuredworkloads-v1.json b/discovery/assuredworkloads-v1.json index 522a6dd8c4..fdc861d2b5 100644 --- a/discovery/assuredworkloads-v1.json +++ b/discovery/assuredworkloads-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240621", + "revision": "20240801", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -683,25 +683,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -712,26 +706,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", - "Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", - "Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", - "Assured Workloads for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1178,25 +1166,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1207,26 +1189,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", - "Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", - "Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", - "Assured Workloads for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1464,6 +1440,10 @@ "description": "Permissions granted to the AW Partner SA account for the customer workload", "id": "GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions", "properties": { + "accessTransparencyLogsSupportCaseViewer": { + "description": "Optional. Allow partner to view support case details for an AXT log", + "type": "boolean" + }, "assuredWorkloadsMonitoring": { "description": "Optional. Allow partner to view violation alerts.", "type": "boolean" diff --git a/discovery/assuredworkloads-v1beta1.json b/discovery/assuredworkloads-v1beta1.json index 975fbf4ff2..23056594c5 100644 --- a/discovery/assuredworkloads-v1beta1.json +++ b/discovery/assuredworkloads-v1beta1.json @@ -588,7 +588,7 @@ } } }, - "revision": "20240627", + "revision": "20240801", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -680,25 +680,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -709,26 +703,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", - "Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", - "Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", - "Assured Workloads for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1173,25 +1161,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", - "REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", - "REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", - "REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1202,26 +1184,20 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", - "Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For EU Regions and Support controls", - "Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", - "Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", - "Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", - "Assured Workloads for Japan Regions", - "KSA R5 Controls.", + "Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1527,6 +1503,10 @@ "description": "Permissions granted to the AW Partner SA account for the customer workload", "id": "GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions", "properties": { + "accessTransparencyLogsSupportCaseViewer": { + "description": "Optional. Allow partner to view support case details for an AXT log", + "type": "boolean" + }, "assuredWorkloadsMonitoring": { "description": "Optional. Allow partner to view violation alerts.", "type": "boolean" diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json new file mode 100644 index 0000000000..8b2b87d698 --- /dev/null +++ b/discovery/authorizedbuyersmarketplace-v1alpha.json @@ -0,0 +1,3513 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/authorized-buyers-marketplace": { + "description": "See, create, edit, and delete your Authorized Buyers Marketplace entities." + } + } + } + }, + "basePath": "", + "baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Authorized Buyers Marketplace", + "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", + "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": "authorizedbuyersmarketplace:v1alpha", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/", + "name": "authorizedbuyersmarketplace", + "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": { + "bidders": { + "resources": { + "auctionPackages": { + "methods": { + "list": { + "description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", + "flatPath": "v1alpha/bidders/{biddersId}/auctionPackages", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.bidders.auctionPackages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", + "location": "path", + "pattern": "^bidders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/auctionPackages", + "response": { + "$ref": "ListAuctionPackagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + }, + "finalizedDeals": { + "methods": { + "list": { + "description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", + "flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.bidders.finalizedDeals.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned from ListFinalizedDealsResponse.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", + "location": "path", + "pattern": "^bidders/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/finalizedDeals", + "response": { + "$ref": "ListFinalizedDealsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + } + } + }, + "buyers": { + "resources": { + "auctionPackages": { + "methods": { + "get": { + "description": "Gets an auction package given its name.", + "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.auctionPackages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", + "location": "path", + "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "AuctionPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", + "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.auctionPackages.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/auctionPackages", + "response": { + "$ref": "ListAuctionPackagesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "subscribe": { + "description": "Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.", + "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribe", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", + "location": "path", + "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:subscribe", + "request": { + "$ref": "SubscribeAuctionPackageRequest" + }, + "response": { + "$ref": "AuctionPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "subscribeClients": { + "description": "Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.", + "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients", + "parameterOrder": [ + "auctionPackage" + ], + "parameters": { + "auctionPackage": { + "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", + "location": "path", + "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+auctionPackage}:subscribeClients", + "request": { + "$ref": "SubscribeClientsRequest" + }, + "response": { + "$ref": "AuctionPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "unsubscribe": { + "description": "Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.", + "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", + "location": "path", + "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:unsubscribe", + "request": { + "$ref": "UnsubscribeAuctionPackageRequest" + }, + "response": { + "$ref": "AuctionPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "unsubscribeClients": { + "description": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.", + "flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients", + "parameterOrder": [ + "auctionPackage" + ], + "parameters": { + "auctionPackage": { + "description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", + "location": "path", + "pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+auctionPackage}:unsubscribeClients", + "request": { + "$ref": "UnsubscribeClientsRequest" + }, + "response": { + "$ref": "AuctionPackage" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + }, + "clients": { + "methods": { + "activate": { + "description": "Activates an existing client. The state of the client will be updated to \"ACTIVE\". This method has no effect if the client is already in \"ACTIVE\" state.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:activate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.clients.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:activate", + "request": { + "$ref": "ActivateClientRequest" + }, + "response": { + "$ref": "Client" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "create": { + "description": "Creates a new client.", + "flatPath": "v1alpha/buyers/{buyersId}/clients", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.clients.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the buyer. Format: `buyers/{accountId}`", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/clients", + "request": { + "$ref": "Client" + }, + "response": { + "$ref": "Client" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "deactivate": { + "description": "Deactivates an existing client. The state of the client will be updated to \"INACTIVE\". This method has no effect if the client is already in \"INACTIVE\" state.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:deactivate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.clients.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:deactivate", + "request": { + "$ref": "DeactivateClientRequest" + }, + "response": { + "$ref": "Client" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a client with a given resource name.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.clients.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{accountId}/clients/{clientAccountId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Client" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists all the clients for the current buyer.", + "flatPath": "v1alpha/buyers/{buyersId}/clients", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.clients.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is \"1234\", the value of this field should be `partnerClientId = \"1234\"`, in order to get only the client whose partnerClientId is \"1234\" in the response.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. If left blank, a default page size of 500 will be applied.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the buyer. Format: `buyers/{accountId}`", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/clients", + "response": { + "$ref": "ListClientsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "patch": { + "description": "Updates an existing client.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", + "httpMethod": "PATCH", + "id": "authorizedbuyersmarketplace.buyers.clients.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "Client" + }, + "response": { + "$ref": "Client" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + }, + "resources": { + "users": { + "methods": { + "activate": { + "description": "Activates an existing client user. The state of the client user will be updated from \"INACTIVE\" to \"ACTIVE\". This method has no effect if the client user is already in \"ACTIVE\" state. An error will be returned if the client user to activate is still in \"INVITED\" state.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.clients.users.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:activate", + "request": { + "$ref": "ActivateClientUserRequest" + }, + "response": { + "$ref": "ClientUser" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "create": { + "description": "Creates a new client user in \"INVITED\" state. An email invitation will be sent to the new user, once accepted the user will become active.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.clients.users.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/users", + "request": { + "$ref": "ClientUser" + }, + "response": { + "$ref": "ClientUser" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "deactivate": { + "description": "Deactivates an existing client user. The state of the client user will be updated from \"ACTIVE\" to \"INACTIVE\". This method has no effect if the client user is already in \"INACTIVE\" state. An error will be returned if the client user to deactivate is still in \"INVITED\" state.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.clients.users.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:deactivate", + "request": { + "$ref": "DeactivateClientUserRequest" + }, + "response": { + "$ref": "ClientUser" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "delete": { + "description": "Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", + "httpMethod": "DELETE", + "id": "authorizedbuyersmarketplace.buyers.clients.users.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Retrieves an existing client user.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.clients.users.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "ClientUser" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists all client users for a specified client.", + "flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.clients.users.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Requested page size. If left blank, a default page size of 500 will be applied.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", + "location": "path", + "pattern": "^buyers/[^/]+/clients/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/users", + "response": { + "$ref": "ListClientUsersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + } + } + }, + "dataSegments": { + "methods": { + "activate": { + "description": "Activates a data segment.", + "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:activate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.dataSegments.activate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", + "location": "path", + "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:activate", + "request": { + "$ref": "ActivateDataSegmentRequest" + }, + "response": { + "$ref": "DataSegment" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "create": { + "description": "Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.", + "flatPath": "v1alpha/buyers/{buyersId}/dataSegments", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.dataSegments.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}`", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/dataSegments", + "request": { + "$ref": "DataSegment" + }, + "response": { + "$ref": "DataSegment" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "deactivate": { + "description": "Deactivates a data segment.", + "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:deactivate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.dataSegments.deactivate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", + "location": "path", + "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:deactivate", + "request": { + "$ref": "DeactivateDataSegmentRequest" + }, + "response": { + "$ref": "DataSegment" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a data segment given its name.", + "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.dataSegments.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", + "location": "path", + "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "DataSegment" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "List the data segments owned by a curator.", + "flatPath": "v1alpha/buyers/{buyersId}/dataSegments", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.dataSegments.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}`", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/dataSegments", + "response": { + "$ref": "ListDataSegmentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "patch": { + "description": "Updates a data segment.", + "flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", + "httpMethod": "PATCH", + "id": "authorizedbuyersmarketplace.buyers.dataSegments.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", + "location": "path", + "pattern": "^buyers/[^/]+/dataSegments/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "DataSegment" + }, + "response": { + "$ref": "DataSegment" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + }, + "finalizedDeals": { + "methods": { + "addCreative": { + "description": "Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.", + "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative", + "parameterOrder": [ + "deal" + ], + "parameters": { + "deal": { + "description": "Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+deal}:addCreative", + "request": { + "$ref": "AddCreativeRequest" + }, + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a finalized deal given its name.", + "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", + "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned from ListFinalizedDealsResponse.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/finalizedDeals", + "response": { + "$ref": "ListFinalizedDealsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "pause": { + "description": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.", + "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:pause", + "request": { + "$ref": "PauseFinalizedDealRequest" + }, + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "resume": { + "description": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.", + "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:resume", + "request": { + "$ref": "ResumeFinalizedDealRequest" + }, + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "setReadyToServe": { + "description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.", + "flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", + "parameterOrder": [ + "deal" + ], + "parameters": { + "deal": { + "description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", + "location": "path", + "pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+deal}:setReadyToServe", + "request": { + "$ref": "SetReadyToServeRequest" + }, + "response": { + "$ref": "FinalizedDeal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + }, + "proposals": { + "methods": { + "accept": { + "description": "Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:accept", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.proposals.accept", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}:accept", + "request": { + "$ref": "AcceptProposalRequest" + }, + "response": { + "$ref": "Proposal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "addNote": { + "description": "Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:addNote", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.proposals.addNote", + "parameterOrder": [ + "proposal" + ], + "parameters": { + "proposal": { + "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+proposal}:addNote", + "request": { + "$ref": "AddNoteRequest" + }, + "response": { + "$ref": "Proposal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "cancelNegotiation": { + "description": "Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation", + "parameterOrder": [ + "proposal" + ], + "parameters": { + "proposal": { + "description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+proposal}:cancelNegotiation", + "request": { + "$ref": "CancelNegotiationRequest" + }, + "response": { + "$ref": "Proposal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a proposal using its resource name. The proposal is returned at the latest revision.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.proposals.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Proposal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.proposals.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned from ListProposalsResponse.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent that owns the collection of proposals Format: `buyers/{accountId}`", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/proposals", + "response": { + "$ref": "ListProposalsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "patch": { + "description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", + "httpMethod": "PATCH", + "id": "authorizedbuyersmarketplace.buyers.proposals.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "Proposal" + }, + "response": { + "$ref": "Proposal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "sendRfp": { + "description": "Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals:sendRfp", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.proposals.sendRfp", + "parameterOrder": [ + "buyer" + ], + "parameters": { + "buyer": { + "description": "Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`.", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+buyer}/proposals:sendRfp", + "request": { + "$ref": "SendRfpRequest" + }, + "response": { + "$ref": "Proposal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + }, + "resources": { + "deals": { + "methods": { + "batchUpdate": { + "description": "Batch updates multiple deals in the same proposal.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals:batchUpdate", + "httpMethod": "POST", + "id": "authorizedbuyersmarketplace.buyers.proposals.deals.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/deals:batchUpdate", + "request": { + "$ref": "BatchUpdateDealsRequest" + }, + "response": { + "$ref": "BatchUpdateDealsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "get": { + "description": "Gets a deal given its name. The deal is returned at its head revision.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.proposals.deals.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "Deal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.proposals.deals.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned from ListDealsResponse.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/deals", + "response": { + "$ref": "ListDealsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "patch": { + "description": "Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.", + "flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", + "httpMethod": "PATCH", + "id": "authorizedbuyersmarketplace.buyers.proposals.deals.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", + "location": "path", + "pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "Deal" + }, + "response": { + "$ref": "Deal" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + } + } + }, + "publisherProfiles": { + "methods": { + "get": { + "description": "Gets the requested publisher profile by name.", + "flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles/{publisherProfilesId}", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.publisherProfiles.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`", + "location": "path", + "pattern": "^buyers/[^/]+/publisherProfiles/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "PublisherProfile" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + }, + "list": { + "description": "Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.", + "flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles", + "httpMethod": "GET", + "id": "authorizedbuyersmarketplace.buyers.publisherProfiles.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The page token as returned from a previous ListPublisherProfilesResponse.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}`", + "location": "path", + "pattern": "^buyers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/publisherProfiles", + "response": { + "$ref": "ListPublisherProfilesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/authorized-buyers-marketplace" + ] + } + } + } + } + } + }, + "revision": "20240718", + "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", + "schemas": { + "AcceptProposalRequest": { + "description": "Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.", + "id": "AcceptProposalRequest", + "properties": { + "proposalRevision": { + "description": "The last known client revision number of the proposal.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ActivateClientRequest": { + "description": "Request message for activating a client.", + "id": "ActivateClientRequest", + "properties": {}, + "type": "object" + }, + "ActivateClientUserRequest": { + "description": "Request message for activating a client user.", + "id": "ActivateClientUserRequest", + "properties": {}, + "type": "object" + }, + "ActivateDataSegmentRequest": { + "description": "Request message for activating a data segment", + "id": "ActivateDataSegmentRequest", + "properties": {}, + "type": "object" + }, + "AdSize": { + "description": "Represents size of a single ad slot, or a creative.", + "id": "AdSize", + "properties": { + "height": { + "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", + "format": "int64", + "type": "string" + }, + "type": { + "description": "The type of the ad slot size.", + "enum": [ + "TYPE_UNSPECIFIED", + "PIXEL", + "INTERSTITIAL", + "NATIVE", + "FLUID" + ], + "enumDescriptions": [ + "A placeholder for an undefined size type.", + "Ad slot with size specified by height and width in pixels.", + "Special size to describe an interstitial ad slot.", + "Native (mobile) ads rendered by the publisher.", + "Fluid size (responsive size) can be resized automatically with the change of outside environment." + ], + "type": "string" + }, + "width": { + "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AddCreativeRequest": { + "description": "Request message for adding creative to be used in the bidding process for the finalized deal.", + "id": "AddCreativeRequest", + "properties": { + "creative": { + "description": "Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.", + "type": "string" + } + }, + "type": "object" + }, + "AddNoteRequest": { + "description": "Request to add a note.", + "id": "AddNoteRequest", + "properties": { + "note": { + "$ref": "Note", + "description": "The note to add." + } + }, + "type": "object" + }, + "AuctionPackage": { + "description": "Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.", + "id": "AuctionPackage", + "properties": { + "createTime": { + "description": "Output only. Time the auction package was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creator": { + "description": "Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. A description of the auction package.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display_name assigned to the auction package.", + "type": "string" + }, + "eligibleSeatIds": { + "description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.", + "type": "string" + }, + "subscribedBuyers": { + "description": "Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "subscribedClients": { + "description": "Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "subscribedMediaPlanners": { + "description": "Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.", + "items": { + "$ref": "MediaPlanner" + }, + "readOnly": true, + "type": "array" + }, + "updateTime": { + "description": "Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BatchUpdateDealsRequest": { + "description": "Request message for batch updating deals.", + "id": "BatchUpdateDealsRequest", + "properties": { + "requests": { + "description": "Required. List of request messages to update deals.", + "items": { + "$ref": "UpdateDealRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchUpdateDealsResponse": { + "description": "Response message for batch updating deals.", + "id": "BatchUpdateDealsResponse", + "properties": { + "deals": { + "description": "Deals updated.", + "items": { + "$ref": "Deal" + }, + "type": "array" + } + }, + "type": "object" + }, + "CancelNegotiationRequest": { + "description": "Request to cancel an ongoing negotiation.", + "id": "CancelNegotiationRequest", + "properties": {}, + "type": "object" + }, + "Client": { + "description": "A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.", + "id": "Client", + "properties": { + "displayName": { + "description": "Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", + "readOnly": true, + "type": "string" + }, + "partnerClientId": { + "description": "Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.", + "type": "string" + }, + "role": { + "description": "Required. The role assigned to the client. Each role implies a set of permissions granted to the client.", + "enum": [ + "CLIENT_ROLE_UNSPECIFIED", + "CLIENT_DEAL_VIEWER", + "CLIENT_DEAL_NEGOTIATOR", + "CLIENT_DEAL_APPROVER" + ], + "enumDescriptions": [ + "A placeholder for an undefined client role. This value should never be specified in user input for create or update method, otherwise an error will be returned.", + "Users associated with this client role can only view proposals and deals in the Marketplace UI. They cannot negotiate or approve proposals and deals sent from publishers or send RFP to publishers.", + "Users associated with this client role can view and negotiate on the proposals and deals in the Marketplace UI sent from publishers and send RFP to publishers, but cannot approve the proposals and deals by themselves. The buyer can approve the proposals and deals on behalf of the client.", + "Users associated with this client role can view, negotiate and approve proposals and deals in the Marketplace UI and send RFP to publishers." + ], + "type": "string" + }, + "sellerVisible": { + "description": "Whether the client will be visible to sellers.", + "type": "boolean" + }, + "state": { + "description": "Output only. The state of the client.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "A placeholder for an undefined client state. Should not be used.", + "A client that is currently active and allowed to access the Authorized Buyers UI.", + "A client that is currently inactive and not allowed to access the Authorized Buyers UI." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ClientUser": { + "description": "A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.", + "id": "ClientUser", + "properties": { + "email": { + "description": "Required. The client user's email address that has to be unique across all users for the same client.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the client user.", + "enum": [ + "STATE_UNSPECIFIED", + "INVITED", + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "A placeholder for an undefined user state.", + "A user who was created but hasn't accepted the invitation yet, not allowed to access the Authorized Buyers UI.", + "A user that is currently active and allowed to access the Authorized Buyers UI.", + "A user that is currently inactive and not allowed to access the Authorized Buyers UI." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Contact": { + "description": "Contains information on how a buyer or seller can be reached.", + "id": "Contact", + "properties": { + "displayName": { + "description": "The display_name of the contact.", + "type": "string" + }, + "email": { + "description": "Email address for the contact.", + "type": "string" + } + }, + "type": "object" + }, + "CreativeRequirements": { + "description": "Message captures data about the creatives in the deal.", + "id": "CreativeRequirements", + "properties": { + "creativeFormat": { + "description": "Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.", + "enum": [ + "CREATIVE_FORMAT_UNSPECIFIED", + "DISPLAY", + "VIDEO", + "AUDIO" + ], + "enumDescriptions": [ + "A placeholder for an unspecified creative format.", + "Banner creatives such as image or HTML5 assets.", + "Video creatives that can be played in a video player.", + "Audio creatives that can play during audio content or point to a third party ad server." + ], + "readOnly": true, + "type": "string" + }, + "creativePreApprovalPolicy": { + "description": "Output only. Specifies the creative pre-approval policy.", + "enum": [ + "CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED", + "SELLER_PRE_APPROVAL_REQUIRED", + "SELLER_PRE_APPROVAL_NOT_REQUIRED" + ], + "enumDescriptions": [ + "A placeholder for an undefined creative pre-approval policy.", + "The seller needs to approve each creative before it can serve.", + "The seller does not need to approve each creative before it can serve." + ], + "readOnly": true, + "type": "string" + }, + "creativeSafeFrameCompatibility": { + "description": "Output only. Specifies whether the creative is safeFrame compatible.", + "enum": [ + "CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED", + "COMPATIBLE", + "INCOMPATIBLE" + ], + "enumDescriptions": [ + "A placeholder for an undefined creative safe-frame compatibility.", + "The creatives need to be compatible with the safe frame option.", + "The creatives can be incompatible with the safe frame option." + ], + "readOnly": true, + "type": "string" + }, + "maxAdDurationMs": { + "description": "Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "programmaticCreativeSource": { + "description": "Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.", + "enum": [ + "PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", + "ADVERTISER", + "PUBLISHER" + ], + "enumDescriptions": [ + "A placeholder for an undefined programmatic creative source.", + "The advertiser provides the creatives.", + "The publisher provides the creatives to be served." + ], + "readOnly": true, + "type": "string" + }, + "skippableAdType": { + "description": "Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.", + "enum": [ + "SKIPPABLE_AD_TYPE_UNSPECIFIED", + "SKIPPABLE", + "INSTREAM_SELECT", + "NOT_SKIPPABLE", + "ANY" + ], + "enumDescriptions": [ + "A placeholder for an unspecified skippable ad type.", + "Video ad that can be skipped after 5 seconds. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", + "Video ad that can be skipped after 5 seconds, and is counted as engaged view after 30 seconds. The creative is hosted on YouTube only, and viewcount of the YouTube video increments after the engaged view. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", + "This video ad is not skippable. This value will appear in RTB bid requests as SkippableBidRequestType::BLOCK_SKIPPABLE.", + "This video ad can be skipped after 5 seconds or not-skippable. This value will appear in RTB bid requests as SkippableBidRequestType::ALLOW_SKIPPABLE." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CriteriaTargeting": { + "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.", + "id": "CriteriaTargeting", + "properties": { + "excludedCriteriaIds": { + "description": "A list of numeric IDs to be excluded.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "targetedCriteriaIds": { + "description": "A list of numeric IDs to be included.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DataSegment": { + "description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", + "id": "DataSegment", + "properties": { + "cpmFee": { + "$ref": "Money", + "description": "Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package." + }, + "createTime": { + "description": "Output only. Time the data segment was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", + "type": "string" + }, + "state": { + "description": "Output only. The state of the data segment.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "INACTIVE" + ], + "enumDescriptions": [ + "Default value.", + "The data segment is active.", + "The data segment is inactive." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Time the data segment was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DayPart": { + "description": "Defines targeting for a period of time on a specific week day.", + "id": "DayPart", + "properties": { + "dayOfWeek": { + "description": "Day of week for the period.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "endTime": { + "$ref": "TimeOfDay", + "description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored." + }, + "startTime": { + "$ref": "TimeOfDay", + "description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored." + } + }, + "type": "object" + }, + "DayPartTargeting": { + "description": "Represents Daypart targeting.", + "id": "DayPartTargeting", + "properties": { + "dayParts": { + "description": "The targeted weekdays and times", + "items": { + "$ref": "DayPart" + }, + "type": "array" + }, + "timeZoneType": { + "description": "The time zone type of the day parts", + "enum": [ + "TIME_ZONE_TYPE_UNSPECIFIED", + "SELLER", + "USER" + ], + "enumDescriptions": [ + "Default value. This field is unused.", + "The publisher's time zone", + "The user's time zone" + ], + "type": "string" + } + }, + "type": "object" + }, + "DeactivateClientRequest": { + "description": "Request message for disabling a client.", + "id": "DeactivateClientRequest", + "properties": {}, + "type": "object" + }, + "DeactivateClientUserRequest": { + "description": "Request message for deactivating a client user.", + "id": "DeactivateClientUserRequest", + "properties": {}, + "type": "object" + }, + "DeactivateDataSegmentRequest": { + "description": "Request message for deactivating a data segment", + "id": "DeactivateDataSegmentRequest", + "properties": {}, + "type": "object" + }, + "Deal": { + "description": "A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.", + "id": "Deal", + "properties": { + "billedBuyer": { + "description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`", + "readOnly": true, + "type": "string" + }, + "buyer": { + "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`", + "readOnly": true, + "type": "string" + }, + "client": { + "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time of the deal creation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creativeRequirements": { + "$ref": "CreativeRequirements", + "description": "Output only. Metadata about the creatives of this deal.", + "readOnly": true + }, + "dealType": { + "description": "Output only. Type of deal.", + "enum": [ + "DEAL_TYPE_UNSPECIFIED", + "PREFERRED_DEAL", + "PRIVATE_AUCTION", + "PROGRAMMATIC_GUARANTEED" + ], + "enumDescriptions": [ + "Default, unspecified deal type.", + "Preferred deals.", + "Private auction deals.", + "Programmatic guaranteed deals." + ], + "readOnly": true, + "type": "string" + }, + "deliveryControl": { + "$ref": "DeliveryControl", + "description": "Output only. Specifies the pacing set by the publisher.", + "readOnly": true + }, + "description": { + "description": "Output only. Free text description for the deal terms.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.", + "readOnly": true, + "type": "string" + }, + "eligibleSeatIds": { + "description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "estimatedGrossSpend": { + "$ref": "Money", + "description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." + }, + "flightEndTime": { + "description": "Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.", + "format": "google-datetime", + "type": "string" + }, + "flightStartTime": { + "description": "Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.", + "format": "google-datetime", + "type": "string" + }, + "mediaPlanner": { + "$ref": "MediaPlanner", + "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).", + "readOnly": true + }, + "name": { + "description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", + "type": "string" + }, + "preferredDealTerms": { + "$ref": "PreferredDealTerms", + "description": "The terms for preferred deals." + }, + "privateAuctionTerms": { + "$ref": "PrivateAuctionTerms", + "description": "The terms for private auction deals." + }, + "programmaticGuaranteedTerms": { + "$ref": "ProgrammaticGuaranteedTerms", + "description": "The terms for programmatic guaranteed deals." + }, + "proposalRevision": { + "description": "Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "publisherProfile": { + "description": "Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`", + "type": "string" + }, + "sellerTimeZone": { + "$ref": "TimeZone", + "description": "Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.", + "readOnly": true + }, + "targeting": { + "$ref": "MarketplaceTargeting", + "description": "Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized." + }, + "updateTime": { + "description": "Output only. The time when the deal was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DealPausingInfo": { + "description": "Information related to deal pausing.", + "id": "DealPausingInfo", + "properties": { + "pauseReason": { + "description": "The reason for the pausing of the deal; empty for active deals.", + "type": "string" + }, + "pauseRole": { + "description": "The party that first paused the deal; unspecified for active deals.", + "enum": [ + "BUYER_SELLER_ROLE_UNSPECIFIED", + "BUYER", + "SELLER" + ], + "enumDescriptions": [ + "A placeholder for an undefined buyer/seller role.", + "Specifies the role as buyer.", + "Specifies the role as seller." + ], + "type": "string" + }, + "pausingConsented": { + "description": "Whether pausing is consented between buyer and seller for the deal.", + "type": "boolean" + } + }, + "type": "object" + }, + "DeliveryControl": { + "description": "Message contains details about how the deal will be paced.", + "id": "DeliveryControl", + "properties": { + "companionDeliveryType": { + "description": "Output only. Specifies roadblocking in a main companion lineitem.", + "enum": [ + "COMPANION_DELIVERY_TYPE_UNSPECIFIED", + "DELIVERY_OPTIONAL", + "DELIVERY_AT_LEAST_ONE", + "DELIVERY_ALL" + ], + "enumDescriptions": [ + "A placeholder for an unspecified companion delivery type.", + "Companions are not required to serve a creative set. The creative set can serve an inventory that has zero or more matching companions.", + "At least one companion must be served in order for the creative set to be used.", + "All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled." + ], + "readOnly": true, + "type": "string" + }, + "creativeRotationType": { + "description": "Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.", + "enum": [ + "CREATIVE_ROTATION_TYPE_UNSPECIFIED", + "ROTATION_EVEN", + "ROTATION_OPTIMIZED", + "ROTATION_MANUAL", + "ROTATION_SEQUENTIAL" + ], + "enumDescriptions": [ + "Creatives are displayed roughly the same number of times over the duration of the deal.", + "Creatives are displayed roughly the same number of times over the duration of the deal.", + "Creatives are served roughly proportionally to their performance.", + "Creatives are served roughly proportionally to their weights.", + "Creatives are served exactly in sequential order, also known as Storyboarding." + ], + "readOnly": true, + "type": "string" + }, + "deliveryRateType": { + "description": "Output only. Specifies how the impression delivery will be paced.", + "enum": [ + "DELIVERY_RATE_TYPE_UNSPECIFIED", + "EVENLY", + "FRONT_LOADED", + "AS_FAST_AS_POSSIBLE" + ], + "enumDescriptions": [ + "A placeholder for an undefined delivery rate type.", + "Impressions are served uniformly over the life of the deal.", + "Impressions are served front-loaded.", + "Impressions are served as fast as possible." + ], + "readOnly": true, + "type": "string" + }, + "frequencyCap": { + "description": "Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.", + "items": { + "$ref": "FrequencyCap" + }, + "readOnly": true, + "type": "array" + }, + "roadblockingType": { + "description": "Output only. Specifies the roadblocking type in display creatives.", + "enum": [ + "ROADBLOCKING_TYPE_UNSPECIFIED", + "ONLY_ONE", + "ONE_OR_MORE", + "AS_MANY_AS_POSSIBLE", + "ALL_ROADBLOCK", + "CREATIVE_SET" + ], + "enumDescriptions": [ + "A placeholder for an unspecified roadblocking type.", + "Only one creative from a deal can serve per ad request. https://support.google.com/admanager/answer/177277.", + "Any number of creatives from a deal can serve together per ad request.", + "As many creatives from a deal as can fit on a page will serve. This could mean anywhere from one to all of a deal's creatives given the size constraints of ad slots on a page.", + "All or none of the creatives from a deal will serve.", + "A main/companion creative set roadblocking type." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "FinalizedDeal": { + "description": "A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.", + "id": "FinalizedDeal", + "properties": { + "deal": { + "$ref": "Deal", + "description": "A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated." + }, + "dealPausingInfo": { + "$ref": "DealPausingInfo", + "description": "Information related to deal pausing for the deal." + }, + "dealServingStatus": { + "description": "Serving status of the deal.", + "enum": [ + "DEAL_SERVING_STATUS_UNSPECIFIED", + "ACTIVE", + "ENDED", + "PAUSED_BY_BUYER", + "PAUSED_BY_SELLER" + ], + "enumDescriptions": [ + "Unspecified.", + "The deal is actively serving or ready to serve when the start date is reached.", + "The deal serving has ended.", + "The deal serving is paused by buyer.", + "The deal serving is paused by seller." + ], + "type": "string" + }, + "name": { + "description": "The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`", + "type": "string" + }, + "readyToServe": { + "description": "Whether the Programmatic Guaranteed deal is ready for serving.", + "type": "boolean" + }, + "rtbMetrics": { + "$ref": "RtbMetrics", + "description": "Real-time bidding metrics for this deal." + } + }, + "type": "object" + }, + "FirstPartyMobileApplicationTargeting": { + "description": "Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.", + "id": "FirstPartyMobileApplicationTargeting", + "properties": { + "excludedAppIds": { + "description": "A list of application IDs to be excluded.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetedAppIds": { + "description": "A list of application IDs to be included.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "FrequencyCap": { + "description": "Message contains details about publisher-set frequency caps of the delivery.", + "id": "FrequencyCap", + "properties": { + "maxImpressions": { + "description": "The maximum number of impressions that can be served to a user within the specified time period.", + "format": "int32", + "type": "integer" + }, + "timeUnitType": { + "description": "The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.", + "enum": [ + "TIME_UNIT_TYPE_UNSPECIFIED", + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "LIFETIME", + "POD", + "STREAM" + ], + "enumDescriptions": [ + "A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.", + "Minute unit.", + "Hour unit.", + "Day unit.", + "Week unit.", + "Month unit.", + "Lifecycle/Lifetime unit.", + "Pod unit.", + "Stream unit." + ], + "type": "string" + }, + "timeUnitsCount": { + "description": "The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InventorySizeTargeting": { + "description": "Represents the size of an ad unit that can be targeted on a bid request.", + "id": "InventorySizeTargeting", + "properties": { + "excludedInventorySizes": { + "description": "A list of inventory sizes to be excluded.", + "items": { + "$ref": "AdSize" + }, + "type": "array" + }, + "targetedInventorySizes": { + "description": "A list of inventory sizes to be included.", + "items": { + "$ref": "AdSize" + }, + "type": "array" + } + }, + "type": "object" + }, + "InventoryTypeTargeting": { + "description": "Targeting of the inventory types a bid request can originate from.", + "id": "InventoryTypeTargeting", + "properties": { + "inventoryTypes": { + "description": "The list of targeted inventory types for the bid request.", + "items": { + "enum": [ + "INVENTORY_TYPE_UNSPECIFIED", + "BROWSER", + "MOBILE_APP", + "VIDEO_PLAYER" + ], + "enumDescriptions": [ + "Unspecified inventory type", + "Desktop or mobile web browser excluding ads inside a video player", + "Mobile apps other than video players and web browsers", + "Instream video and audio" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListAuctionPackagesResponse": { + "description": "Response message for listing auction packages.", + "id": "ListAuctionPackagesResponse", + "properties": { + "auctionPackages": { + "description": "The list of auction packages.", + "items": { + "$ref": "AuctionPackage" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListClientUsersResponse": { + "description": "Response message for the list method.", + "id": "ListClientUsersResponse", + "properties": { + "clientUsers": { + "description": "The returned list of client users.", + "items": { + "$ref": "ClientUser" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListClientsResponse": { + "description": "Response message for the list method.", + "id": "ListClientsResponse", + "properties": { + "clients": { + "description": "The returned list of clients.", + "items": { + "$ref": "Client" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListDataSegmentsResponse": { + "description": "Response message for listing data segments.", + "id": "ListDataSegmentsResponse", + "properties": { + "dataSegments": { + "description": "The list of data segments.", + "items": { + "$ref": "DataSegment" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListDealsResponse": { + "description": "Response message for listing deals in a proposal.", + "id": "ListDealsResponse", + "properties": { + "deals": { + "description": "The list of deals.", + "items": { + "$ref": "Deal" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to fetch the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListFinalizedDealsResponse": { + "description": "Response message for listing finalized deals.", + "id": "ListFinalizedDealsResponse", + "properties": { + "finalizedDeals": { + "description": "The list of finalized deals.", + "items": { + "$ref": "FinalizedDeal" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to fetch the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListProposalsResponse": { + "description": "Response message for listing proposals.", + "id": "ListProposalsResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "proposals": { + "description": "The list of proposals.", + "items": { + "$ref": "Proposal" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPublisherProfilesResponse": { + "description": "Response message for profiles visible to the buyer.", + "id": "ListPublisherProfilesResponse", + "properties": { + "nextPageToken": { + "description": "Token to fetch the next page of results.", + "type": "string" + }, + "publisherProfiles": { + "description": "The list of matching publisher profiles.", + "items": { + "$ref": "PublisherProfile" + }, + "type": "array" + } + }, + "type": "object" + }, + "MarketplaceTargeting": { + "description": "Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.", + "id": "MarketplaceTargeting", + "properties": { + "daypartTargeting": { + "$ref": "DayPartTargeting", + "description": "Daypart targeting information." + }, + "excludedSensitiveCategoryIds": { + "description": "Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "geoTargeting": { + "$ref": "CriteriaTargeting", + "description": "Output only. Geo criteria IDs to be included/excluded.", + "readOnly": true + }, + "inventorySizeTargeting": { + "$ref": "InventorySizeTargeting", + "description": "Output only. Inventory sizes to be included/excluded.", + "readOnly": true + }, + "inventoryTypeTargeting": { + "$ref": "InventoryTypeTargeting", + "description": "Output only. Inventory type targeting information.", + "readOnly": true + }, + "placementTargeting": { + "$ref": "PlacementTargeting", + "description": "Output only. Placement targeting information, for example, URL, mobile applications.", + "readOnly": true + }, + "technologyTargeting": { + "$ref": "TechnologyTargeting", + "description": "Output only. Technology targeting information, for example, operating system, device category.", + "readOnly": true + }, + "userListTargeting": { + "$ref": "CriteriaTargeting", + "description": "Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader." + }, + "verticalTargeting": { + "$ref": "CriteriaTargeting", + "description": "Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals", + "readOnly": true + }, + "videoTargeting": { + "$ref": "VideoTargeting", + "description": "Output only. Video targeting information.", + "readOnly": true + } + }, + "type": "object" + }, + "MediaPlanner": { + "description": "Describes a single Media Planner account.", + "id": "MediaPlanner", + "properties": { + "accountId": { + "description": "Output only. Account ID of the media planner.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MobileApplicationTargeting": { + "description": "Mobile application targeting settings.", + "id": "MobileApplicationTargeting", + "properties": { + "firstPartyTargeting": { + "$ref": "FirstPartyMobileApplicationTargeting", + "description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in." + } + }, + "type": "object" + }, + "Money": { + "description": "Represents an amount of money with its currency type.", + "id": "Money", + "properties": { + "currencyCode": { + "description": "The three-letter currency code defined in ISO 4217.", + "type": "string" + }, + "nanos": { + "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer" + }, + "units": { + "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Note": { + "description": "A text note attached to the proposal to facilitate the communication between buyers and sellers.", + "id": "Note", + "properties": { + "createTime": { + "description": "Output only. When this note was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "creatorRole": { + "description": "Output only. The role who created the note.", + "enum": [ + "BUYER_SELLER_ROLE_UNSPECIFIED", + "BUYER", + "SELLER" + ], + "enumDescriptions": [ + "A placeholder for an undefined buyer/seller role.", + "Specifies the role as buyer.", + "Specifies the role as seller." + ], + "readOnly": true, + "type": "string" + }, + "note": { + "description": "The text of the note. Maximum length is 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "OperatingSystemTargeting": { + "description": "Represents targeting information for operating systems.", + "id": "OperatingSystemTargeting", + "properties": { + "operatingSystemCriteria": { + "$ref": "CriteriaTargeting", + "description": "IDs of operating systems to be included/excluded." + }, + "operatingSystemVersionCriteria": { + "$ref": "CriteriaTargeting", + "description": "IDs of operating system versions to be included/excluded." + } + }, + "type": "object" + }, + "PauseFinalizedDealRequest": { + "description": "Request message for pausing a finalized deal.", + "id": "PauseFinalizedDealRequest", + "properties": { + "reason": { + "description": "The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.", + "type": "string" + } + }, + "type": "object" + }, + "PlacementTargeting": { + "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", + "id": "PlacementTargeting", + "properties": { + "mobileApplicationTargeting": { + "$ref": "MobileApplicationTargeting", + "description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages." + }, + "uriTargeting": { + "$ref": "UriTargeting", + "description": "URLs to be included/excluded." + } + }, + "type": "object" + }, + "PreferredDealTerms": { + "description": "Pricing terms for Preferred Deals.", + "id": "PreferredDealTerms", + "properties": { + "fixedPrice": { + "$ref": "Price", + "description": "Fixed price for the deal." + } + }, + "type": "object" + }, + "Price": { + "description": "Represents a price and a pricing type for a deal.", + "id": "Price", + "properties": { + "amount": { + "$ref": "Money", + "description": "The actual price with currency specified." + }, + "type": { + "description": "The pricing type for the deal.", + "enum": [ + "TYPE_UNSPECIFIED", + "CPM", + "CPD" + ], + "enumDescriptions": [ + "A placeholder for an undefined pricing type. If the pricing type is unspecified, CPM will be used instead.", + "Cost per thousand impressions.", + "Cost per day." + ], + "type": "string" + } + }, + "type": "object" + }, + "PrivateAuctionTerms": { + "description": "Pricing terms for Private Auctions.", + "id": "PrivateAuctionTerms", + "properties": { + "floorPrice": { + "$ref": "Price", + "description": "The minimum price buyer has to bid to compete in the private auction." + }, + "openAuctionAllowed": { + "description": "Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "PrivateData": { + "description": "Buyers are allowed to store certain types of private data in a proposal or deal.", + "id": "PrivateData", + "properties": { + "referenceId": { + "description": "A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).", + "type": "string" + } + }, + "type": "object" + }, + "ProgrammaticGuaranteedTerms": { + "description": "Pricing terms for Programmatic Guaranteed Deals.", + "id": "ProgrammaticGuaranteedTerms", + "properties": { + "fixedPrice": { + "$ref": "Price", + "description": "Fixed price for the deal." + }, + "guaranteedLooks": { + "description": "Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.", + "format": "int64", + "type": "string" + }, + "impressionCap": { + "description": "The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.", + "format": "int64", + "type": "string" + }, + "minimumDailyLooks": { + "description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.", + "format": "int64", + "type": "string" + }, + "percentShareOfVoice": { + "description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.", + "format": "int64", + "type": "string" + }, + "reservationType": { + "description": "The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.", + "enum": [ + "RESERVATION_TYPE_UNSPECIFIED", + "STANDARD", + "SPONSORSHIP" + ], + "enumDescriptions": [ + "An unspecified reservation type.", + "Non-sponsorship deal.", + "Sponsorship deals don't have impression goal (guaranteed_looks) and they are served based on the flight dates. For CPM Sponsorship deals, impression_cap is the lifetime impression limit." + ], + "type": "string" + } + }, + "type": "object" + }, + "Proposal": { + "description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.", + "id": "Proposal", + "properties": { + "billedBuyer": { + "description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`", + "readOnly": true, + "type": "string" + }, + "buyer": { + "description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`", + "readOnly": true, + "type": "string" + }, + "buyerContacts": { + "description": "Contact information for the buyer.", + "items": { + "$ref": "Contact" + }, + "type": "array" + }, + "buyerPrivateData": { + "$ref": "PrivateData", + "description": "Buyer private data (hidden from seller)." + }, + "client": { + "description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", + "readOnly": true, + "type": "string" + }, + "dealType": { + "description": "Output only. Type of deal the proposal contains.", + "enum": [ + "DEAL_TYPE_UNSPECIFIED", + "PREFERRED_DEAL", + "PRIVATE_AUCTION", + "PROGRAMMATIC_GUARANTEED" + ], + "enumDescriptions": [ + "Default, unspecified deal type.", + "Preferred deals.", + "Private auction deals.", + "Programmatic guaranteed deals." + ], + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.", + "readOnly": true, + "type": "string" + }, + "isRenegotiating": { + "description": "Output only. True if the proposal was previously finalized and is now being renegotiated.", + "readOnly": true, + "type": "boolean" + }, + "lastUpdaterOrCommentorRole": { + "description": "Output only. The role of the last user that either updated the proposal or left a comment.", + "enum": [ + "BUYER_SELLER_ROLE_UNSPECIFIED", + "BUYER", + "SELLER" + ], + "enumDescriptions": [ + "A placeholder for an undefined buyer/seller role.", + "Specifies the role as buyer.", + "Specifies the role as seller." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", + "type": "string" + }, + "notes": { + "description": "A list of notes from the buyer and the seller attached to this proposal.", + "items": { + "$ref": "Note" + }, + "type": "array" + }, + "originatorRole": { + "description": "Output only. Indicates whether the buyer/seller created the proposal.", + "enum": [ + "BUYER_SELLER_ROLE_UNSPECIFIED", + "BUYER", + "SELLER" + ], + "enumDescriptions": [ + "A placeholder for an undefined buyer/seller role.", + "Specifies the role as buyer.", + "Specifies the role as seller." + ], + "readOnly": true, + "type": "string" + }, + "pausingConsented": { + "description": "Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.", + "type": "boolean" + }, + "proposalRevision": { + "description": "Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "publisherProfile": { + "description": "Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", + "type": "string" + }, + "sellerContacts": { + "description": "Output only. Contact information for the seller.", + "items": { + "$ref": "Contact" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. Indicates the state of the proposal.", + "enum": [ + "STATE_UNSPECIFIED", + "BUYER_REVIEW_REQUESTED", + "SELLER_REVIEW_REQUESTED", + "BUYER_ACCEPTANCE_REQUESTED", + "FINALIZED", + "TERMINATED" + ], + "enumDescriptions": [ + "Unspecified proposal state", + "When a proposal is waiting for buyer to review.", + "When the proposal is waiting for the seller to review.", + "When the seller accepted the proposal and sent it to the buyer for review.", + "When both buyer and seller has accepted the proposal", + "When either buyer or seller has cancelled the proposal" + ], + "readOnly": true, + "type": "string" + }, + "termsAndConditions": { + "description": "Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the proposal was last revised.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "PublisherProfile": { + "description": "The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.", + "id": "PublisherProfile", + "properties": { + "audienceDescription": { + "description": "Description on the publisher's audience.", + "type": "string" + }, + "directDealsContact": { + "description": "Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", + "type": "string" + }, + "displayName": { + "description": "Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.", + "type": "string" + }, + "domains": { + "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like \"photos.google.co.uk/123\", but will instead contain \"google.co.uk\". Can be used to filter the response of the publisherProfiles.list method.", + "items": { + "type": "string" + }, + "type": "array" + }, + "isParent": { + "description": "Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to \"is_parent: true\".", + "type": "boolean" + }, + "logoUrl": { + "description": "A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.", + "type": "string" + }, + "mediaKitUrl": { + "description": "URL to additional marketing and sales materials.", + "type": "string" + }, + "mobileApps": { + "description": "The list of apps represented in this publisher profile. Empty if this is a parent profile.", + "items": { + "$ref": "PublisherProfileMobileApplication" + }, + "type": "array" + }, + "name": { + "description": "Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`", + "type": "string" + }, + "overview": { + "description": "Overview of the publisher.", + "type": "string" + }, + "pitchStatement": { + "description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.", + "type": "string" + }, + "programmaticDealsContact": { + "description": "Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", + "type": "string" + }, + "publisherCode": { + "description": "A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.", + "type": "string" + }, + "samplePageUrl": { + "description": "URL to a sample content page.", + "type": "string" + }, + "topHeadlines": { + "description": "Up to three key metrics and rankings. For example, \"#1 Mobile News Site for 20 Straight Months\".", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "PublisherProfileMobileApplication": { + "description": "A mobile application that contains a external app ID, name, and app store.", + "id": "PublisherProfileMobileApplication", + "properties": { + "appStore": { + "description": "The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.", + "enum": [ + "APP_STORE_TYPE_UNSPECIFIED", + "APPLE_ITUNES", + "GOOGLE_PLAY", + "ROKU", + "AMAZON_FIRE_TV", + "PLAYSTATION", + "XBOX", + "SAMSUNG_TV", + "AMAZON", + "OPPO", + "SAMSUNG", + "VIVO", + "XIAOMI", + "LG_TV" + ], + "enumDescriptions": [ + "A placeholder for an unknown app store.", + "Apple iTunes", + "Google Play", + "Roku", + "Amazon Fire TV", + "PlayStation", + "Xbox", + "Samsung TV", + "Amazon Appstore", + "OPPO App Market", + "Samsung Galaxy Store", + "VIVO App Store", + "Xiaomi GetApps", + "LG TV" + ], + "type": "string" + }, + "externalAppId": { + "description": "The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.", + "type": "string" + }, + "name": { + "description": "The name of the app.", + "type": "string" + } + }, + "type": "object" + }, + "ResumeFinalizedDealRequest": { + "description": "Request message for resuming a finalized deal.", + "id": "ResumeFinalizedDealRequest", + "properties": {}, + "type": "object" + }, + "RtbMetrics": { + "description": "Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics)", + "id": "RtbMetrics", + "properties": { + "adImpressions7Days": { + "description": "Ad impressions in last 7 days.", + "format": "int64", + "type": "string" + }, + "bidRate7Days": { + "description": "Bid rate in last 7 days, calculated by (bids / bid requests).", + "format": "double", + "type": "number" + }, + "bidRequests7Days": { + "description": "Bid requests in last 7 days.", + "format": "int64", + "type": "string" + }, + "bids7Days": { + "description": "Bids in last 7 days.", + "format": "int64", + "type": "string" + }, + "filteredBidRate7Days": { + "description": "Filtered bid rate in last 7 days, calculated by (filtered bids / bids).", + "format": "double", + "type": "number" + }, + "mustBidRateCurrentMonth": { + "description": "Must bid rate for current month.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "SendRfpRequest": { + "description": "Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.", + "id": "SendRfpRequest", + "properties": { + "buyerContacts": { + "description": "Contact information for the buyer.", + "items": { + "$ref": "Contact" + }, + "type": "array" + }, + "client": { + "description": "If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the proposal being created by this RFP.", + "type": "string" + }, + "estimatedGrossSpend": { + "$ref": "Money", + "description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." + }, + "flightEndTime": { + "description": "Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", + "format": "google-datetime", + "type": "string" + }, + "flightStartTime": { + "description": "Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", + "format": "google-datetime", + "type": "string" + }, + "geoTargeting": { + "$ref": "CriteriaTargeting", + "description": "Geo criteria IDs to be targeted. Refer to Geo tables." + }, + "inventorySizeTargeting": { + "$ref": "InventorySizeTargeting", + "description": "Inventory sizes to be targeted." + }, + "note": { + "description": "A message that is sent to the publisher. Maximum length is 1024 characters.", + "type": "string" + }, + "preferredDealTerms": { + "$ref": "PreferredDealTerms", + "description": "The terms for preferred deals." + }, + "programmaticGuaranteedTerms": { + "$ref": "ProgrammaticGuaranteedTerms", + "description": "The terms for programmatic guaranteed deals." + }, + "publisherProfile": { + "description": "Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.", + "type": "string" + } + }, + "type": "object" + }, + "SetReadyToServeRequest": { + "description": "Request message for setting ready to serve for a finalized deal.", + "id": "SetReadyToServeRequest", + "properties": {}, + "type": "object" + }, + "SubscribeAuctionPackageRequest": { + "description": "Request message for SubscribeAuctionPackage.", + "id": "SubscribeAuctionPackageRequest", + "properties": {}, + "type": "object" + }, + "SubscribeClientsRequest": { + "description": "Request message for SubscribeAuctionPackageClients.", + "id": "SubscribeClientsRequest", + "properties": { + "clients": { + "description": "Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TechnologyTargeting": { + "description": "Represents targeting about various types of technology.", + "id": "TechnologyTargeting", + "properties": { + "deviceCapabilityTargeting": { + "$ref": "CriteriaTargeting", + "description": "IDs of device capabilities to be included/excluded." + }, + "deviceCategoryTargeting": { + "$ref": "CriteriaTargeting", + "description": "IDs of device categories to be included/excluded." + }, + "operatingSystemTargeting": { + "$ref": "OperatingSystemTargeting", + "description": "Operating system related targeting information." + } + }, + "type": "object" + }, + "TimeOfDay": { + "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", + "id": "TimeOfDay", + "properties": { + "hours": { + "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Minutes of hour of day. Must be from 0 to 59.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", + "type": "string" + } + }, + "type": "object" + }, + "UnsubscribeAuctionPackageRequest": { + "description": "Request message for UnsubscribeAuctionPackage.", + "id": "UnsubscribeAuctionPackageRequest", + "properties": {}, + "type": "object" + }, + "UnsubscribeClientsRequest": { + "description": "Request message for UnsubscribeAuctionPackage.", + "id": "UnsubscribeClientsRequest", + "properties": { + "clients": { + "description": "Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "UpdateDealRequest": { + "description": "Request message for updating the deal at the given revision number.", + "id": "UpdateDealRequest", + "properties": { + "deal": { + "$ref": "Deal", + "description": "Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}" + }, + "updateMask": { + "description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "UriTargeting": { + "description": "Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", + "id": "UriTargeting", + "properties": { + "excludedUris": { + "description": "A list of URLs to be excluded.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetedUris": { + "description": "A list of URLs to be included.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoTargeting": { + "description": "Represents targeting information about video.", + "id": "VideoTargeting", + "properties": { + "excludedPositionTypes": { + "description": "A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.", + "items": { + "enum": [ + "POSITION_TYPE_UNSPECIFIED", + "PREROLL", + "MIDROLL", + "POSTROLL" + ], + "enumDescriptions": [ + "A placeholder for an undefined video position.", + "Ad is played before the video.", + "Ad is played during the video.", + "Ad is played after the video." + ], + "type": "string" + }, + "type": "array" + }, + "targetedPositionTypes": { + "description": "A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.", + "items": { + "enum": [ + "POSITION_TYPE_UNSPECIFIED", + "PREROLL", + "MIDROLL", + "POSTROLL" + ], + "enumDescriptions": [ + "A placeholder for an undefined video position.", + "Ad is played before the video.", + "Ad is played during the video.", + "Ad is played after the video." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Authorized Buyers Marketplace API", + "version": "v1alpha", + "version_module": true +} \ No newline at end of file diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json index b92d24ea73..64963074f9 100644 --- a/discovery/backupdr-v1.json +++ b/discovery/backupdr-v1.json @@ -177,38 +177,38 @@ } }, "resources": { - "managementServers": { + "backupPlanAssociations": { "methods": { "create": { - "description": "Creates a new ManagementServer in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers", + "description": "Create a BackupPlanAssociation", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations", "httpMethod": "POST", - "id": "backupdr.projects.locations.managementServers.create", + "id": "backupdr.projects.locations.backupPlanAssociations.create", "parameterOrder": [ "parent" ], "parameters": { - "managementServerId": { - "description": "Required. The name of the management server to create. The name must be unique for the specified project and location.", + "backupPlanAssociationId": { + "description": "Required. The name of the backup plan association to create. The name must be unique for the specified project and location.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The management server project and location in the format `projects/{project_id}/locations/{location}`. In Cloud Backup and DR locations map to GCP regions, for example **us-central1**.", + "description": "Required. The backup plan association project and location in the format `projects/{project_id}/locations/{location}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**.", "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).", + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } }, - "path": "v1/{+parent}/managementServers", + "path": "v1/{+parent}/backupPlanAssociations", "request": { - "$ref": "ManagementServer" + "$ref": "BackupPlanAssociation" }, "response": { "$ref": "Operation" @@ -218,18 +218,18 @@ ] }, "delete": { - "description": "Deletes a single ManagementServer.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", + "description": "Deletes a single BackupPlanAssociation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}", "httpMethod": "DELETE", - "id": "backupdr.projects.locations.managementServers.delete", + "id": "backupdr.projects.locations.backupPlanAssociations.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Name of the resource", + "description": "Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", "required": true, "type": "string" }, @@ -248,77 +248,41 @@ ] }, "get": { - "description": "Gets details of a single ManagementServer.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", + "description": "Gets details of a single BackupPlanAssociation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}", "httpMethod": "GET", - "id": "backupdr.projects.locations.managementServers.get", + "id": "backupdr.projects.locations.backupPlanAssociations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Name of the management server resource name, in the format `projects/{project_id}/locations/{location}/managementServers/{resource_name}`", + "description": "Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "ManagementServer" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy", - "httpMethod": "GET", - "id": "backupdr.projects.locations.managementServers.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" + "$ref": "BackupPlanAssociation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { - "description": "Lists ManagementServers in a given project and location.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers", + "description": "Lists BackupPlanAssociations in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations", "httpMethod": "GET", - "id": "backupdr.projects.locations.managementServers.list", + "id": "backupdr.projects.locations.backupPlanAssociations.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { - "description": "Optional. Filtering results.", - "location": "query", - "type": "string" - }, - "orderBy": { - "description": "Optional. Hint for how to order the results.", + "description": "Optional. Filtering results", "location": "query", "type": "string" }, @@ -334,72 +298,44 @@ "type": "string" }, "parent": { - "description": "Required. The project and location for which to retrieve management servers information, in the format `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve management servers for all locations, use \"-\" for the `{location}` value.", + "description": "Required. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve backup plan associations for all locations, use \"-\" for the `{location}` value.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+parent}/managementServers", - "response": { - "$ref": "ListManagementServersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy", - "httpMethod": "POST", - "id": "backupdr.projects.locations.managementServers.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, + "path": "v1/{+parent}/backupPlanAssociations", "response": { - "$ref": "Policy" + "$ref": "ListBackupPlanAssociationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions", + "triggerBackup": { + "description": "Triggers a new Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup", "httpMethod": "POST", - "id": "backupdr.projects.locations.managementServers.testIamPermissions", + "id": "backupdr.projects.locations.backupPlanAssociations.triggerBackup", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1/{+resource}:testIamPermissions", + "path": "v1/{+name}:triggerBackup", "request": { - "$ref": "TestIamPermissionsRequest" + "$ref": "TriggerBackupRequest" }, "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -407,238 +343,3334 @@ } } }, - "operations": { + "backupPlans": { "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", + "create": { + "description": "Create a BackupPlan", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans", "httpMethod": "POST", - "id": "backupdr.projects.locations.operations.cancel", + "id": "backupdr.projects.locations.backupPlans.create", "parameterOrder": [ - "name" + "parent" ], "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", + "backupPlanId": { + "description": "Required. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The `BackupPlan` project and location in the format `projects/{project}/locations/{location}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "v1/{+name}:cancel", + "path": "v1/{+parent}/backupPlans", "request": { - "$ref": "CancelOperationRequest" + "$ref": "BackupPlan" }, "response": { - "$ref": "Empty" + "$ref": "Operation" }, "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}", + "description": "Deletes a single BackupPlan.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}", "httpMethod": "DELETE", - "id": "backupdr.projects.locations.operations.delete", + "id": "backupdr.projects.locations.backupPlans.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Empty" + "$ref": "Operation" }, "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}", + "description": "Gets details of a single BackupPlan.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}", "httpMethod": "GET", - "id": "backupdr.projects.locations.operations.get", + "id": "backupdr.projects.locations.backupPlans.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$", "required": true, "type": "string" } }, "path": "v1/{+name}", "response": { - "$ref": "Operation" + "$ref": "BackupPlan" }, "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", + "description": "Lists BackupPlans in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupPlans", "httpMethod": "GET", - "id": "backupdr.projects.locations.operations.list", + "id": "backupdr.projects.locations.backupPlans.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Optional. Field match expression used to filter the results.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, + "orderBy": { + "description": "Optional. Field by which to sort the results.", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.", "location": "query", "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve `BackupPlans` information. Format: `projects/{project}/locations/{location}`. In Cloud BackupDR, locations map to GCP regions, for e.g. **us-central1**. To retrieve backup plans for all locations, use \"-\" for the `{location}` value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" } }, - "path": "v1/{+name}/operations", + "path": "v1/{+parent}/backupPlans", "response": { - "$ref": "ListOperationsResponse" + "$ref": "ListBackupPlansResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } - } - } + }, + "backupVaults": { + "methods": { + "create": { + "description": "", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backupVaultId": { + "description": "Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Value for parent.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/backupVaults", + "request": { + "$ref": "BackupVault" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a BackupVault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.backupVaults.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.", + "location": "query", + "type": "boolean" + }, + "etag": { + "description": "The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.", + "location": "query", + "type": "string" + }, + "force": { + "description": "Optional. If set to true, any data source from this backup vault will also be deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "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" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchUsable": { + "description": "FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.fetchUsable", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupVaults:fetchUsable", + "response": { + "$ref": "FetchUsableBackupVaultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a BackupVault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "BackupVault" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists BackupVaults in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupVaults", + "response": { + "$ref": "ListBackupVaultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a BackupVault.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupVaults.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, will not check plan duration against backup vault enforcement duration.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. Identifier. The resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "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 BackupVault 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 the request will fail.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. Only validate the request, but do not perform mutations. The default is 'false'.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "BackupVault" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "dataSources": { + "methods": { + "abandonBackup": { + "description": "Internal only. Abandons a backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.abandonBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:abandonBackup", + "request": { + "$ref": "AbandonBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchAccessToken": { + "description": "Internal only. Fetch access token for a given data source.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:fetchAccessToken", + "request": { + "$ref": "FetchAccessTokenRequest" + }, + "response": { + "$ref": "FetchAccessTokenResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "finalizeBackup": { + "description": "Internal only. Finalize a backup that was started by a call to InitiateBackup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.finalizeBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:finalizeBackup", + "request": { + "$ref": "FinalizeBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "DataSource" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "initiateBackup": { + "description": "Internal only. Initiates a backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.initiateBackup", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:initiateBackup", + "request": { + "$ref": "InitiateBackupRequest" + }, + "response": { + "$ref": "InitiateBackupResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DataSources in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/dataSources", + "response": { + "$ref": "ListDataSourcesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupVaults.dataSources.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "allowMissing": { + "description": "Optional. Enable upsert.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Output only. Identifier. The resource name.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "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 DataSource 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 the request will fail.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "DataSource" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "remove": { + "description": "Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.remove", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:remove", + "request": { + "$ref": "RemoveDataSourceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setInternalStatus": { + "description": "Sets the internal status of a DataSource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.setInternalStatus", + "parameterOrder": [ + "dataSource" + ], + "parameters": { + "dataSource": { + "description": "Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataSource}:setInternalStatus", + "request": { + "$ref": "SetInternalStatusRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "backups": { + "methods": { + "delete": { + "description": "Deletes a Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "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 Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Backup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Backups in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups", + "httpMethod": "GET", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backups", + "response": { + "$ref": "ListBackupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the settings of a Backup.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}", + "httpMethod": "PATCH", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Identifier. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "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 Backup 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 the request will fail.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Backup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restore from a Backup", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore", + "httpMethod": "POST", + "id": "backupdr.projects.locations.backupVaults.dataSources.backups.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restore", + "request": { + "$ref": "RestoreBackupRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, + "managementServers": { + "methods": { + "create": { + "description": "Creates a new ManagementServer in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "managementServerId": { + "description": "Required. The name of the management server to create. The name must be unique for the specified project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**.", + "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}/managementServers", + "request": { + "$ref": "ManagementServer" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ManagementServer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.managementServers.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "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 ManagementServer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.managementServers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}'", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ManagementServer" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy", + "httpMethod": "GET", + "id": "backupdr.projects.locations.managementServers.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ManagementServers in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers", + "httpMethod": "GET", + "id": "backupdr.projects.locations.managementServers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use \"-\" for the '{location}' value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/managementServers", + "response": { + "$ref": "ListManagementServersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "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": "backupdr.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "backupdr.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": "backupdr.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": "20240808", + "rootUrl": "https://backupdr.googleapis.com/", + "schemas": { + "AbandonBackupRequest": { + "description": "request message for AbandonBackup.", + "id": "AbandonBackupRequest", + "properties": { + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "AcceleratorConfig": { + "description": "A specification of the type and number of accelerator cards attached to the instance.", + "id": "AcceleratorConfig", + "properties": { + "acceleratorCount": { + "description": "Optional. The number of the guest accelerator cards exposed to this instance.", + "format": "int32", + "type": "integer" + }, + "acceleratorType": { + "description": "Optional. Full or partial URL of the accelerator type resource to attach to this instance.", + "type": "string" + } + }, + "type": "object" + }, + "AccessConfig": { + "description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.", + "id": "AccessConfig", + "properties": { + "externalIpv6": { + "description": "Optional. The external IPv6 address of this access configuration.", + "type": "string" + }, + "externalIpv6PrefixLength": { + "description": "Optional. The prefix length of the external IPv6 range.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Optional. The name of this access configuration.", + "type": "string" + }, + "natIP": { + "description": "Optional. The external IP address of this access configuration.", + "type": "string" + }, + "networkTier": { + "description": "Optional. This signifies the networking tier used for configuring this access", + "enum": [ + "NETWORK_TIER_UNSPECIFIED", + "PREMIUM", + "STANDARD" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "High quality, Google-grade network tier, support for all networking products.", + "Public internet quality, only limited support for other networking products." + ], + "type": "string" + }, + "publicPtrDomainName": { + "description": "Optional. The DNS domain name for the public PTR record.", + "type": "string" + }, + "setPublicPtr": { + "description": "Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.", + "type": "boolean" + }, + "type": { + "description": "Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.", + "enum": [ + "ACCESS_TYPE_UNSPECIFIED", + "ONE_TO_ONE_NAT", + "DIRECT_IPV6" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "ONE_TO_ONE_NAT", + "Direct IPv6 access." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdvancedMachineFeatures": { + "description": "Specifies options for controlling advanced machine features.", + "id": "AdvancedMachineFeatures", + "properties": { + "enableNestedVirtualization": { + "description": "Optional. Whether to enable nested virtualization or not (default is false).", + "type": "boolean" + }, + "enableUefiNetworking": { + "description": "Optional. Whether to enable UEFI networking for instance creation.", + "type": "boolean" + }, + "threadsPerCore": { + "description": "Optional. The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.", + "format": "int32", + "type": "integer" + }, + "visibleCoreCount": { + "description": "Optional. The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AliasIpRange": { + "description": "An alias IP range attached to an instance's network interface.", + "id": "AliasIpRange", + "properties": { + "ipCidrRange": { + "description": "Optional. The IP alias ranges to allocate for this interface.", + "type": "string" + }, + "subnetworkRangeName": { + "description": "Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.", + "type": "string" + } + }, + "type": "object" + }, + "AllocationAffinity": { + "description": "Specifies the reservations that this instance can consume from.", + "id": "AllocationAffinity", + "properties": { + "consumeReservationType": { + "description": "Optional. Specifies the type of reservation from which this instance can consume", + "enum": [ + "TYPE_UNSPECIFIED", + "NO_RESERVATION", + "ANY_RESERVATION", + "SPECIFIC_RESERVATION" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Do not consume from any allocated capacity.", + "Consume any allocation available.", + "Must consume from a specific reservation. Must specify key value fields for specifying the reservations." + ], + "type": "string" + }, + "key": { + "description": "Optional. Corresponds to the label key of a reservation resource.", + "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of a reservation resource.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "ccfeRmsPath": { + "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", + "type": "string" + }, + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, + "AttachedDisk": { + "description": "An instance-attached disk resource.", + "id": "AttachedDisk", + "properties": { + "autoDelete": { + "description": "Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).", + "type": "boolean" + }, + "boot": { + "description": "Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.", + "type": "boolean" + }, + "deviceName": { + "description": "Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)", + "type": "string" + }, + "diskEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Optional. Encrypts or decrypts a disk using a customer-supplied encryption key." + }, + "diskInterface": { + "description": "Optional. Specifies the disk interface to use for attaching this disk.", + "enum": [ + "DISK_INTERFACE_UNSPECIFIED", + "SCSI", + "NVME", + "NVDIMM", + "ISCSI" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "SCSI Disk Interface.", + "NVME Disk Interface.", + "NVDIMM Disk Interface.", + "ISCSI Disk Interface." + ], + "type": "string" + }, + "diskSizeGb": { + "description": "Optional. The size of the disk in GB.", + "format": "int64", + "type": "string" + }, + "diskType": { + "description": "Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd", + "readOnly": true, + "type": "string" + }, + "diskTypeDeprecated": { + "deprecated": true, + "description": "Specifies the type of the disk.", + "enum": [ + "DISK_TYPE_UNSPECIFIED", + "SCRATCH", + "PERSISTENT" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "A scratch disk type.", + "A persistent disk type." + ], + "type": "string" + }, + "guestOsFeature": { + "description": "Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.", + "items": { + "$ref": "GuestOsFeature" + }, + "type": "array" + }, + "index": { + "description": "Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.", + "format": "int64", + "type": "string" + }, + "initializeParams": { + "$ref": "InitializeParams", + "description": "Optional. Specifies the parameters to initialize this disk." + }, + "kind": { + "description": "Optional. Type of the resource.", + "type": "string" + }, + "license": { + "description": "Optional. Any valid publicly visible licenses.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mode": { + "description": "Optional. The mode in which to attach this disk.", + "enum": [ + "DISK_MODE_UNSPECIFIED", + "READ_WRITE", + "READ_ONLY", + "LOCKED" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.", + "Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.", + "The disk is locked for administrative reasons. Nobody else can use the disk. This mode is used (for example) when taking a snapshot of a disk to prevent mounting the disk while it is being snapshotted." + ], + "type": "string" + }, + "savedState": { + "description": "Optional. Output only. The state of the disk.", + "enum": [ + "DISK_SAVED_STATE_UNSPECIFIED", + "PRESERVED" + ], + "enumDescriptions": [ + "Default Disk state has not been preserved.", + "Disk state has been preserved." + ], + "readOnly": true, + "type": "string" + }, + "source": { + "description": "Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.", + "type": "string" + }, + "type": { + "description": "Optional. Specifies the type of the disk.", + "enum": [ + "DISK_TYPE_UNSPECIFIED", + "SCRATCH", + "PERSISTENT" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "A scratch disk type.", + "A persistent disk type." + ], + "type": "string" + } + }, + "type": "object" + }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", + "id": "AuditConfig", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.", + "items": { + "$ref": "AuditLogConfig" + }, + "type": "array" + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "type": "string" + } + }, + "type": "object" + }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", + "id": "AuditLogConfig", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "items": { + "type": "string" + }, + "type": "array" + }, + "logType": { + "description": "The log type that this config enables.", + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "type": "string" + } + }, + "type": "object" + }, + "Backup": { + "description": "Message describing a Backup object.", + "id": "Backup", + "properties": { + "backupApplianceBackupProperties": { + "$ref": "BackupApplianceBackupProperties", + "description": "Output only. Backup Appliance specific backup properties.", + "readOnly": true + }, + "backupApplianceLocks": { + "description": "Optional. The list of BackupLocks taken by the accessor Backup Appliance.", + "items": { + "$ref": "BackupLock" + }, + "type": "array" + }, + "backupType": { + "description": "Output only. Type of the backup, unspecified, scheduled or ondemand.", + "enum": [ + "BACKUP_TYPE_UNSPECIFIED", + "SCHEDULED", + "ON_DEMAND" + ], + "enumDescriptions": [ + "Backup type is unspecified.", + "Scheduled backup.", + "On demand backup." + ], + "readOnly": true, + "type": "string" + }, + "computeInstanceBackupProperties": { + "$ref": "ComputeInstanceBackupProperties", + "description": "Output only. Compute Engine specific backup properties.", + "readOnly": true + }, + "consistencyTime": { + "description": "Output only. The point in time when this backup was captured from the source.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Output only. The description of the Backup instance (2048 characters or less).", + "readOnly": true, + "type": "string" + }, + "enforcedRetentionEndTime": { + "description": "Optional. The backup can not be deleted before this time.", + "format": "google-datetime", + "type": "string" + }, + "etag": { + "description": "Optional. Server specified ETag to prevent updates from overwriting each other.", + "type": "string" + }, + "expireTime": { + "description": "Optional. When this backup is automatically expired.", + "format": "google-datetime", + "type": "string" + }, + "gcpBackupPlanInfo": { + "$ref": "GCPBackupPlanInfo", + "description": "Output only. Configuration for a Google Cloud resource.", + "readOnly": true + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. No labels currently defined.", + "type": "object" + }, + "name": { + "description": "Output only. Identifier. Name of the resource.", + "readOnly": true, + "type": "string" + }, + "resourceSizeBytes": { + "description": "Output only. source resource size in bytes at the time of the backup.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "serviceLocks": { + "description": "Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup.", + "items": { + "$ref": "BackupLock" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The Backup resource instance state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The backup is being created.", + "The backup has been created and is fully usable.", + "The backup is being deleted.", + "The backup is experiencing an issue and might be unusable." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupApplianceBackupConfig": { + "description": "BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances.", + "id": "BackupApplianceBackupConfig", + "properties": { + "applicationName": { + "description": "The name of the application.", + "type": "string" + }, + "backupApplianceId": { + "description": "The ID of the backup appliance.", + "format": "int64", + "type": "string" + }, + "backupApplianceName": { + "description": "The name of the backup appliance.", + "type": "string" + }, + "hostName": { + "description": "The name of the host where the application is running.", + "type": "string" + }, + "slaId": { + "description": "The ID of the SLA of this application.", + "format": "int64", + "type": "string" + }, + "slpName": { + "description": "The name of the SLP associated with the application.", + "type": "string" + }, + "sltName": { + "description": "The name of the SLT associated with the application.", + "type": "string" + } + }, + "type": "object" + }, + "BackupApplianceBackupProperties": { + "description": "BackupApplianceBackupProperties represents BackupDR backup appliance's properties.", + "id": "BackupApplianceBackupProperties", + "properties": { + "finalizeTime": { + "description": "Output only. The time when this backup object was finalized (if none, backup is not finalized).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "generationId": { + "description": "Output only. The numeric generation ID of the backup (monotonically increasing).", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "recoveryRangeEndTime": { + "description": "Optional. The latest timestamp of data available in this Backup.", + "format": "google-datetime", + "type": "string" + }, + "recoveryRangeStartTime": { + "description": "Optional. The earliest timestamp of data available in this Backup.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "BackupApplianceLockInfo": { + "description": "BackupApplianceLockInfo contains metadata about the backupappliance that created the lock.", + "id": "BackupApplianceLockInfo", + "properties": { + "backupApplianceId": { + "description": "Required. The ID of the backup/recovery appliance that created this lock.", + "format": "int64", + "type": "string" + }, + "backupApplianceName": { + "description": "Required. The name of the backup/recovery appliance that created this lock.", + "type": "string" + }, + "backupImage": { + "description": "The image name that depends on this Backup.", + "type": "string" + }, + "jobName": { + "description": "The job name on the backup/recovery appliance that created this lock.", + "type": "string" + }, + "lockReason": { + "description": "Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service.", + "type": "string" + }, + "slaId": { + "description": "The SLA on the backup/recovery appliance that owns the lock.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BackupConfigInfo": { + "description": "BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault.", + "id": "BackupConfigInfo", + "properties": { + "backupApplianceBackupConfig": { + "$ref": "BackupApplianceBackupConfig", + "description": "Configuration for an application backed up by a Backup Appliance." + }, + "gcpBackupConfig": { + "$ref": "GcpBackupConfig", + "description": "Configuration for a Google Cloud resource." + }, + "lastBackupError": { + "$ref": "Status", + "description": "Output only. If the last backup failed, this field has the error message.", + "readOnly": true + }, + "lastBackupState": { + "description": "Output only. The status of the last backup to this BackupVault", + "enum": [ + "LAST_BACKUP_STATE_UNSPECIFIED", + "FIRST_BACKUP_PENDING", + "SUCCEEDED", + "FAILED", + "PERMISSION_DENIED" + ], + "enumDescriptions": [ + "Status not set.", + "The first backup has not yet completed", + "The most recent backup was successful", + "The most recent backup failed", + "The most recent backup could not be run/failed because of the lack of permissions" + ], + "readOnly": true, + "type": "string" + }, + "lastSuccessfulBackupConsistencyTime": { + "description": "Output only. If the last backup were successful, this field has the consistency date.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupLock": { + "description": "BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted.", + "id": "BackupLock", + "properties": { + "backupApplianceLockInfo": { + "$ref": "BackupApplianceLockInfo", + "description": "If the client is a backup and recovery appliance, this contains metadata about why the lock exists." + }, + "lockUntilTime": { + "description": "Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion.", + "format": "google-datetime", + "type": "string" + }, + "serviceLockInfo": { + "$ref": "ServiceLockInfo", + "description": "Output only. Contains metadata about the lock exist for Google Cloud native backups.", + "readOnly": true + } + }, + "type": "object" + }, + "BackupPlan": { + "description": "A `BackupPlan` specifies some common fields, such as `display_name` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads.", + "id": "BackupPlan", + "properties": { + "backupRules": { + "description": "Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message.", + "items": { + "$ref": "BackupRule" + }, + "type": "array" + }, + "backupVault": { + "description": "Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project}/locations/{location}/backupVaults/{backupvault}", + "type": "string" + }, + "backupVaultServiceAccount": { + "description": "Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. When the `BackupPlan` was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: \"This is a backup plan that performs a daily backup at 6pm and retains data for 3 months\". The description must be at most 2048 characters.", + "type": "string" + }, + "etag": { + "description": "Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {\"tag\": \"Weekly\"}.", + "type": "object" + }, + "name": { + "description": "Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`", + "readOnly": true, + "type": "string" + }, + "resourceType": { + "description": "Required. The resource type to which the `BackupPlan` will be applied. Examples include, \"compute.googleapis.com/Instance\" and \"storage.googleapis.com/Bucket\".", + "type": "string" + }, + "state": { + "description": "Output only. The `State` for the `BackupPlan`.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "INACTIVE" + ], + "enumDescriptions": [ + "State not set.", + "The resource is being created.", + "The resource has been created and is fully usable.", + "The resource is being deleted.", + "The resource has been created but is not usable." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. When the `BackupPlan` was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupPlanAssociation": { + "description": "A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc", + "id": "BackupPlanAssociation", + "properties": { + "backupPlan": { + "description": "Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSource": { + "description": "Output only. Output Only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}", + "readOnly": true, + "type": "string" + }, + "resource": { + "description": "Required. Immutable. Resource name of workload on which backupplan is applied", + "type": "string" + }, + "resourceType": { + "description": "Output only. Output Only. Resource type of workload on which backupplan is applied", + "readOnly": true, + "type": "string" + }, + "rulesConfigInfo": { + "description": "Output only. The config info related to backup rules.", + "items": { + "$ref": "RuleConfigInfo" + }, + "readOnly": true, + "type": "array" + }, + "state": { + "description": "Output only. The BackupPlanAssociation resource state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "INACTIVE" + ], + "enumDescriptions": [ + "State not set.", + "The resource is being created.", + "The resource has been created and is fully usable.", + "The resource is being deleted.", + "The resource has been created but is not usable." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupRule": { + "description": "`BackupRule` binds the backup schedule to a retention policy.", + "id": "BackupRule", + "properties": { + "backupRetentionDays": { + "description": "Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault.", + "format": "int32", + "type": "integer" + }, + "ruleId": { + "description": "Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62}/.", + "type": "string" + }, + "standardSchedule": { + "$ref": "StandardSchedule", + "description": "Required. Defines a schedule that runs within the confines of a defined window of time." + } + }, + "type": "object" + }, + "BackupVault": { + "description": "Message describing a BackupVault object.", + "id": "BackupVault", + "properties": { + "annotations": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.", + "type": "object" + }, + "backupCount": { + "description": "Output only. The number of backups in this backup vault.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "backupMinimumEnforcedRetentionDuration": { + "description": "Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended.", + "format": "google-duration", + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deletable": { + "description": "Output only. Set to true when there are no backups nested under this resource.", + "readOnly": true, + "type": "boolean" + }, + "description": { + "description": "Optional. The description of the BackupVault instance (2048 characters or less).", + "type": "string" + }, + "effectiveTime": { + "description": "Optional. Time after which the BackupVault resource is locked.", + "format": "google-datetime", + "type": "string" + }, + "enforcedRetentionDuration": { + "description": "Required. The default retention period for each backup in the backup vault (Deprecated).", + "format": "google-duration", + "type": "string" + }, + "etag": { + "description": "Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. No labels currently defined:", + "type": "object" + }, + "name": { + "description": "Output only. Identifier. The resource name.", + "readOnly": true, + "type": "string" + }, + "serviceAccount": { + "description": "Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The BackupVault resource instance state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The backup vault is being created.", + "The backup vault has been created and is fully usable.", + "The backup vault is being deleted.", + "The backup vault is experiencing an issue and might be unusable." + ], + "readOnly": true, + "type": "string" + }, + "totalStoredBytes": { + "description": "Output only. Total size of the storage used by all backup resources.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. Output only Immutable after resource creation until resource deletion.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupWindow": { + "description": "`BackupWindow` defines a window of the day during which backup jobs will run.", + "id": "BackupWindow", + "properties": { + "endHourOfDay": { + "description": "Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00.", + "format": "int32", + "type": "integer" + }, + "startHourOfDay": { + "description": "Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Binding": { + "description": "Associates `members`, or principals, with a `role`.", + "id": "Binding", + "properties": { + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." + }, + "members": { + "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "role": { + "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "type": "string" + } + }, + "type": "object" + }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, + "ComputeInstanceBackupProperties": { + "description": "ComputeInstanceBackupProperties represents Compute Engine instance backup properties.", + "id": "ComputeInstanceBackupProperties", + "properties": { + "canIpForward": { + "description": "Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information.", + "type": "boolean" + }, + "description": { + "description": "An optional text description for the instances that are created from these properties.", + "type": "string" + }, + "disk": { + "description": "An array of disks that are associated with the instances that are created from these properties.", + "items": { + "$ref": "AttachedDisk" + }, + "type": "array" + }, + "guestAccelerator": { + "description": "A list of guest accelerator cards' type and count to use for instances created from these properties.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, + "keyRevocationActionType": { + "description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and \"NONE\". The default value is \"NONE\" if it is not specified.", + "enum": [ + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" + }, + "machineType": { + "description": "The machine type to use for instances that are created from these properties.", + "type": "string" + }, + "metadata": { + "$ref": "Metadata", + "description": "The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information." + }, + "minCpuPlatform": { + "description": "Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform.", + "type": "string" + }, + "networkInterface": { + "description": "An array of network access configurations for this interface.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" + }, + "scheduling": { + "$ref": "Scheduling", + "description": "Specifies the scheduling options for the instances that are created from these properties." + }, + "serviceAccount": { + "description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.", + "items": { + "$ref": "ServiceAccount" + }, + "type": "array" + }, + "sourceInstance": { + "description": "The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance", + "type": "string" + }, + "tags": { + "$ref": "Tags", + "description": "A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt)." + } + }, + "type": "object" + }, + "ComputeInstanceDataSourceProperties": { + "description": "ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource.", + "id": "ComputeInstanceDataSourceProperties", + "properties": { + "description": { + "description": "The description of the Compute Engine instance.", + "type": "string" + }, + "machineType": { + "description": "The machine type of the instance.", + "type": "string" + }, + "name": { + "description": "Name of the compute instance backed up by the datasource.", + "type": "string" + }, + "totalDiskCount": { + "description": "The total number of disks attached to the Instance.", + "format": "int64", + "type": "string" + }, + "totalDiskSizeGb": { + "description": "The sum of all the disk sizes.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ComputeInstanceRestoreProperties": { + "description": "ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore.", + "id": "ComputeInstanceRestoreProperties", + "properties": { + "advancedMachineFeatures": { + "$ref": "AdvancedMachineFeatures", + "description": "Optional. Controls for advanced machine-related behavior features." + }, + "canIpForward": { + "description": "Optional. Allows this instance to send and receive packets with non-matching destination or source IPs.", + "type": "boolean" + }, + "confidentialInstanceConfig": { + "$ref": "ConfidentialInstanceConfig", + "description": "Optional. Controls Confidential compute options on the instance" + }, + "deletionProtection": { + "description": "Optional. Whether the resource should be protected against deletion.", + "type": "boolean" + }, + "description": { + "description": "Optional. An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "disks": { + "description": "Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them.", + "items": { + "$ref": "AttachedDisk" + }, + "type": "array" + }, + "displayDevice": { + "$ref": "DisplayDevice", + "description": "Optional. Enables display device for the instance." + }, + "guestAccelerators": { + "description": "Optional. A list of the type and count of accelerator cards attached to the instance.", + "items": { + "$ref": "AcceleratorConfig" + }, + "type": "array" + }, + "hostname": { + "description": "Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.", + "type": "string" + }, + "instanceEncryptionKey": { + "$ref": "CustomerEncryptionKey", + "description": "Optional. Encrypts suspended data for an instance with a customer-managed encryption key." + }, + "keyRevocationActionType": { + "description": "Optional. KeyRevocationActionType of the instance.", + "enum": [ + "KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED", + "NONE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Indicates user chose no operation.", + "Indicates user chose to opt for VM shutdown on key revocation." + ], + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels to apply to this instance.", + "type": "object" + }, + "machineType": { + "description": "Optional. Full or partial URL of the machine type resource to use for this instance.", + "type": "string" + }, + "metadata": { + "$ref": "Metadata", + "description": "Optional. This includes custom metadata and predefined keys." + }, + "minCpuPlatform": { + "description": "Optional. Minimum CPU platform to use for this instance.", + "type": "string" + }, + "name": { + "description": "Required. Name of the compute instance.", + "type": "string" + }, + "networkInterfaces": { + "description": "Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" + }, + "networkPerformanceConfig": { + "$ref": "NetworkPerformanceConfig", + "description": "Optional. Configure network performance such as egress bandwidth tier." + }, + "params": { + "$ref": "InstanceParams", + "description": "Input only. Additional params passed with the request, but not persisted as part of resource payload." + }, + "privateIpv6GoogleAccess": { + "description": "Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.", + "enum": [ + "INSTANCE_PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED", + "INHERIT_FROM_SUBNETWORK", + "ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE", + "ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.", + "Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before.", + "Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before." + ], + "type": "string" + }, + "reservationAffinity": { + "$ref": "AllocationAffinity", + "description": "Optional. Specifies the reservations that this instance can consume from." + }, + "resourcePolicies": { + "description": "Optional. Resource policies applied to this instance.", + "items": { + "type": "string" + }, + "type": "array" + }, + "scheduling": { + "$ref": "Scheduling", + "description": "Optional. Sets the scheduling options for this instance." + }, + "serviceAccounts": { + "description": "Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.", + "items": { + "$ref": "ServiceAccount" + }, + "type": "array" + }, + "tags": { + "$ref": "Tags", + "description": "Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation." + } + }, + "type": "object" + }, + "ComputeInstanceTargetEnvironment": { + "description": "ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore.", + "id": "ComputeInstanceTargetEnvironment", + "properties": { + "project": { + "description": "Required. Target project for the Compute Engine instance.", + "type": "string" + }, + "zone": { + "description": "Required. The zone of the Compute Engine instance.", + "type": "string" + } + }, + "type": "object" + }, + "ConfidentialInstanceConfig": { + "description": "A set of Confidential Instance options.", + "id": "ConfidentialInstanceConfig", + "properties": { + "enableConfidentialCompute": { + "description": "Optional. Defines whether the instance should have confidential compute enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "CustomerEncryptionKey": { + "description": "A customer-supplied encryption key.", + "id": "CustomerEncryptionKey", + "properties": { + "kmsKeyName": { + "description": "Optional. The name of the encryption key that is stored in Google Cloud KMS.", + "type": "string" + }, + "kmsKeyServiceAccount": { + "description": "Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.", + "type": "string" + }, + "rawKey": { + "description": "Optional. Specifies a 256-bit customer-supplied encryption key.", + "type": "string" + }, + "rsaEncryptedKey": { + "description": "Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource.", + "type": "string" + } + }, + "type": "object" + }, + "DataSource": { + "description": "Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view.", + "id": "DataSource", + "properties": { + "backupConfigInfo": { + "$ref": "BackupConfigInfo", + "description": "Output only. Details of how the resource is configured for backup.", + "readOnly": true + }, + "backupCount": { + "description": "Number of backups in the data source.", + "format": "int64", + "type": "string" + }, + "configState": { + "description": "Output only. The backup configuration state.", + "enum": [ + "BACKUP_CONFIG_STATE_UNSPECIFIED", + "ACTIVE", + "PASSIVE" + ], + "enumDescriptions": [ + "The possible states of backup configuration. Status not set.", + "The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)", + "The data source is no longer protected (but may have backups under it)" + ], + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataSourceBackupApplianceApplication": { + "$ref": "DataSourceBackupApplianceApplication", + "description": "The backed up resource is a backup appliance application." + }, + "dataSourceGcpResource": { + "$ref": "DataSourceGcpResource", + "description": "The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object." + }, + "etag": { + "description": "Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. No labels currently defined:", + "type": "object" + }, + "name": { + "description": "Output only. Identifier. The resource name.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The DataSource resource instance state.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "DELETING", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The data source is being created.", + "The data source has been created and is fully usable.", + "The data source is being deleted.", + "The data source is experiencing an issue and might be unusable." + ], + "readOnly": true, + "type": "string" + }, + "totalStoredBytes": { + "description": "The number of bytes (metadata and data) stored in this datasource.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DataSourceBackupApplianceApplication": { + "description": "BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance.", + "id": "DataSourceBackupApplianceApplication", + "properties": { + "applianceId": { + "description": "Appliance Id of the Backup Appliance.", + "format": "int64", + "type": "string" + }, + "applicationId": { + "description": "The appid field of the application within the Backup Appliance.", + "format": "int64", + "type": "string" + }, + "applicationName": { + "description": "The name of the Application as known to the Backup Appliance.", + "type": "string" + }, + "backupAppliance": { + "description": "Appliance name.", + "type": "string" + }, + "hostId": { + "description": "Hostid of the application host.", + "format": "int64", + "type": "string" + }, + "hostname": { + "description": "Hostname of the host where the application is running.", + "type": "string" + }, + "type": { + "description": "The type of the application. e.g. VMBackup", + "type": "string" + } + }, + "type": "object" + }, + "DataSourceGcpResource": { + "description": "DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource", + "id": "DataSourceGcpResource", + "properties": { + "computeInstanceDatasourceProperties": { + "$ref": "ComputeInstanceDataSourceProperties", + "description": "ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level." + }, + "gcpResourcename": { + "description": "Output only. Full resource pathname URL of the source Google Cloud resource.", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Location of the resource: //\"global\"/\"unspecified\".", + "type": "string" + }, + "type": { + "description": "The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance.", + "type": "string" + } + }, + "type": "object" + }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, + "DisplayDevice": { + "description": "A set of Display Device options", + "id": "DisplayDevice", + "properties": { + "enableDisplay": { + "description": "Optional. Enables display for the Compute Engine VM", + "type": "boolean" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Entry": { + "description": "A key/value pair to be used for storing metadata.", + "id": "Entry", + "properties": { + "key": { + "description": "Optional. Key for the metadata entry.", + "type": "string" + }, + "value": { + "description": "Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).", + "type": "string" + } + }, + "type": "object" + }, + "Expr": { + "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", + "id": "Expr", + "properties": { + "description": { + "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in Common Expression Language syntax.", + "type": "string" + }, + "location": { + "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "title": { + "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "type": "string" + } + }, + "type": "object" + }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, + "FetchAccessTokenRequest": { + "description": "Request message for FetchAccessToken.", + "id": "FetchAccessTokenRequest", + "properties": { + "generationId": { + "description": "Required. The generation of the backup to update.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "FetchAccessTokenResponse": { + "description": "Response message for FetchAccessToken.", + "id": "FetchAccessTokenResponse", + "properties": { + "expireTime": { + "description": "The token is valid until this time.", + "format": "google-datetime", + "type": "string" + }, + "readLocation": { + "description": "The location in bucket that can be used for reading.", + "type": "string" + }, + "token": { + "description": "The downscoped token that was created.", + "type": "string" + }, + "writeLocation": { + "description": "The location in bucket that can be used for writing.", + "type": "string" + } + }, + "type": "object" + }, + "FetchUsableBackupVaultsResponse": { + "description": "Response message for fetching usable BackupVaults.", + "id": "FetchUsableBackupVaultsResponse", + "properties": { + "backupVaults": { + "description": "The list of BackupVault instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "BackupVault" + }, + "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" + }, + "FinalizeBackupRequest": { + "description": "Message for finalizing a Backup.", + "id": "FinalizeBackupRequest", + "properties": { + "backupId": { + "description": "Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.", + "type": "string" + }, + "consistencyTime": { + "description": "The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "This will be assigned to the description field of the newly created Backup.", + "type": "string" + }, + "recoveryRangeEndTime": { + "description": "The latest timestamp of data available in this Backup. This will be set on the newly created Backup.", + "format": "google-datetime", + "type": "string" + }, + "recoveryRangeStartTime": { + "description": "The earliest timestamp of data available in this Backup. This will set on the newly created Backup.", + "format": "google-datetime", + "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).", + "type": "string" + }, + "retentionDuration": { + "description": "The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "GCPBackupPlanInfo": { + "description": "GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup.", + "id": "GCPBackupPlanInfo", + "properties": { + "backupPlan": { + "description": "Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}", + "type": "string" + }, + "backupPlanRuleId": { + "description": "The rule id of the backup plan which triggered this backup in case of scheduled backup or used for", + "type": "string" + } + }, + "type": "object" + }, + "GcpBackupConfig": { + "description": "GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations.", + "id": "GcpBackupConfig", + "properties": { + "backupPlan": { + "description": "The name of the backup plan.", + "type": "string" + }, + "backupPlanAssociation": { + "description": "The name of the backup plan association.", + "type": "string" + }, + "backupPlanDescription": { + "description": "The description of the backup plan.", + "type": "string" + }, + "backupPlanRules": { + "description": "The names of the backup plan rules which point to this backupvault", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GuestOsFeature": { + "description": "Feature type of the Guest OS.", + "id": "GuestOsFeature", + "properties": { + "type": { + "description": "The ID of a supported feature.", + "enum": [ + "FEATURE_TYPE_UNSPECIFIED", + "VIRTIO_SCSI_MULTIQUEUE", + "WINDOWS", + "MULTI_IP_SUBNET", + "UEFI_COMPATIBLE", + "SECURE_BOOT", + "GVNIC", + "SEV_CAPABLE", + "BARE_METAL_LINUX_COMPATIBLE", + "SUSPEND_RESUME_COMPATIBLE", + "SEV_LIVE_MIGRATABLE", + "SEV_SNP_CAPABLE", + "TDX_CAPABLE", + "IDPF", + "SEV_LIVE_MIGRATABLE_V2" + ], + "enumDescriptions": [ + "Default value, which is unused.", + "VIRTIO_SCSI_MULTIQUEUE feature type.", + "WINDOWS feature type.", + "MULTI_IP_SUBNET feature type.", + "UEFI_COMPATIBLE feature type.", + "SECURE_BOOT feature type.", + "GVNIC feature type.", + "SEV_CAPABLE feature type.", + "BARE_METAL_LINUX_COMPATIBLE feature type.", + "SUSPEND_RESUME_COMPATIBLE feature type.", + "SEV_LIVE_MIGRATABLE feature type.", + "SEV_SNP_CAPABLE feature type.", + "TDX_CAPABLE feature type.", + "IDPF feature type.", + "SEV_LIVE_MIGRATABLE_V2 feature type." + ], + "type": "string" + } + }, + "type": "object" + }, + "InitializeParams": { + "description": "Specifies the parameters to initialize this disk.", + "id": "InitializeParams", + "properties": { + "diskName": { + "description": "Optional. Specifies the disk name. If not specified, the default is to use the name of the instance.", + "type": "string" + }, + "replicaZones": { + "description": "Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InitiateBackupRequest": { + "description": "request message for InitiateBackup.", + "id": "InitiateBackupRequest", + "properties": { + "backupId": { + "description": "Required. Resource ID of the Backup resource.", + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "InitiateBackupResponse": { + "description": "Response message for InitiateBackup.", + "id": "InitiateBackupResponse", + "properties": { + "backup": { + "description": "The name of the backup that was created.", + "type": "string" + }, + "baseBackupGenerationId": { + "description": "The generation id of the base backup. It is needed for the incremental backups.", + "format": "int32", + "type": "integer" + }, + "newBackupGenerationId": { + "description": "The generation id of the new backup.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "InstanceParams": { + "description": "Additional instance params.", + "id": "InstanceParams", + "properties": { + "resourceManagerTags": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource manager tags to be bound to the instance.", + "type": "object" + } + }, + "type": "object" + }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "requirementOverride": { + "$ref": "RequirementOverride", + "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." + }, + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" } - } - } - }, - "revision": "20240522", - "rootUrl": "https://backupdr.googleapis.com/", - "schemas": { - "AuditConfig": { - "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", - "id": "AuditConfig", + }, + "type": "object" + }, + "ListBackupPlanAssociationsResponse": { + "description": "Response message for List BackupPlanAssociation", + "id": "ListBackupPlanAssociationsResponse", "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.", + "backupPlanAssociations": { + "description": "The list of Backup Plan Associations in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", "items": { - "$ref": "AuditLogConfig" + "$ref": "BackupPlanAssociation" }, "type": "array" }, - "service": { - "description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.", + "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" }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions. Example: { \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.", - "id": "AuditLogConfig", + "ListBackupPlansResponse": { + "description": "The response message for getting a list of `BackupPlan`.", + "id": "ListBackupPlansResponse", "properties": { - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.", + "backupPlans": { + "description": "The list of `BackupPlans` in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan", "items": { - "type": "string" + "$ref": "BackupPlan" }, "type": "array" }, - "logType": { - "description": "The log type that this config enables.", - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ], - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], + "nextPageToken": { + "description": "A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.", "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "Binding": { - "description": "Associates `members`, or principals, with a `role`.", - "id": "Binding", + "ListBackupVaultsResponse": { + "description": "Response message for listing BackupVaults.", + "id": "ListBackupVaultsResponse", "properties": { - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)." - }, - "members": { - "description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", + "backupVaults": { + "description": "The list of BackupVault instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", "items": { - "type": "string" + "$ref": "BackupVault" }, "type": "array" }, - "role": { - "description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).", + "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" }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "id": "CancelOperationRequest", - "properties": {}, - "type": "object" - }, - "Empty": { - "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", - "id": "Empty", - "properties": {}, - "type": "object" - }, - "Expr": { - "description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() < 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.", - "id": "Expr", + "ListBackupsResponse": { + "description": "Response message for listing Backups.", + "id": "ListBackupsResponse", "properties": { - "description": { - "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", - "type": "string" + "backups": { + "description": "The list of Backup instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "Backup" + }, + "type": "array" }, - "expression": { - "description": "Textual representation of an expression in Common Expression Language syntax.", + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", "type": "string" }, - "location": { - "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", - "type": "string" + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListDataSourcesResponse": { + "description": "Response message for listing DataSources.", + "id": "ListDataSourcesResponse", + "properties": { + "dataSources": { + "description": "The list of DataSource instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "DataSource" + }, + "type": "array" }, - "title": { - "description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.", + "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" @@ -666,7 +3698,7 @@ "id": "ListManagementServersResponse", "properties": { "managementServers": { - "description": "The list of ManagementServer instances in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "description": "The list of ManagementServer instances in the project for the specified location. If the '{location}' value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", "items": { "$ref": "ManagementServer" }, @@ -738,6 +3770,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "ManagementServer": { "description": "ManagementServer describes a single BackupDR ManagementServer instance.", "id": "ManagementServer", @@ -789,7 +3879,7 @@ "type": "array" }, "oauth2ClientId": { - "description": "Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).", + "description": "Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).", "readOnly": true, "type": "string" }, @@ -876,25 +3966,197 @@ }, "type": "object" }, - "NetworkConfig": { - "description": "Network configuration for ManagementServer instance.", - "id": "NetworkConfig", + "Metadata": { + "description": "A metadata key/value entry.", + "id": "Metadata", + "properties": { + "items": { + "description": "Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB.", + "items": { + "$ref": "Entry" + }, + "type": "array" + } + }, + "type": "object" + }, + "NetworkConfig": { + "description": "Network configuration for ManagementServer instance.", + "id": "NetworkConfig", + "properties": { + "network": { + "description": "Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.", + "type": "string" + }, + "peeringMode": { + "description": "Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.", + "enum": [ + "PEERING_MODE_UNSPECIFIED", + "PRIVATE_SERVICE_ACCESS" + ], + "enumDescriptions": [ + "Peering mode not set.", + "Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Cloud BackupDR." + ], + "type": "string" + } + }, + "type": "object" + }, + "NetworkInterface": { + "description": "A network interface resource attached to an instance. s", + "id": "NetworkInterface", + "properties": { + "accessConfigs": { + "description": "Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" + }, + "aliasIpRanges": { + "description": "Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.", + "items": { + "$ref": "AliasIpRange" + }, + "type": "array" + }, + "internalIpv6PrefixLength": { + "description": "Optional. The prefix length of the primary internal IPv6 range.", + "format": "int32", + "type": "integer" + }, + "ipv6AccessConfigs": { + "description": "Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.", + "items": { + "$ref": "AccessConfig" + }, + "type": "array" + }, + "ipv6AccessType": { + "description": "Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork.", + "enum": [ + "UNSPECIFIED_IPV6_ACCESS_TYPE", + "INTERNAL", + "EXTERNAL" + ], + "enumDescriptions": [ + "IPv6 access type not set. Means this network interface hasn't been turned on IPv6 yet.", + "This network interface can have internal IPv6.", + "This network interface can have external IPv6." + ], + "type": "string" + }, + "ipv6Address": { + "description": "Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork.", + "type": "string" + }, + "name": { + "description": "Output only. [Output Only] The name of the network interface, which is generated by the server.", + "readOnly": true, + "type": "string" + }, + "network": { + "description": "Optional. URL of the VPC network resource for this instance.", + "type": "string" + }, + "networkAttachment": { + "description": "Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.", + "type": "string" + }, + "networkIP": { + "description": "Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.", + "type": "string" + }, + "nicType": { + "description": "Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.", + "enum": [ + "NIC_TYPE_UNSPECIFIED", + "VIRTIO_NET", + "GVNIC" + ], + "enumDescriptions": [ + "Default should be NIC_TYPE_UNSPECIFIED.", + "VIRTIO", + "GVNIC" + ], + "type": "string" + }, + "queueCount": { + "description": "Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users.", + "format": "int32", + "type": "integer" + }, + "stackType": { + "description": "The stack type for this network interface.", + "enum": [ + "STACK_TYPE_UNSPECIFIED", + "IPV4_ONLY", + "IPV4_IPV6" + ], + "enumDescriptions": [ + "Default should be STACK_TYPE_UNSPECIFIED.", + "The network interface will be assigned IPv4 address.", + "The network interface can have both IPv4 and IPv6 addresses." + ], + "type": "string" + }, + "subnetwork": { + "description": "Optional. The URL of the Subnetwork resource for this instance.", + "type": "string" + } + }, + "type": "object" + }, + "NetworkPerformanceConfig": { + "description": "Network performance configuration.", + "id": "NetworkPerformanceConfig", + "properties": { + "totalEgressBandwidthTier": { + "description": "Optional. The tier of the total egress bandwidth.", + "enum": [ + "TIER_UNSPECIFIED", + "DEFAULT", + "TIER_1" + ], + "enumDescriptions": [ + "This value is unused.", + "Default network performance config.", + "Tier 1 network performance config." + ], + "type": "string" + } + }, + "type": "object" + }, + "NodeAffinity": { + "description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.", + "id": "NodeAffinity", "properties": { - "network": { - "description": "Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.", + "key": { + "description": "Optional. Corresponds to the label key of Node resource.", "type": "string" }, - "peeringMode": { - "description": "Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.", + "operator": { + "description": "Optional. Defines the operation of node selection.", "enum": [ - "PEERING_MODE_UNSPECIFIED", - "PRIVATE_SERVICE_ACCESS" + "OPERATOR_UNSPECIFIED", + "IN", + "NOT_IN" ], "enumDescriptions": [ - "Peering mode not set.", - "Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Cloud BackupDR." + "Default value. This value is unused.", + "Requires Compute Engine to seek for matched nodes.", + "Requires Compute Engine to avoid certain nodes." ], "type": "string" + }, + "values": { + "description": "Optional. Corresponds to the label values of Node resource.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -964,7 +4226,7 @@ "type": "string" }, "requestedCancellation": { - "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'.", "readOnly": true, "type": "boolean" }, @@ -986,6 +4248,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -1017,6 +4290,255 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, + "RemoveDataSourceRequest": { + "description": "Message for deleting a DataSource.", + "id": "RemoveDataSourceRequest", + "properties": { + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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).", + "type": "string" + } + }, + "type": "object" + }, + "RequirementOverride": { + "id": "RequirementOverride", + "properties": { + "ziOverride": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zsOverride": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "RestoreBackupRequest": { + "description": "Request message for restoring from a Backup.", + "id": "RestoreBackupRequest", + "properties": { + "computeInstanceRestoreProperties": { + "$ref": "ComputeInstanceRestoreProperties", + "description": "Compute Engine instance properties to be overridden during restore." + }, + "computeInstanceTargetEnvironment": { + "$ref": "ComputeInstanceTargetEnvironment", + "description": "Compute Engine target environment to be used during restore." + }, + "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).", + "type": "string" + } + }, + "type": "object" + }, + "RuleConfigInfo": { + "description": "Message for rules config info.", + "id": "RuleConfigInfo", + "properties": { + "lastBackupError": { + "$ref": "Status", + "description": "Output only. Output Only. google.rpc.Status object to store the last backup error.", + "readOnly": true + }, + "lastBackupState": { + "description": "Output only. The last backup state for rule.", + "enum": [ + "LAST_BACKUP_STATE_UNSPECIFIED", + "FIRST_BACKUP_PENDING", + "PERMISSION_DENIED", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "State not set.", + "The first backup is pending.", + "The most recent backup could not be run/failed because of the lack of permissions.", + "The last backup operation succeeded.", + "The last backup operation failed." + ], + "readOnly": true, + "type": "string" + }, + "lastSuccessfulBackupConsistencyTime": { + "description": "Output only. The point in time when the last successful backup was captured from the source.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "ruleId": { + "description": "Output only. Output Only. Backup Rule id fetched from backup plan.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Scheduling": { + "description": "Sets the scheduling options for an Instance.", + "id": "Scheduling", + "properties": { + "automaticRestart": { + "description": "Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).", + "type": "boolean" + }, + "instanceTerminationAction": { + "description": "Optional. Specifies the termination action for the instance.", + "enum": [ + "INSTANCE_TERMINATION_ACTION_UNSPECIFIED", + "DELETE", + "STOP" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Delete the VM.", + "Stop the VM without storing in-memory content. default action." + ], + "type": "string" + }, + "localSsdRecoveryTimeout": { + "$ref": "SchedulingDuration", + "description": "Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour." + }, + "minNodeCpus": { + "description": "Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.", + "format": "int32", + "type": "integer" + }, + "nodeAffinities": { + "description": "Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity.", + "items": { + "$ref": "NodeAffinity" + }, + "type": "array" + }, + "onHostMaintenance": { + "description": "Optional. Defines the maintenance behavior for this instance.", + "enum": [ + "ON_HOST_MAINTENANCE_UNSPECIFIED", + "TERMINATE", + "MIGRATE" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity.", + "Default, Allows Compute Engine to automatically migrate instances out of the way of maintenance events." + ], + "type": "string" + }, + "preemptible": { + "description": "Optional. Defines whether the instance is preemptible.", + "type": "boolean" + }, + "provisioningModel": { + "description": "Optional. Specifies the provisioning model of the instance.", + "enum": [ + "PROVISIONING_MODEL_UNSPECIFIED", + "STANDARD", + "SPOT" + ], + "enumDescriptions": [ + "Default value. This value is not used.", + "Standard provisioning with user controlled runtime, no discounts.", + "Heavily discounted, no guaranteed runtime." + ], + "type": "string" + } + }, + "type": "object" + }, + "SchedulingDuration": { + "description": "A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years.", + "id": "SchedulingDuration", + "properties": { + "nanos": { + "description": "Optional. Span of time that's a fraction of a second at nanosecond resolution.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Optional. Span of time at a resolution of a second.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "ServiceAccount": { + "description": "A service account.", + "id": "ServiceAccount", + "properties": { + "email": { + "description": "Optional. Email address of the service account.", + "type": "string" + }, + "scopes": { + "description": "Optional. The list of scopes to be made available for this service account.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ServiceLockInfo": { + "description": "ServiceLockInfo represents the details of a lock taken by the service on a Backup resource.", + "id": "ServiceLockInfo", + "properties": { + "operation": { + "description": "Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -1033,6 +4555,173 @@ }, "type": "object" }, + "SetInternalStatusRequest": { + "description": "Request message for SetStatusInternal method.", + "id": "SetInternalStatusRequest", + "properties": { + "backupConfigState": { + "description": "Required. Output only. The new BackupConfigState to set for the DataSource.", + "enum": [ + "BACKUP_CONFIG_STATE_UNSPECIFIED", + "ACTIVE", + "PASSIVE" + ], + "enumDescriptions": [ + "The possible states of backup configuration. Status not set.", + "The data source is actively protected (i.e. there is a BackupPlanAssociation or Appliance SLA pointing to it)", + "The data source is no longer protected (but may have backups under it)" + ], + "readOnly": 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + }, + "value": { + "description": "Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "StandardSchedule": { + "description": "`StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY.", + "id": "StandardSchedule", + "properties": { + "backupWindow": { + "$ref": "BackupWindow", + "description": "Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window." + }, + "daysOfMonth": { + "description": "Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "daysOfWeek": { + "description": "Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`.", + "items": { + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "type": "array" + }, + "hourlyFrequency": { + "description": "Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 6 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario).", + "format": "int32", + "type": "integer" + }, + "months": { + "description": "Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied.", + "items": { + "enum": [ + "MONTH_UNSPECIFIED", + "JANUARY", + "FEBRUARY", + "MARCH", + "APRIL", + "MAY", + "JUNE", + "JULY", + "AUGUST", + "SEPTEMBER", + "OCTOBER", + "NOVEMBER", + "DECEMBER" + ], + "enumDescriptions": [ + "The unspecified month.", + "The month of January.", + "The month of February.", + "The month of March.", + "The month of April.", + "The month of May.", + "The month of June.", + "The month of July.", + "The month of August.", + "The month of September.", + "The month of October.", + "The month of November.", + "The month of December." + ], + "type": "string" + }, + "type": "array" + }, + "recurrenceType": { + "description": "Required. Specifies the `RecurrenceType` for the schedule.", + "enum": [ + "RECURRENCE_TYPE_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "YEARLY" + ], + "enumDescriptions": [ + "recurrence type not set", + "The `BackupRule` is to be applied hourly.", + "The `BackupRule` is to be applied daily.", + "The `BackupRule` is to be applied weekly.", + "The `BackupRule` is to be applied monthly.", + "The `BackupRule` is to be applied yearly." + ], + "type": "string" + }, + "timeZone": { + "description": "Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris.", + "type": "string" + }, + "weekDayOfMonth": { + "$ref": "WeekDayOfMonth", + "description": "Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied." + } + }, + "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", @@ -1060,6 +4749,32 @@ }, "type": "object" }, + "Tags": { + "description": "A set of instance tags.", + "id": "Tags", + "properties": { + "items": { + "description": "Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -1088,6 +4803,72 @@ }, "type": "object" }, + "TriggerBackupRequest": { + "description": "Request message for triggering a backup.", + "id": "TriggerBackupRequest", + "properties": { + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes 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).", + "type": "string" + }, + "ruleId": { + "description": "Required. backup rule_id for which a backup needs to be triggered.", + "type": "string" + } + }, + "type": "object" + }, + "WeekDayOfMonth": { + "description": "`WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`.", + "id": "WeekDayOfMonth", + "properties": { + "dayOfWeek": { + "description": "Required. Specifies the day of the week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "weekOfMonth": { + "description": "Required. Specifies the week of the month.", + "enum": [ + "WEEK_OF_MONTH_UNSPECIFIED", + "FIRST", + "SECOND", + "THIRD", + "FOURTH", + "LAST" + ], + "enumDescriptions": [ + "The zero value. Do not use.", + "The first week of the month.", + "The second week of the month.", + "The third week of the month.", + "The fourth week of the month.", + "The last week of the month." + ], + "type": "string" + } + }, + "type": "object" + }, "WorkforceIdentityBasedManagementURI": { "description": "ManagementURI depending on the Workforce Identity i.e. either 1p or 3p.", "id": "WorkforceIdentityBasedManagementURI", @@ -1121,6 +4902,15 @@ } }, "type": "object" + }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index 53584d56d8..2bd285e205 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -561,7 +561,7 @@ } } }, - "revision": "20240612", + "revision": "20240801", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1031,7 +1031,7 @@ "type": "object" }, "Barrier": { - "description": "Barrier runnable blocks until all tasks in a taskgroup reach it.", + "description": "A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier.", "id": "Barrier", "properties": { "name": { @@ -1089,7 +1089,7 @@ "type": "boolean" }, "commands": { - "description": "Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT.", + "description": "Required for some container images. Overrides the `CMD` specified in the container. If there is an `ENTRYPOINT` (either in the container image or with the `entrypoint` field below) then these commands are appended as arguments to the `ENTRYPOINT`.", "items": { "type": "string" }, @@ -1100,15 +1100,15 @@ "type": "boolean" }, "entrypoint": { - "description": "Overrides the `ENTRYPOINT` specified in the container.", + "description": "Required for some container images. Overrides the `ENTRYPOINT` specified in the container.", "type": "string" }, "imageUri": { - "description": "The URI to pull the container image from.", + "description": "Required. The URI to pull the container image from.", "type": "string" }, "options": { - "description": "Arbitrary additional options to include in the \"docker run\" command when running this container, e.g. \"--network host\".", + "description": "Required for some container images. Arbitrary additional options to include in the `docker run` command when running this container—for example, `--network host`. For the `--volume` option, use the `volumes` field for the container.", "type": "string" }, "password": { @@ -1120,7 +1120,7 @@ "type": "string" }, "volumes": { - "description": "Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the `TaskSpec.Volumes` field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in `TaskSpec.Volumes`. If you need different mount settings, you can explicitly configure them in this field.", + "description": "Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match `--volume` option for the `docker run` command—for example, `/foo:/bar` or `/foo:/bar:ro`. If the `TaskSpec.Volumes` field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (`ro`) for existing persistent disks and read-write (`rw`) for other volume types, regardless of the original mount options specified in `TaskSpec.Volumes`. If you need different mount settings, you can explicitly configure them in this field.", "items": { "type": "string" }, @@ -1138,7 +1138,7 @@ "type": "string" }, "image": { - "description": "URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * `batch-debian`: use Batch Debian images. * `batch-centos`: use Batch CentOS images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-centos`: use Batch HPC CentOS images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.", + "description": "URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project}/global/images/family/{image_family} * Specify the image version: projects/{project}/global/images/{image_version} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * `batch-debian`: use Batch Debian images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images.", "type": "string" }, "sizeGb": { @@ -1907,7 +1907,7 @@ "type": "boolean" }, "background": { - "description": "This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers).", + "description": "Normally, a runnable that doesn't exit causes its task to fail. However, you can set this field to `true` to configure a background runnable. Background runnables are allowed continue running in the background while the task executes subsequent runnables. For example, background runnables are useful for providing services to other runnables or providing debugging-support tools like SSH servers. Specifically, background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as task failures.", "type": "boolean" }, "barrier": { @@ -1927,7 +1927,7 @@ "description": "Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup)." }, "ignoreExitStatus": { - "description": "Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead.", + "description": "Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to `true` to allow the task to continue executing its other runnables even if this runnable fails.", "type": "boolean" }, "labels": { @@ -1954,11 +1954,11 @@ "id": "Script", "properties": { "path": { - "description": "Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be executed by `/bin/sh`.", + "description": "The path to a script file that is accessible from the host VM(s). Unless the script file supports the default `#!/bin/sh` shell interpreter, you must specify an interpreter by including a [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the first line of the file. For example, to execute the script using bash, include `#!/bin/bash` as the first line of the file. Alternatively, to execute the script using Python3, include `#!/usr/bin/env python3` as the first line of the file.", "type": "string" }, "text": { - "description": "Shell script text. To specify an interpreter, please add a `#!\\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\\n` should be added.) Otherwise, the script will by default be executed by `/bin/sh`.", + "description": "The text for a script. Unless the script text supports the default `#!/bin/sh` shell interpreter, you must specify an interpreter by including a [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the beginning of the text. For example, to execute the script using bash, include `#!/bin/bash\\n` at the beginning of the text. Alternatively, to execute the script using Python3, include `#!/usr/bin/env python3\\n` at the beginning of the text.", "type": "string" } }, @@ -2010,7 +2010,7 @@ "type": "object" }, "StatusEvent": { - "description": "Status event", + "description": "Status event.", "id": "StatusEvent", "properties": { "description": { @@ -2024,10 +2024,10 @@ }, "taskExecution": { "$ref": "TaskExecution", - "description": "Task Execution" + "description": "Task Execution. This field is only defined for task-level status events where the task fails." }, "taskState": { - "description": "Task State", + "description": "Task State. This field is only defined for task-level status events.", "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -2206,7 +2206,7 @@ "type": "string" }, "runnables": { - "description": "The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures.", + "description": "Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + The runnable exited with a zero status. + The runnable didn't finish, but you enabled its `background` subfield. + The runnable exited with a non-zero status, but you enabled its `ignore_exit_status` subfield.", "items": { "$ref": "Runnable" }, @@ -2223,11 +2223,11 @@ "type": "object" }, "TaskStatus": { - "description": "Status of a task", + "description": "Status of a task.", "id": "TaskStatus", "properties": { "state": { - "description": "Task state", + "description": "Task state.", "enum": [ "STATE_UNSPECIFIED", "PENDING", diff --git a/discovery/beyondcorp-v1.json b/discovery/beyondcorp-v1.json index 76803d2b65..0bf72b7f61 100644 --- a/discovery/beyondcorp-v1.json +++ b/discovery/beyondcorp-v1.json @@ -1464,6 +1464,43 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "shouldThrottle": { + "description": "Calls the Bouncer method ShouldThrottle to check if a request should be throttled.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:shouldThrottle", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.appGateways.shouldThrottle", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", + "required": true, + "type": "string" + }, + "port": { + "description": "Optional. The port that is being throttled", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestedAmount": { + "description": "Optional. The current throughput through the port (mbps)", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}:shouldThrottle", + "response": { + "$ref": "ShouldThrottleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions", @@ -1804,7 +1841,7 @@ } } }, - "revision": "20240424", + "revision": "20240802", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -3410,6 +3447,17 @@ }, "type": "object" }, + "ShouldThrottleResponse": { + "description": "Response message for calling ShouldThrottle", + "id": "ShouldThrottleResponse", + "properties": { + "shouldThrottle": { + "description": "Whether the port should be throttled", + "type": "boolean" + } + }, + "type": "object" + }, "Tunnelv1ProtoTunnelerError": { "description": "TunnelerError is an error proto for errors returned by the connection manager.", "id": "Tunnelv1ProtoTunnelerError", diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index 93237a02f0..53e4fe2b9f 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -1027,8 +1027,35 @@ "parent" ], "parameters": { + "aggregation": { + "description": "Optional. Aggregation type. The default is 'DAILY'.", + "enum": [ + "AGGREGATION_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "CUSTOM_DATE_RANGE" + ], + "enumDescriptions": [ + "Unspecified.", + "Insight should be aggregated at hourly level.", + "Insight should be aggregated at daily level.", + "Insight should be aggregated at weekly level.", + "Insight should be aggregated at monthly level.", + "Insight should be aggregated at the custom date range passed in as the start and end time in the request." + ], + "location": "query", + "type": "string" + }, + "endTime": { + "description": "Optional. Ending time for the duration for which insights are to be pulled. The default is the current time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, "filter": { - "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -1055,6 +1082,12 @@ "required": true, "type": "string" }, + "startTime": { + "description": "Optional. Starting time for the duration for which insights are to be pulled. The default is 7 days before the current time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, "view": { "description": "Required. List only metadata or full data.", "enum": [ @@ -1231,7 +1264,10 @@ "path": "v1alpha/{+name}:cancel", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaCancelSubscriptionResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "create": { "description": "Creates a new BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.", @@ -1256,7 +1292,10 @@ }, "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "get": { "description": "Gets details of a single Subscription.", @@ -1278,7 +1317,10 @@ "path": "v1alpha/{+name}", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "list": { "description": "Lists Subscriptions in a given organization and location.", @@ -1311,7 +1353,10 @@ "path": "v1alpha/{+parent}/subscriptions", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaListSubscriptionsResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "patch": { "description": "Updates an existing BeyondCorp Enterprise Subscription in a given organization. Location will always be global as BeyondCorp subscriptions are per organization.", @@ -1347,7 +1392,10 @@ }, "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaSubscription" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "restart": { "description": "Restarts an existing BeyondCorp Enterprise Subscription in a given organization, that is scheduled for cancellation. Location will always be global as BeyondCorp subscriptions are per organization. Returns the timestamp for when the cancellation will become effective", @@ -1374,7 +1422,10 @@ "path": "v1alpha/{+name}:restart", "response": { "$ref": "GoogleCloudBeyondcorpSaasplatformSubscriptionsV1alphaRestartSubscriptionResponse" - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -2331,6 +2382,43 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "shouldThrottle": { + "description": "Calls the Bouncer method ShouldThrottle to check if a request should be throttled.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:shouldThrottle", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.appGateways.shouldThrottle", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/appGateways/[^/]+$", + "required": true, + "type": "string" + }, + "port": { + "description": "Optional. The port that is being throttled", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestedAmount": { + "description": "Optional. The current throughput through the port (mbps)", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}:shouldThrottle", + "response": { + "$ref": "ShouldThrottleResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/appGateways/{appGatewaysId}:testIamPermissions", @@ -3392,6 +3480,232 @@ } } }, + "global": { + "resources": { + "securityGateways": { + "resources": { + "applications": { + "methods": { + "create": { + "description": "Creates a new Application in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.global.securityGateways.applications.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "applicationId": { + "description": "Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", + "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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/applications", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Application.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}", + "httpMethod": "PATCH", + "id": "beyondcorp.projects.locations.global.securityGateways.applications.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed 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. Mutable fields include: display_name.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/applications/{applicationsId}:testIamPermissions", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.global.securityGateways.applications.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "hubs": { + "methods": { + "create": { + "description": "Creates a new Hub in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.global.securityGateways.hubs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "hubId": { + "description": "Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+$", + "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 request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/hubs", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Hub.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}", + "httpMethod": "PATCH", + "id": "beyondcorp.projects.locations.global.securityGateways.hubs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$", + "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 timed 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. Mutable fields include: display_name.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1alpha/projects/{projectsId}/locations/global/securityGateways/{securityGatewaysId}/hubs/{hubsId}:testIamPermissions", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.global.securityGateways.hubs.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/global/securityGateways/[^/]+/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "insights": { "methods": { "configuredInsight": { @@ -3533,8 +3847,35 @@ "parent" ], "parameters": { + "aggregation": { + "description": "Optional. Aggregation type. The default is 'DAILY'.", + "enum": [ + "AGGREGATION_UNSPECIFIED", + "HOURLY", + "DAILY", + "WEEKLY", + "MONTHLY", + "CUSTOM_DATE_RANGE" + ], + "enumDescriptions": [ + "Unspecified.", + "Insight should be aggregated at hourly level.", + "Insight should be aggregated at daily level.", + "Insight should be aggregated at weekly level.", + "Insight should be aggregated at monthly level.", + "Insight should be aggregated at the custom date range passed in as the start and end time in the request." + ], + "location": "query", + "type": "string" + }, + "endTime": { + "description": "Optional. Ending time for the duration for which insights are to be pulled. The default is the current time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, "filter": { - "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", + "description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -3561,6 +3902,12 @@ "required": true, "type": "string" }, + "startTime": { + "description": "Optional. Starting time for the duration for which insights are to be pulled. The default is 7 days before the current time.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, "view": { "description": "Required. List only metadata or full data.", "enum": [ @@ -4045,33 +4392,255 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:testIamPermissions", - "httpMethod": "POST", - "id": "beyondcorp.projects.locations.securityGateways.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", - "required": true, - "type": "string" + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}:testIamPermissions", + "httpMethod": "POST", + "id": "beyondcorp.projects.locations.securityGateways.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "applications": { + "methods": { + "delete": { + "description": "Deletes a single Application.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", + "httpMethod": "DELETE", + "id": "beyondcorp.projects.locations.securityGateways.applications.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Application.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications/{applicationsId}", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.applications.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Application using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/applications/{application_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/applications/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Applications in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/applications", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.applications.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName \"test-application\" For more information, please refer to https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous ListHubsRequest, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/applications", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "hubs": { + "methods": { + "delete": { + "description": "Deletes a single Hub.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}", + "httpMethod": "DELETE", + "id": "beyondcorp.projects.locations.securityGateways.hubs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$", + "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" + }, + "validateOnly": { + "description": "Optional. If set, validates request by executing a dry-run which would not alter the resource in any way.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Hub.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs/{hubsId}", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.hubs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Hub using the form: `projects/{project_id}/locations/global/securityGateway/{security_gateway_id}/hubs/{hub_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+/hubs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Hubs in a given project and location.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/securityGateways/{securityGatewaysId}/hubs", + "httpMethod": "GET", + "id": "beyondcorp.projects.locations.securityGateways.hubs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName \"test-hub\" For more information, please refer to https://google.aip.dev/160.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous ListHubsRequest, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location to which the resources belong. `projects/{project_id}/locations/global/securityGateways/{security_gateway_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/securityGateways/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/hubs", + "response": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } - }, - "path": "v1alpha/{+resource}:testIamPermissions", - "request": { - "$ref": "GoogleIamV1TestIamPermissionsRequest" - }, - "response": { - "$ref": "GoogleIamV1TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + } } } } @@ -4080,7 +4649,7 @@ } } }, - "revision": "20240619", + "revision": "20240807", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -6254,6 +6823,197 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication": { + "description": "A Beyondcorp Application resource information.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication", + "properties": { + "applicationMatchFilter": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter", + "description": "Required. Application filter conditions associated with an application." + }, + "createTime": { + "description": "Output only. Timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter": { + "description": "Match Criteria for Application Filtering.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter", + "properties": { + "matchConditions": { + "description": "Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - (\"*.abc.com\"), (\"xyz.abc.com\") FQDN and PORTS - (\"abc.com\" and \"22\"), (\"abc.com\" and \"22,33)\" etc IP_ADDRESS - (\"10.20.30.40\"), (\"100.20.30.40\") IP_ADDRESS and PORTS - (\"10.20.30.40\" and \"4\"), (\"10.20.30.40\" and \"4,5\")", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition": { + "description": "Match condition for idenfying the application.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition", + "properties": { + "fqdn": { + "description": "Optional. FQDN of the application.", + "type": "string" + }, + "ipAddress": { + "description": "Optional. IP Address of the application.", + "type": "string" + }, + "ports": { + "description": "Optional. Ports of the application.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub": { + "description": "A Beyondcorp Hub resource information.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub", + "properties": { + "createTime": { + "description": "Output only. Timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource.", + "type": "string" + }, + "natGatewayConfig": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig", + "description": "Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits." + }, + "state": { + "description": "Output only. The operational state of the Hub.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "UPDATING", + "DELETING", + "RUNNING", + "DOWN", + "ERROR" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "Hub is being created.", + "Hub is being updated.", + "Hub is being deleted.", + "Hub is running.", + "Hub is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.", + "Hub encountered an error and is in an indeterministic state." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when the resource was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig": { + "description": "Represents the NAT Gateway configuration.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig", + "properties": { + "enableNatGateway": { + "description": "Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected.", + "type": "boolean" + }, + "natIps": { + "description": "Output only. List of NAT IPs that will be used for establishing connection to the endpoints.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse": { + "description": "Message for response to listing Applications.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse", + "properties": { + "applications": { + "description": "A list of BeyondCorp Application in the project.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "A list of locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse": { + "description": "Message for response to listing Hubs.", + "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse", + "properties": { + "hubs": { + "description": "A list of BeyondCorp Hub in the project.", + "items": { + "$ref": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "A list of locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse": { "description": "Message for response to listing SecurityGateways.", "id": "GoogleCloudBeyondcorpSecuritygatewaysV1alphaListSecurityGatewaysResponse", @@ -6920,6 +7680,17 @@ }, "type": "object" }, + "ShouldThrottleResponse": { + "description": "Response message for calling ShouldThrottle", + "id": "ShouldThrottleResponse", + "properties": { + "shouldThrottle": { + "description": "Whether the port should be throttled", + "type": "boolean" + } + }, + "type": "object" + }, "Tunnelv1ProtoTunnelerError": { "description": "TunnelerError is an error proto for errors returned by the connection manager.", "id": "Tunnelv1ProtoTunnelerError", diff --git a/discovery/bigquery-v2.json b/discovery/bigquery-v2.json index 0e212edaf9..9cf886f077 100644 --- a/discovery/bigquery-v2.json +++ b/discovery/bigquery-v2.json @@ -289,7 +289,7 @@ "type": "boolean" }, "filter": { - "description": "An expression for filtering the results of the request by label. The syntax is \\\"labels.[:]\\\". Multiple filters can be ANDed together by connecting with a space. Example: \\\"labels.department:receiving labels.active\\\". See [Filtering datasets using labels](/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.", + "description": "An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be ANDed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details.", "location": "query", "type": "string" }, @@ -455,7 +455,7 @@ "type": "string" }, "location": { - "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", "location": "query", "type": "string" }, @@ -530,7 +530,7 @@ "type": "string" }, "location": { - "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", "location": "query", "type": "string" }, @@ -575,7 +575,7 @@ "type": "string" }, "location": { - "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", + "description": "The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location.", "location": "query", "type": "string" }, @@ -1935,7 +1935,7 @@ } } }, - "revision": "20240616", + "revision": "20240803", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2518,7 +2518,7 @@ "id": "BigLakeConfiguration", "properties": { "connectionId": { - "description": "Required. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form \"..\" or \"projects//locations//connections/\".", + "description": "Required. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}\".", "type": "string" }, "fileFormat": { @@ -2534,7 +2534,7 @@ "type": "string" }, "storageUri": { - "description": "Required. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format \"gs://bucket/path_to_table/\"", + "description": "Required. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/`", "type": "string" }, "tableFormat": { @@ -2585,7 +2585,7 @@ "type": "boolean" }, "qualifierEncoded": { - "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.", + "description": "[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name.", "format": "byte", "type": "string" }, @@ -2605,7 +2605,7 @@ "id": "BigtableColumnFamily", "properties": { "columns": { - "description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.", + "description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field.", "items": { "$ref": "BigtableColumn" }, @@ -3076,6 +3076,17 @@ }, "type": "object" }, + "DataPolicyOption": { + "description": "Data policy option proto, it currently supports name only, will support precedence later.", + "id": "DataPolicyOption", + "properties": { + "name": { + "description": "Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.", + "type": "string" + } + }, + "type": "object" + }, "DataSplitResult": { "description": "Data split result. This contains references to the training and evaluation data tables that were used to train the model.", "id": "DataSplitResult", @@ -3096,10 +3107,11 @@ "type": "object" }, "Dataset": { + "description": "Represents a BigQuery dataset.", "id": "Dataset", "properties": { "access": { - "description": "Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;", + "description": "Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.", "items": { "description": "An object that defines dataset access for an entity.", "properties": { @@ -3120,7 +3132,7 @@ "type": "string" }, "role": { - "description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER <=> roles/bigquery.dataOwner WRITER <=> roles/bigquery.dataEditor READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", + "description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", "type": "string" }, "routine": { @@ -3128,7 +3140,7 @@ "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." }, "specialGroup": { - "description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", + "description": "[Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", "type": "string" }, "userByEmail": { @@ -3226,7 +3238,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.", + "description": "The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information.", "type": "object" }, "lastModifiedTime": { @@ -3295,7 +3307,8 @@ "type": "string" }, "tags": { - "description": "Output only. Tags for the Dataset.", + "deprecated": true, + "description": "Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.", "items": { "description": "A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions", "properties": { @@ -3416,6 +3429,7 @@ "type": "object" }, "DatasetReference": { + "description": "Identifier for a dataset.", "id": "DatasetReference", "properties": { "datasetId": { @@ -3589,6 +3603,7 @@ "type": "object" }, "EncryptionConfiguration": { + "description": "Configuration for Cloud KMS encryption settings.", "id": "EncryptionConfiguration", "properties": { "kmsKeyName": { @@ -3981,7 +3996,7 @@ "type": "string" }, "connectionId": { - "description": "Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form \"..\" or \"projects//locations//connections/\".", + "description": "Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form `{project_id}.{location_id};{connection_id}` or `projects/{project_id}/locations/{location_id}/connections/{connection_id}`.", "type": "string" }, "csvOptions": { @@ -5503,6 +5518,23 @@ "description": "Output only. Statistics for data-masking. Present only for query and extract jobs.", "readOnly": true }, + "edition": { + "description": "Output only. Name of edition corresponding to the reservation for this job at the time of this update.", + "enum": [ + "RESERVATION_EDITION_UNSPECIFIED", + "STANDARD", + "ENTERPRISE", + "ENTERPRISE_PLUS" + ], + "enumDescriptions": [ + "Default value, which will be treated as ENTERPRISE.", + "Standard edition.", + "Enterprise edition.", + "Enterprise plus edition." + ], + "readOnly": true, + "type": "string" + }, "endTime": { "description": "Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.", "format": "int64", @@ -6412,7 +6444,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", - "Model to capture the manual preprocessing logic in the transform clause." + "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." ], "readOnly": true, "type": "string" @@ -6583,7 +6615,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", - "Model to capture the manual preprocessing logic in the transform clause." + "Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." ], "readOnly": true, "type": "string" @@ -8789,6 +8821,13 @@ "description": "Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.", "type": "string" }, + "dataPolicies": { + "description": "Optional. Data policy options, will replace the data_policies.", + "items": { + "$ref": "DataPolicyOption" + }, + "type": "array" + }, "defaultValueExpression": { "description": "Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field.", "type": "string" @@ -8986,6 +9025,11 @@ "description": "Free form human-readable reason metadata caching was unused for the job.", "type": "string" }, + "staleness": { + "description": "Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job).", + "format": "google-duration", + "type": "string" + }, "tableReference": { "$ref": "TableReference", "description": "Metadata caching eligible table referenced in the query." diff --git a/discovery/bigqueryconnection-v1.json b/discovery/bigqueryconnection-v1.json index 45f1ddbe19..ac5994a116 100644 --- a/discovery/bigqueryconnection-v1.json +++ b/discovery/bigqueryconnection-v1.json @@ -366,7 +366,7 @@ } } }, - "revision": "20240616", + "revision": "20240727", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { @@ -650,7 +650,7 @@ "type": "boolean" }, "kmsKeyName": { - "description": "Optional. The Cloud KMS key that is used for encryption. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`", + "description": "Optional. The Cloud KMS key that is used for credentials encryption. If omitted, internal Google owned encryption keys are used. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]`", "type": "string" }, "lastModifiedTime": { diff --git a/discovery/bigquerydatapolicy-v1.json b/discovery/bigquerydatapolicy-v1.json index 4c35200f31..fd53719c67 100644 --- a/discovery/bigquerydatapolicy-v1.json +++ b/discovery/bigquerydatapolicy-v1.json @@ -152,6 +152,11 @@ "name" ], "parameters": { + "force": { + "description": "Optional. If true, the data policy will be deleted even when it is referenced by one or more table columns.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Required. Resource name of the data policy to delete. Format is `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.", "location": "path", @@ -275,6 +280,11 @@ "name" ], "parameters": { + "allowMissing": { + "description": "Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored.", + "location": "query", + "type": "boolean" + }, "name": { "description": "Output only. Resource name of this data policy, in the format of `projects/{project_number}/locations/{location_id}/dataPolicies/{data_policy_id}`.", "location": "path", @@ -395,7 +405,7 @@ } } }, - "revision": "20240122", + "revision": "20240806", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/bigquerydatatransfer-v1.json b/discovery/bigquerydatatransfer-v1.json index 92e6f2611e..998fd12034 100644 --- a/discovery/bigquerydatatransfer-v1.json +++ b/discovery/bigquerydatatransfer-v1.json @@ -23,34 +23,34 @@ "documentationLink": "https://cloud.google.com/bigquery-transfer/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigquerydatatransfer.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -518,7 +518,8 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", + "deprecated": true, + "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "location": "query", "type": "string" }, @@ -535,7 +536,7 @@ "type": "string" }, "versionInfo": { - "description": "Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", + "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "location": "query", "type": "string" } @@ -658,7 +659,8 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", + "deprecated": true, + "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "location": "query", "type": "string" }, @@ -681,7 +683,7 @@ "type": "string" }, "versionInfo": { - "description": "Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", + "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "location": "query", "type": "string" } @@ -966,7 +968,8 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", + "deprecated": true, + "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "location": "query", "type": "string" }, @@ -983,7 +986,7 @@ "type": "string" }, "versionInfo": { - "description": "Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", + "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config.", "location": "query", "type": "string" } @@ -1106,7 +1109,8 @@ ], "parameters": { "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", + "deprecated": true, + "description": "Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "location": "query", "type": "string" }, @@ -1129,7 +1133,7 @@ "type": "string" }, "versionInfo": { - "description": "Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", + "description": "Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config.", "location": "query", "type": "string" } @@ -1403,7 +1407,7 @@ } } }, - "revision": "20240616", + "revision": "20240806", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index 7dd61c570f..987e19a268 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -20,34 +20,34 @@ "documentationLink": "https://cloud.google.com/bigquery/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" }, { + "description": "Regional Endpoint", "endpointUrl": "https://bigqueryreservation.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" } ], "fullyEncodeReservedExpansion": true, diff --git a/discovery/bigtableadmin-v2.json b/discovery/bigtableadmin-v2.json index cbc11e9fe5..fc8d32c24b 100644 --- a/discovery/bigtableadmin-v2.json +++ b/discovery/bigtableadmin-v2.json @@ -949,7 +949,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.", + "description": "Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project}/instances/{instance}/clusters/{cluster}`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+/clusters/[^/]+$", "required": true, @@ -2194,7 +2194,7 @@ } } }, - "revision": "20240616", + "revision": "20240806", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -2375,6 +2375,20 @@ "description": "A backup of a Cloud Bigtable table.", "id": "Backup", "properties": { + "backupType": { + "description": "Indicates the backup type of the backup.", + "enum": [ + "BACKUP_TYPE_UNSPECIFIED", + "STANDARD", + "HOT" + ], + "enumDescriptions": [ + "Not specified.", + "The default type for Cloud Bigtable managed backups. Supported for backups created in both HDD and SSD instances. Requires optimization when restored to a table in an SSD instance.", + "A backup type with faster restore to SSD performance. Only supported for backups created in SSD instances. A new SSD table restored from a hot backup reaches production performance more quickly than a standard backup." + ], + "type": "string" + }, "encryptionInfo": { "$ref": "EncryptionInfo", "description": "Output only. The encryption information for the backup.", @@ -2387,7 +2401,12 @@ "type": "string" }, "expireTime": { - "description": "Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup.", + "description": "Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.", + "format": "google-datetime", + "type": "string" + }, + "hotToStandardTime": { + "description": "The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.", "format": "google-datetime", "type": "string" }, @@ -3144,10 +3163,22 @@ "description": "A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` .", "id": "GoogleBigtableAdminV2TypeAggregate", "properties": { + "hllppUniqueCount": { + "$ref": "GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount", + "description": "HyperLogLogPlusPlusUniqueCount aggregator." + }, "inputType": { "$ref": "Type", "description": "Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs." }, + "max": { + "$ref": "GoogleBigtableAdminV2TypeAggregateMax", + "description": "Max aggregator." + }, + "min": { + "$ref": "GoogleBigtableAdminV2TypeAggregateMin", + "description": "Min aggregator." + }, "stateType": { "$ref": "Type", "description": "Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding.", @@ -3160,12 +3191,47 @@ }, "type": "object" }, + "GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount": { + "description": "Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate)", + "id": "GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeAggregateMax": { + "description": "Computes the max of the input values. Allowed input: `Int64` State: same as input", + "id": "GoogleBigtableAdminV2TypeAggregateMax", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeAggregateMin": { + "description": "Computes the min of the input values. Allowed input: `Int64` State: same as input", + "id": "GoogleBigtableAdminV2TypeAggregateMin", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeAggregateSum": { "description": "Computes the sum of the input values. Allowed input: `Int64` State: same as input", "id": "GoogleBigtableAdminV2TypeAggregateSum", "properties": {}, "type": "object" }, + "GoogleBigtableAdminV2TypeArray": { + "description": "An ordered list of elements of a given type. Values of type `Array` are stored in `Value.array_value`.", + "id": "GoogleBigtableAdminV2TypeArray", + "properties": { + "elementType": { + "$ref": "Type", + "description": "The type of the elements in the array. This must not be `Array`." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeBool": { + "description": "bool Values of type `Bool` are stored in `Value.bool_value`.", + "id": "GoogleBigtableAdminV2TypeBool", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeBytes": { "description": "Bytes Values of type `Bytes` are stored in `Value.bytes_value`.", "id": "GoogleBigtableAdminV2TypeBytes", @@ -3189,11 +3255,29 @@ "type": "object" }, "GoogleBigtableAdminV2TypeBytesEncodingRaw": { - "description": "Leaves the value \"as-is\" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A", + "description": "Leaves the value \"as-is\" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A", "id": "GoogleBigtableAdminV2TypeBytesEncodingRaw", "properties": {}, "type": "object" }, + "GoogleBigtableAdminV2TypeDate": { + "description": "Date Values of type `Date` are stored in `Value.date_value`.", + "id": "GoogleBigtableAdminV2TypeDate", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeFloat32": { + "description": "Float32 Values of type `Float32` are stored in `Value.float_value`.", + "id": "GoogleBigtableAdminV2TypeFloat32", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeFloat64": { + "description": "Float64 Values of type `Float64` are stored in `Value.float_value`.", + "id": "GoogleBigtableAdminV2TypeFloat64", + "properties": {}, + "type": "object" + }, "GoogleBigtableAdminV2TypeInt64": { "description": "Int64 Values of type `Int64` are stored in `Value.int_value`.", "id": "GoogleBigtableAdminV2TypeInt64", @@ -3217,16 +3301,104 @@ "type": "object" }, "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes": { - "description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", + "description": "Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN`", "id": "GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes", "properties": { "bytesType": { "$ref": "GoogleBigtableAdminV2TypeBytes", - "description": "The underlying `Bytes` type, which may be able to encode further." + "description": "Deprecated: ignored if set." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeMap": { + "description": "A mapping of keys to values of a given type. Values of type `Map` are stored in a `Value.array_value` where each entry is another `Value.array_value` with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the _last_ value takes precedence.", + "id": "GoogleBigtableAdminV2TypeMap", + "properties": { + "keyType": { + "$ref": "Type", + "description": "The type of a map key. Only `Bytes`, `String`, and `Int64` are allowed as key types." + }, + "valueType": { + "$ref": "Type", + "description": "The type of the values in a map." } }, "type": "object" }, + "GoogleBigtableAdminV2TypeString": { + "description": "String Values of type `String` are stored in `Value.string_value`.", + "id": "GoogleBigtableAdminV2TypeString", + "properties": { + "encoding": { + "$ref": "GoogleBigtableAdminV2TypeStringEncoding", + "description": "The encoding to use when converting to/from lower level types." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStringEncoding": { + "description": "Rules used to convert to/from lower level types.", + "id": "GoogleBigtableAdminV2TypeStringEncoding", + "properties": { + "utf8Bytes": { + "$ref": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", + "description": "Use `Utf8Bytes` encoding." + }, + "utf8Raw": { + "$ref": "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw", + "description": "Deprecated: if set, converts to an empty `utf8_bytes`." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes": { + "description": "UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)`", + "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw": { + "description": "Deprecated: prefer the equivalent `Utf8Bytes`.", + "id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw", + "properties": {}, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStruct": { + "description": "A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`.", + "id": "GoogleBigtableAdminV2TypeStruct", + "properties": { + "fields": { + "description": "The names and types of the fields in this struct.", + "items": { + "$ref": "GoogleBigtableAdminV2TypeStructField" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeStructField": { + "description": "A struct field and its type.", + "id": "GoogleBigtableAdminV2TypeStructField", + "properties": { + "fieldName": { + "description": "The field name (optional). Fields without a `field_name` are considered anonymous and cannot be referenced by name.", + "type": "string" + }, + "type": { + "$ref": "Type", + "description": "The type of values in this field." + } + }, + "type": "object" + }, + "GoogleBigtableAdminV2TypeTimestamp": { + "description": "Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`.", + "id": "GoogleBigtableAdminV2TypeTimestamp", + "properties": {}, + "type": "object" + }, "HotTablet": { "description": "A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time.", "id": "HotTablet", @@ -4103,20 +4275,56 @@ "type": "object" }, "Type": { - "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an \"encoding chain,\" for example to convert from INT64 -> STRING -> raw bytes. In most cases, a \"link\" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", + "description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", "id": "Type", "properties": { "aggregateType": { "$ref": "GoogleBigtableAdminV2TypeAggregate", "description": "Aggregate" }, + "arrayType": { + "$ref": "GoogleBigtableAdminV2TypeArray", + "description": "Array" + }, + "boolType": { + "$ref": "GoogleBigtableAdminV2TypeBool", + "description": "Bool" + }, "bytesType": { "$ref": "GoogleBigtableAdminV2TypeBytes", "description": "Bytes" }, + "dateType": { + "$ref": "GoogleBigtableAdminV2TypeDate", + "description": "Date" + }, + "float32Type": { + "$ref": "GoogleBigtableAdminV2TypeFloat32", + "description": "Float32" + }, + "float64Type": { + "$ref": "GoogleBigtableAdminV2TypeFloat64", + "description": "Float64" + }, "int64Type": { "$ref": "GoogleBigtableAdminV2TypeInt64", "description": "Int64" + }, + "mapType": { + "$ref": "GoogleBigtableAdminV2TypeMap", + "description": "Map" + }, + "stringType": { + "$ref": "GoogleBigtableAdminV2TypeString", + "description": "String" + }, + "structType": { + "$ref": "GoogleBigtableAdminV2TypeStruct", + "description": "Struct" + }, + "timestampType": { + "$ref": "GoogleBigtableAdminV2TypeTimestamp", + "description": "Timestamp" } }, "type": "object" diff --git a/discovery/calendar-v3.json b/discovery/calendar-v3.json index c51dc20f38..e2347a96bf 100644 --- a/discovery/calendar-v3.json +++ b/discovery/calendar-v3.json @@ -1763,7 +1763,7 @@ } } }, - "revision": "20240523", + "revision": "20240705", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2591,7 +2591,7 @@ "type": "string" }, "reminders": { - "description": "Information about the event's reminders for the authenticated user.", + "description": "Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.", "properties": { "overrides": { "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.", @@ -2651,7 +2651,7 @@ "type": "string" }, "updated": { - "description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.", + "description": "Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.", "format": "date-time", "type": "string" }, diff --git a/discovery/certificatemanager-v1.json b/discovery/certificatemanager-v1.json index 052a610dbb..ead5a53b0d 100644 --- a/discovery/certificatemanager-v1.json +++ b/discovery/certificatemanager-v1.json @@ -272,23 +272,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the Certificates Configs returned.", + "description": "Optional. Filter expression to restrict the Certificates Configs returned.", "location": "query", "type": "string" }, "orderBy": { - "description": "A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", + "description": "Optional. A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of certificate configs to return per call.", + "description": "Optional. Maximum number of certificate configs to return per call.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -307,6 +307,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates a CertificateIssuanceConfig.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/certificateIssuanceConfigs/{certificateIssuanceConfigsId}", + "httpMethod": "PATCH", + "id": "certificatemanager.projects.locations.certificateIssuanceConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/certificateIssuanceConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "CertificateIssuanceConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -405,23 +439,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the Certificates Maps returned.", + "description": "Optional. Filter expression to restrict the Certificates Maps returned.", "location": "query", "type": "string" }, "orderBy": { - "description": "A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", + "description": "Optional. A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of certificate maps to return per call.", + "description": "Optional. Maximum number of certificate maps to return per call.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -451,7 +485,7 @@ ], "parameters": { "name": { - "description": "A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", + "description": "Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+$", "required": true, @@ -572,23 +606,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the returned Certificate Map Entries.", + "description": "Optional. Filter expression to restrict the returned Certificate Map Entries.", "location": "query", "type": "string" }, "orderBy": { - "description": "A list of Certificate Map Entry field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", + "description": "Optional. A list of Certificate Map Entry field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListCertificateMapEntriesResponse`. Indicates that this is a continuation of a prior `ListCertificateMapEntries` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListCertificateMapEntriesResponse`. Indicates that this is a continuation of a prior `ListCertificateMapEntries` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -618,7 +652,7 @@ ], "parameters": { "name": { - "description": "A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", + "description": "Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/certificateMaps/[^/]+/certificateMapEntries/[^/]+$", "required": true, @@ -741,23 +775,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the Certificates returned.", + "description": "Optional. Filter expression to restrict the Certificates returned.", "location": "query", "type": "string" }, "orderBy": { - "description": "A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", + "description": "Optional. A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of certificates to return per call.", + "description": "Optional. Maximum number of certificates to return per call.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListCertificatesResponse`. Indicates that this is a continuation of a prior `ListCertificates` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListCertificatesResponse`. Indicates that this is a continuation of a prior `ListCertificates` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -787,7 +821,7 @@ ], "parameters": { "name": { - "description": "A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.", + "description": "Identifier. A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/certificates/[^/]+$", "required": true, @@ -908,23 +942,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the Dns Authorizations returned.", + "description": "Optional. Filter expression to restrict the Dns Authorizations returned.", "location": "query", "type": "string" }, "orderBy": { - "description": "A list of Dns Authorization field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", + "description": "Optional. A list of Dns Authorization field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of dns authorizations to return per call.", + "description": "Optional. Maximum number of dns authorizations to return per call.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that this is a continuation of a prior `ListDnsAuthorizations` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that this is a continuation of a prior `ListDnsAuthorizations` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -954,7 +988,7 @@ ], "parameters": { "name": { - "description": "A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", + "description": "Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dnsAuthorizations/[^/]+$", "required": true, @@ -1148,7 +1182,7 @@ ], "parameters": { "etag": { - "description": "The current etag of the TrustConfig. If an etag is provided and does not match the current etag of the resource, deletion will be blocked and an ABORTED error will be returned.", + "description": "Optional. The current etag of the TrustConfig. If an etag is provided and does not match the current etag of the resource, deletion will be blocked and an ABORTED error will be returned.", "location": "query", "type": "string" }, @@ -1203,23 +1237,23 @@ ], "parameters": { "filter": { - "description": "Filter expression to restrict the TrustConfigs returned.", + "description": "Optional. Filter expression to restrict the TrustConfigs returned.", "location": "query", "type": "string" }, "orderBy": { - "description": "A list of TrustConfig field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", + "description": "Optional. A list of TrustConfig field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `\" desc\"`.", "location": "query", "type": "string" }, "pageSize": { - "description": "Maximum number of TrustConfigs to return per call.", + "description": "Optional. Maximum number of TrustConfigs to return per call.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The value returned by the last `ListTrustConfigsResponse`. Indicates that this is a continuation of a prior `ListTrustConfigs` call, and that the system should return the next page of data.", + "description": "Optional. The value returned by the last `ListTrustConfigsResponse`. Indicates that this is a continuation of a prior `ListTrustConfigs` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1249,7 +1283,7 @@ ], "parameters": { "name": { - "description": "A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`.", + "description": "Identifier. A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/trustConfigs/[^/]+$", "required": true, @@ -1280,7 +1314,7 @@ } } }, - "revision": "20240417", + "revision": "20240729", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1304,7 +1338,8 @@ "type": "string" }, "domain": { - "description": "Domain name of the authorization attempt.", + "description": "Output only. Domain name of the authorization attempt.", + "readOnly": true, "type": "string" }, "failureReason": { @@ -1361,7 +1396,7 @@ "type": "string" }, "description": { - "description": "One or more paragraphs of text description of a certificate.", + "description": "Optional. One or more paragraphs of text description of a certificate.", "type": "string" }, "expireTime": { @@ -1374,7 +1409,7 @@ "additionalProperties": { "type": "string" }, - "description": "Set of labels associated with a Certificate.", + "description": "Optional. Set of labels associated with a Certificate.", "type": "object" }, "managed": { @@ -1382,7 +1417,7 @@ "description": "If set, contains configuration and state of a managed certificate." }, "name": { - "description": "A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.", + "description": "Identifier. A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`.", "type": "string" }, "pemCertificate": { @@ -1399,7 +1434,7 @@ "type": "array" }, "scope": { - "description": "Immutable. The scope of the certificate.", + "description": "Optional. Immutable. The scope of the certificate.", "enum": [ "DEFAULT", "EDGE_CACHE", @@ -1462,7 +1497,7 @@ "type": "string" }, "description": { - "description": "One or more paragraphs of text description of a CertificateIssuanceConfig.", + "description": "Optional. One or more paragraphs of text description of a CertificateIssuanceConfig.", "type": "string" }, "keyAlgorithm": { @@ -1483,7 +1518,7 @@ "additionalProperties": { "type": "string" }, - "description": "Set of labels associated with a CertificateIssuanceConfig.", + "description": "Optional. Set of labels associated with a CertificateIssuanceConfig.", "type": "object" }, "lifetime": { @@ -1492,7 +1527,7 @@ "type": "string" }, "name": { - "description": "A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.", + "description": "Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`.", "type": "string" }, "rotationWindowPercentage": { @@ -1520,7 +1555,7 @@ "type": "string" }, "description": { - "description": "One or more paragraphs of text description of a certificate map.", + "description": "Optional. One or more paragraphs of text description of a certificate map.", "type": "string" }, "gclbTargets": { @@ -1535,11 +1570,11 @@ "additionalProperties": { "type": "string" }, - "description": "Set of labels associated with a Certificate Map.", + "description": "Optional. Set of labels associated with a Certificate Map.", "type": "object" }, "name": { - "description": "A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", + "description": "Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`.", "type": "string" }, "updateTime": { @@ -1556,7 +1591,7 @@ "id": "CertificateMapEntry", "properties": { "certificates": { - "description": "A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`.", + "description": "Optional. A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`.", "items": { "type": "string" }, @@ -1569,7 +1604,7 @@ "type": "string" }, "description": { - "description": "One or more paragraphs of text description of a certificate map entry.", + "description": "Optional. One or more paragraphs of text description of a certificate map entry.", "type": "string" }, "hostname": { @@ -1580,7 +1615,7 @@ "additionalProperties": { "type": "string" }, - "description": "Set of labels associated with a Certificate Map Entry.", + "description": "Optional. Set of labels associated with a Certificate Map Entry.", "type": "object" }, "matcher": { @@ -1596,7 +1631,7 @@ "type": "string" }, "name": { - "description": "A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", + "description": "Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`.", "type": "string" }, "state": { @@ -1634,7 +1669,7 @@ "type": "string" }, "description": { - "description": "One or more paragraphs of text description of a DnsAuthorization.", + "description": "Optional. One or more paragraphs of text description of a DnsAuthorization.", "type": "string" }, "dnsResourceRecord": { @@ -1650,15 +1685,15 @@ "additionalProperties": { "type": "string" }, - "description": "Set of labels associated with a DnsAuthorization.", + "description": "Optional. Set of labels associated with a DnsAuthorization.", "type": "object" }, "name": { - "description": "A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", + "description": "Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.", "type": "string" }, "type": { - "description": "Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.", + "description": "Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.", "enum": [ "TYPE_UNSPECIFIED", "FIXED_RECORD", @@ -1998,21 +2033,21 @@ "type": "array" }, "dnsAuthorizations": { - "description": "Immutable. Authorizations that will be used for performing domain authorization.", + "description": "Optional. Immutable. Authorizations that will be used for performing domain authorization.", "items": { "type": "string" }, "type": "array" }, "domains": { - "description": "Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.", + "description": "Optional. Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution.", "items": { "type": "string" }, "type": "array" }, "issuanceConfig": { - "description": "Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.", + "description": "Optional. Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/*/locations/*/certificateIssuanceConfigs/*`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa.", "type": "string" }, "provisioningIssue": { @@ -2144,11 +2179,11 @@ "id": "SelfManagedCertificate", "properties": { "pemCertificate": { - "description": "Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any.", + "description": "Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any.", "type": "string" }, "pemPrivateKey": { - "description": "Input only. The PEM-encoded private key of the leaf certificate.", + "description": "Optional. Input only. The PEM-encoded private key of the leaf certificate.", "type": "string" } }, @@ -2210,7 +2245,7 @@ "type": "string" }, "description": { - "description": "One or more paragraphs of text description of a TrustConfig.", + "description": "Optional. One or more paragraphs of text description of a TrustConfig.", "type": "string" }, "etag": { @@ -2221,15 +2256,15 @@ "additionalProperties": { "type": "string" }, - "description": "Set of labels associated with a TrustConfig.", + "description": "Optional. Set of labels associated with a TrustConfig.", "type": "object" }, "name": { - "description": "A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`.", + "description": "Identifier. A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`.", "type": "string" }, "trustStores": { - "description": "Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed.", + "description": "Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed.", "items": { "$ref": "TrustStore" }, @@ -2249,14 +2284,14 @@ "id": "TrustStore", "properties": { "intermediateCas": { - "description": "Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature.", + "description": "Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature.", "items": { "$ref": "IntermediateCA" }, "type": "array" }, "trustAnchors": { - "description": "List of Trust Anchors to be used while performing validation against a given TrustStore.", + "description": "Optional. List of Trust Anchors to be used while performing validation against a given TrustStore.", "items": { "$ref": "TrustAnchor" }, diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 19952f69e6..a54ec0bbcc 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -21,28 +21,28 @@ "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, "https://www.googleapis.com/auth/chat.delete": { - "description": "Delete conversations and spaces & remove access to associated files in Google Chat" + "description": "Delete conversations and spaces and remove access to associated files in Google Chat" }, "https://www.googleapis.com/auth/chat.import": { "description": "Import spaces, messages, and memberships into Google Chat." }, "https://www.googleapis.com/auth/chat.memberships": { - "description": "View, add, update, and remove members from conversations in Google Chat" + "description": "See, add, update, and remove members from conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.memberships.app": { - "description": "Add and remove itself from conversations in Google Chat" + "description": "Add and remove itself from conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.memberships.readonly": { "description": "View members in Google Chat conversations." }, "https://www.googleapis.com/auth/chat.messages": { - "description": "View, compose, send, update, and delete messages, and add, view, and delete reactions to messages." + "description": "See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages." }, "https://www.googleapis.com/auth/chat.messages.create": { "description": "Compose and send messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.reactions": { - "description": "View, add, and delete reactions to messages in Google Chat" + "description": "See, add, and delete reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.reactions.create": { "description": "Add reactions to messages in Google Chat" @@ -51,13 +51,13 @@ "description": "View reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.readonly": { - "description": "View messages and reactions in Google Chat" + "description": "See messages and their associated reactions and attachments in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces": { - "description": "Create conversations and spaces and see or edit metadata (including history settings and access settings) in Google Chat" + "description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.create": { - "description": "Create new conversations in Google Chat" + "description": "Create new conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.readonly": { "description": "View chat and spaces in Google Chat" @@ -433,7 +433,7 @@ "type": "string" }, "updateMask": { - "description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", + "description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1241,7 +1241,7 @@ } } }, - "revision": "20240625", + "revision": "20240808", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1257,14 +1257,14 @@ ], "enumDescriptions": [ "Access state is unknown or not supported in this API.", - "Space is discoverable by added or invited members or groups.", - "Space is discoverable by the selected [target audience](https://support.google.com/a/answer/9934697), as well as added or invited members or groups." + "Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.", + "A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience)." ], "readOnly": true, "type": "string" }, "audience": { - "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", + "description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", "type": "string" } }, @@ -1850,7 +1850,7 @@ "type": "object" }, "DeprecatedEvent": { - "description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", + "description": "A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", "id": "DeprecatedEvent", "properties": { "action": { @@ -1859,10 +1859,10 @@ }, "common": { "$ref": "CommonEventObject", - "description": "Represents informatmessage_visibilityion about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." + "description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." }, "configCompleteRedirectUrl": { - "description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", + "description": "For `MESSAGE` interaction events, the URL that users must be redirected to after they complete an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", "type": "string" }, "dialogEventType": { @@ -1892,11 +1892,11 @@ }, "message": { "$ref": "Message", - "description": "The message that triggered the interaction event, if applicable." + "description": "For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable." }, "space": { "$ref": "Space", - "description": "The space in which the interaction event occurred." + "description": "The space in which the user interacted with the Chat app." }, "threadKey": { "description": "The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.", @@ -1907,7 +1907,7 @@ "type": "string" }, "type": { - "description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events).", + "description": "The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.", "enum": [ "UNSPECIFIED", "MESSAGE", @@ -1918,17 +1918,17 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", - "A user sends the Chat app a message, or invokes the Chat app in a space.", - "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization.", - "A user removes the Chat app from a space.", - "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", + "A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its slash commands. * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", + "A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", + "A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", + "A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", "A user updates a widget in a card message or dialog." ], "type": "string" }, "user": { "$ref": "User", - "description": "The user that triggered the interaction event." + "description": "The user that interacted with the Chat app." } }, "type": "object" @@ -2368,7 +2368,7 @@ "type": "object" }, "GoogleAppsCardV1Columns": { - "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview.", + "description": "The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):", "id": "GoogleAppsCardV1Columns", "properties": { "columnItems": { @@ -2744,13 +2744,11 @@ "description": "A data source shared by all Google Workspace applications, such as users in a Google Workspace organization.", "enum": [ "UNKNOWN", - "USER", - "DRIVE" + "USER" ], "enumDescriptions": [ "Default value. Don't use.", - "Google Workspace users. The user can only view and select users from their Google Workspace organization.", - "Represents a data source from Google Drive OnePick." + "Google Workspace users. The user can only view and select users from their Google Workspace organization." ], "type": "string" }, @@ -2818,7 +2816,7 @@ "type": "integer" }, "name": { - "description": "The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", + "description": "Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data).", "type": "string" }, "onChangeAction": { @@ -2843,7 +2841,7 @@ "A set of radio buttons. Users can select one radio button.", "A set of switches. Users can turn on one or more switches.", "A dropdown menu. Users can select one item from the menu.", - "A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Multiselect for Google Workspace Add-ons are in Developer Preview." + "A multiselect menu for static or dynamic data. From the menu bar, users select one or more items. Users can also input values to populate dynamic data. For example, users can start typing the name of a Google Chat space and the widget autosuggests the space. To populate items for a multiselect menu, you can use one of the following types of data sources: * Static data: Items are specified as `SelectionItem` objects in the widget. Up to 100 items. * Google Workspace data: Items are populated using data from Google Workspace, such as Google Workspace users or Google Chat spaces. * External data: Items are populated from an external data source outside of Google Workspace. For examples of how to implement multiselect menus, see [Add a multiselect menu](https://developers.google.com/workspace/chat/design-interactive-card-dialog#multiselect-menu). [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend):" ], "type": "string" } @@ -4098,7 +4096,7 @@ "type": "string" }, "externalUserAllowed": { - "description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.", + "description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.", "type": "boolean" }, "importMode": { @@ -4424,7 +4422,7 @@ "id": "Thread", "properties": { "name": { - "description": "Output only. Resource name of the thread. Example: `spaces/{space}/threads/{thread}`", + "description": "Resource name of the thread. Example: `spaces/{space}/threads/{thread}`", "type": "string" }, "threadKey": { diff --git a/discovery/chromemanagement-v1.json b/discovery/chromemanagement-v1.json index 91180ad8d2..4a6ae25f46 100644 --- a/discovery/chromemanagement-v1.json +++ b/discovery/chromemanagement-v1.json @@ -591,12 +591,12 @@ "type": "string" }, "filter": { - "description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id", + "description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions", "location": "query", "type": "string" }, "orderBy": { - "description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id", + "description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions", "location": "query", "type": "string" }, @@ -976,7 +976,7 @@ "type": "string" }, "readMask": { - "description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event ", + "description": "Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event ", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1172,7 +1172,7 @@ } } }, - "revision": "20240627", + "revision": "20240709", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -4112,7 +4112,8 @@ "VPN_CONNECTION_STATE_CHANGE", "APP_INSTALLED", "APP_UNINSTALLED", - "APP_LAUNCHED" + "APP_LAUNCHED", + "OS_CRASH" ], "enumDescriptions": [ "Event type unknown.", @@ -4126,7 +4127,8 @@ "Triggered on changes to VPN connections.", "Triggered when an app is installed.", "Triggered when an app is uninstalled.", - "Triggered when an app is launched." + "Triggered when an app is launched.", + "Triggered when a crash occurs." ], "type": "string" }, @@ -4192,7 +4194,8 @@ "VPN_CONNECTION_STATE_CHANGE", "APP_INSTALLED", "APP_UNINSTALLED", - "APP_LAUNCHED" + "APP_LAUNCHED", + "OS_CRASH" ], "enumDescriptions": [ "Event type unknown.", @@ -4206,7 +4209,8 @@ "Triggered on changes to VPN connections.", "Triggered when an app is installed.", "Triggered when an app is uninstalled.", - "Triggered when an app is launched." + "Triggered when an app is launched.", + "Triggered when a crash occurs." ], "type": "string" }, diff --git a/discovery/chromepolicy-v1.json b/discovery/chromepolicy-v1.json index 9eaa19041d..98cfcd105d 100644 --- a/discovery/chromepolicy-v1.json +++ b/discovery/chromepolicy-v1.json @@ -557,7 +557,7 @@ } } }, - "revision": "20240131", + "revision": "20240729", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { @@ -966,7 +966,7 @@ "type": "string" }, "scheduledToDeprecatePolicies": { - "description": "Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy. This field should not be manually set but will be set and exposed through PolicyAPI automatically.", + "description": "Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy.", "items": { "type": "string" }, diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json index 01a8f53f00..11cdbe40fb 100644 --- a/discovery/classroom-v1.json +++ b/discovery/classroom-v1.json @@ -564,7 +564,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1061,7 +1061,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1185,7 +1185,7 @@ ] }, "patch": { - "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.", + "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.", "flatPath": "v1/courses/{courseId}/courseWork/{id}", "httpMethod": "PATCH", "id": "classroom.courses.courseWork.patch", @@ -1207,7 +1207,7 @@ "type": "string" }, "updateMask": { - "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id`", + "description": "Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2021,7 +2021,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2402,7 +2402,7 @@ "type": "string" }, "attachmentId": { - "description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", + "description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -3695,7 +3695,7 @@ } } }, - "revision": "20240617", + "revision": "20240713", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/discovery/cloudasset-v1.json b/discovery/cloudasset-v1.json index 1ffd559ccb..ca293a28bc 100644 --- a/discovery/cloudasset-v1.json +++ b/discovery/cloudasset-v1.json @@ -1095,7 +1095,7 @@ } } }, - "revision": "20240621", + "revision": "20240803", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -2600,6 +2600,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -2798,7 +2799,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -2903,7 +2904,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -3873,7 +3874,7 @@ "id": "QueryAssetsResponse", "properties": { "done": { - "description": "The query response, which can be either an `error` or a valid `response`. If `done` == `false` and the query result is being saved in a output, the output_config field will be set. If `done` == `true`, exactly one of `error`, `query_result` or `output_config` will be set.", + "description": "The query response, which can be either an `error` or a valid `response`. If `done` == `false` and the query result is being saved in an output, the output_config field will be set. If `done` == `true`, exactly one of `error`, `query_result` or `output_config` will be set. [done] is unset unless the [QueryAssetsResponse] contains a [QueryAssetsResponse.job_reference].", "type": "boolean" }, "error": { @@ -3886,7 +3887,7 @@ }, "outputConfig": { "$ref": "QueryAssetsOutputConfig", - "description": "Output configuration which indicates instead of being returned in API response on the fly, the query result will be saved in a specific output." + "description": "Output configuration, which indicates that instead of being returned in an API response on the fly, the query result will be saved in a specific output." }, "queryResult": { "$ref": "QueryResult", diff --git a/discovery/cloudasset-v1beta1.json b/discovery/cloudasset-v1beta1.json index 609d4985c2..3077e624e9 100644 --- a/discovery/cloudasset-v1beta1.json +++ b/discovery/cloudasset-v1beta1.json @@ -411,7 +411,7 @@ } } }, - "revision": "20240621", + "revision": "20240803", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -925,6 +925,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -1123,7 +1124,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -1228,7 +1229,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, diff --git a/discovery/cloudasset-v1p1beta1.json b/discovery/cloudasset-v1p1beta1.json index 07f522691b..5c07b414af 100644 --- a/discovery/cloudasset-v1p1beta1.json +++ b/discovery/cloudasset-v1p1beta1.json @@ -207,7 +207,7 @@ } } }, - "revision": "20240621", + "revision": "20240803", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -627,6 +627,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -825,7 +826,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -930,7 +931,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, diff --git a/discovery/cloudasset-v1p5beta1.json b/discovery/cloudasset-v1p5beta1.json index 5e4e5375bc..47071c688a 100644 --- a/discovery/cloudasset-v1p5beta1.json +++ b/discovery/cloudasset-v1p5beta1.json @@ -177,7 +177,7 @@ } } }, - "revision": "20240621", + "revision": "20240803", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -632,6 +632,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -830,7 +831,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -935,7 +936,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, diff --git a/discovery/cloudasset-v1p7beta1.json b/discovery/cloudasset-v1p7beta1.json index 991c938874..ea9b152752 100644 --- a/discovery/cloudasset-v1p7beta1.json +++ b/discovery/cloudasset-v1p7beta1.json @@ -167,7 +167,7 @@ } } }, - "revision": "20240621", + "revision": "20240803", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -701,6 +701,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", + "readOnly": true, "type": "string" }, "name": { @@ -899,7 +900,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, @@ -1004,7 +1005,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1IngressFrom", "properties": { "identities": { - "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", + "description": "A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported.", "items": { "type": "string" }, diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index 6f536ac4fa..6b7c178a45 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2346,7 +2346,7 @@ } } }, - "revision": "20240627", + "revision": "20240704", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -4295,7 +4295,7 @@ "id": "HttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port].", + "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" } }, diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 445b48c007..09e77c4b78 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -844,7 +844,7 @@ } } }, - "revision": "20240618", + "revision": "20240731", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1806,12 +1806,14 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", - "ARRAY" + "ARRAY", + "OBJECT" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", - "Arrary type." + "Array type.", + "Object type." ], "type": "string" } @@ -1829,6 +1831,13 @@ }, "type": "array" }, + "objectVal": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Value of the parameter if type is object.", + "type": "object" + }, "stringVal": { "description": "Value of the parameter if type is string.", "type": "string" @@ -1838,12 +1847,14 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", - "ARRAY" + "ARRAY", + "OBJECT" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", - "Array type" + "Array type", + "Object type" ], "type": "string" } @@ -1855,8 +1866,7 @@ "id": "PipelineRef", "properties": { "name": { - "deprecated": true, - "description": "Name of the Pipeline.", + "description": "Optional. Name of the Pipeline.", "type": "string" }, "params": { @@ -2502,8 +2512,7 @@ "type": "string" }, "secretVersion": { - "description": "Output only. Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", - "readOnly": true, + "description": "Optional. Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", "type": "string" } }, @@ -2514,6 +2523,7 @@ "id": "Security", "properties": { "privilegeMode": { + "deprecated": true, "description": "Optional. Privilege mode.", "enum": [ "PRIVILEGE_MODE_UNSPECIFIED", @@ -2841,8 +2851,7 @@ "id": "TaskRef", "properties": { "name": { - "deprecated": true, - "description": "Name of the task.", + "description": "Optional. Name of the task.", "type": "string" }, "params": { diff --git a/discovery/cloudchannel-v1.json b/discovery/cloudchannel-v1.json index a6f03370d8..16f06d4c06 100644 --- a/discovery/cloudchannel-v1.json +++ b/discovery/cloudchannel-v1.json @@ -148,12 +148,17 @@ ], "parameters": { "account": { - "description": "Required. Resource name of the account.", + "description": "Optional. Resource name of the account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, "type": "string" }, + "integrator": { + "description": "Optional. Resource name of the integrator.", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", "format": "int32", @@ -240,7 +245,7 @@ ], "parameters": { "account": { - "description": "Required. Resource name of the account.", + "description": "Optional. Resource name of the account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -268,7 +273,7 @@ ], "parameters": { "account": { - "description": "Required. Resource name of the account.", + "description": "Optional. Resource name of the account.", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -1966,6 +1971,121 @@ } } }, + "integrators": { + "methods": { + "listSubscribers": { + "description": "Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses.", + "flatPath": "v1/integrators/{integratorsId}:listSubscribers", + "httpMethod": "GET", + "id": "cloudchannel.integrators.listSubscribers", + "parameterOrder": [ + "integrator" + ], + "parameters": { + "account": { + "description": "Optional. Resource name of the account.", + "location": "query", + "type": "string" + }, + "integrator": { + "description": "Optional. Resource name of the integrator.", + "location": "path", + "pattern": "^integrators/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+integrator}:listSubscribers", + "response": { + "$ref": "GoogleCloudChannelV1ListSubscribersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/apps.order" + ] + }, + "register": { + "description": "Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address.", + "flatPath": "v1/integrators/{integratorsId}:register", + "httpMethod": "POST", + "id": "cloudchannel.integrators.register", + "parameterOrder": [ + "integrator" + ], + "parameters": { + "account": { + "description": "Optional. Resource name of the account.", + "location": "query", + "type": "string" + }, + "integrator": { + "description": "Optional. Resource name of the integrator.", + "location": "path", + "pattern": "^integrators/[^/]+$", + "required": true, + "type": "string" + }, + "serviceAccount": { + "description": "Required. Service account that provides subscriber access to the registered topic.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+integrator}:register", + "response": { + "$ref": "GoogleCloudChannelV1RegisterSubscriberResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/apps.order" + ] + }, + "unregister": { + "description": "Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic.", + "flatPath": "v1/integrators/{integratorsId}:unregister", + "httpMethod": "POST", + "id": "cloudchannel.integrators.unregister", + "parameterOrder": [ + "integrator" + ], + "parameters": { + "account": { + "description": "Optional. Resource name of the account.", + "location": "query", + "type": "string" + }, + "integrator": { + "description": "Optional. Resource name of the integrator.", + "location": "path", + "pattern": "^integrators/[^/]+$", + "required": true, + "type": "string" + }, + "serviceAccount": { + "description": "Required. Service account to unregister from subscriber access to the topic.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+integrator}:unregister", + "response": { + "$ref": "GoogleCloudChannelV1UnregisterSubscriberResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/apps.order" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -2183,7 +2303,7 @@ } } }, - "revision": "20240131", + "revision": "20240728", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -4217,6 +4337,10 @@ "description": "Request Message for RegisterSubscriber.", "id": "GoogleCloudChannelV1RegisterSubscriberRequest", "properties": { + "integrator": { + "description": "Optional. Resource name of the integrator.", + "type": "string" + }, "serviceAccount": { "description": "Required. Service account that provides subscriber access to the registered topic.", "type": "string" @@ -4791,6 +4915,10 @@ "description": "Request Message for UnregisterSubscriber.", "id": "GoogleCloudChannelV1UnregisterSubscriberRequest", "properties": { + "integrator": { + "description": "Optional. Resource name of the integrator.", + "type": "string" + }, "serviceAccount": { "description": "Required. Service account to unregister from subscriber access to the topic.", "type": "string" diff --git a/discovery/cloudcontrolspartner-v1.json b/discovery/cloudcontrolspartner-v1.json index 02904b99bf..06f22f6b31 100644 --- a/discovery/cloudcontrolspartner-v1.json +++ b/discovery/cloudcontrolspartner-v1.json @@ -484,7 +484,7 @@ } } }, - "revision": "20240619", + "revision": "20240731", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -594,14 +594,16 @@ "properties": { "customerOnboardingState": { "$ref": "CustomerOnboardingState", - "description": "Container for customer onboarding steps" + "description": "Output only. Container for customer onboarding steps", + "readOnly": true }, "displayName": { - "description": "The customer organization's display name. E.g. \"google.com\".", + "description": "Optional. The customer organization's display name. E.g. \"Google\".", "type": "string" }, "isOnboarded": { - "description": "Indicates whether a customer is fully onboarded", + "description": "Output only. Indicates whether a customer is fully onboarded", + "readOnly": true, "type": "boolean" }, "name": { @@ -1007,14 +1009,16 @@ "ACCESS_TRANSPARENCY_AND_EMERGENCY_ACCESS_LOGS", "ASSURED_WORKLOADS_MONITORING", "ACCESS_APPROVAL_REQUESTS", - "ASSURED_WORKLOADS_EKM_CONNECTION_STATUS" + "ASSURED_WORKLOADS_EKM_CONNECTION_STATUS", + "ACCESS_TRANSPARENCY_LOGS_SUPPORT_CASE_VIEWER" ], "enumDescriptions": [ "Unspecified partner permission", "Permission for Access Transparency and emergency logs", "Permission for Assured Workloads monitoring violations", "Permission for Access Approval requests", - "Permission for External Key Manager connection status" + "Permission for External Key Manager connection status", + "Permission for support case details for Access Transparency log entries" ], "type": "string" }, diff --git a/discovery/cloudcontrolspartner-v1beta.json b/discovery/cloudcontrolspartner-v1beta.json index b61d2878a5..5b90cb1f11 100644 --- a/discovery/cloudcontrolspartner-v1beta.json +++ b/discovery/cloudcontrolspartner-v1beta.json @@ -484,7 +484,7 @@ } } }, - "revision": "20240619", + "revision": "20240731", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -594,14 +594,16 @@ "properties": { "customerOnboardingState": { "$ref": "CustomerOnboardingState", - "description": "Container for customer onboarding steps" + "description": "Output only. Container for customer onboarding steps", + "readOnly": true }, "displayName": { - "description": "The customer organization's display name. E.g. \"google.com\".", + "description": "Optional. The customer organization's display name. E.g. \"Google\".", "type": "string" }, "isOnboarded": { - "description": "Indicates whether a customer is fully onboarded", + "description": "Output only. Indicates whether a customer is fully onboarded", + "readOnly": true, "type": "boolean" }, "name": { @@ -1007,14 +1009,16 @@ "ACCESS_TRANSPARENCY_AND_EMERGENCY_ACCESS_LOGS", "ASSURED_WORKLOADS_MONITORING", "ACCESS_APPROVAL_REQUESTS", - "ASSURED_WORKLOADS_EKM_CONNECTION_STATUS" + "ASSURED_WORKLOADS_EKM_CONNECTION_STATUS", + "ACCESS_TRANSPARENCY_LOGS_SUPPORT_CASE_VIEWER" ], "enumDescriptions": [ "Unspecified partner permission", "Permission for Access Transparency and emergency logs", "Permission for Assured Workloads monitoring violations", "Permission for Access Approval requests", - "Permission for External Key Manager connection status" + "Permission for External Key Manager connection status", + "Permission for support case details for Access Transparency log entries" ], "type": "string" }, diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index 4835cd4982..cdede2b9ab 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -219,7 +219,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent collection in which the `CustomTargetType` should be created. Format should be `projects/{project_id}/locations/{location_name}`.", + "description": "Required. The parent collection in which the `CustomTargetType` must be created. The format is `projects/{project_id}/locations/{location_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -421,7 +421,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the `CustomTargetType` 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's in the mask. If the user doesn't provide a mask then all fields are overwritten.", + "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `CustomTargetType` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -490,7 +490,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent collection in which the `DeliveryPipeline` should be created. Format should be `projects/{project_id}/locations/{location_name}`.", + "description": "Required. The parent collection in which the `DeliveryPipeline` must be created. The format is `projects/{project_id}/locations/{location_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -543,7 +543,7 @@ "type": "boolean" }, "name": { - "description": "Required. The name of the `DeliveryPipeline` to delete. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", + "description": "Required. The name of the `DeliveryPipeline` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "required": true, @@ -697,7 +697,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the `DeliveryPipeline` 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's in the mask. If the user doesn't provide a mask then all fields are overwritten.", + "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `DeliveryPipeline` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -729,7 +729,7 @@ ], "parameters": { "name": { - "description": "Required. The `DeliveryPipeline` for which the rollback `Rollout` should be created. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", + "description": "Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "required": true, @@ -925,7 +925,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent collection in which the `Automation` should be created. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", + "description": "Required. The parent collection in which the `Automation` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "required": true, @@ -973,7 +973,7 @@ "type": "string" }, "name": { - "description": "Required. The name of the `Automation` to delete. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.", + "description": "Required. The name of the `Automation` to delete. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/automations/[^/]+$", "required": true, @@ -1096,7 +1096,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the `Automation` 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's in the mask. If the user doesn't provide a mask then all fields are overwritten.", + "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `Automation` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1160,7 +1160,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent collection in which the `Release` should be created. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", + "description": "Required. The parent collection in which the `Release` is created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+$", "required": true, @@ -1362,7 +1362,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent collection in which the `Rollout` should be created. Format should be `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.", + "description": "Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/deliveryPipelines/[^/]+/releases/[^/]+$", "required": true, @@ -1773,7 +1773,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent collection in which the `Target` should be created. Format should be `projects/{project_id}/locations/{location_name}`.", + "description": "Required. The parent collection in which the `Target` must be created. The format is `projects/{project_id}/locations/{location_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1826,7 +1826,7 @@ "type": "string" }, "name": { - "description": "Required. The name of the `Target` to delete. Format should be `projects/{project_id}/locations/{location_name}/targets/{target_name}`.", + "description": "Required. The name of the `Target` to delete. The format is `projects/{project_id}/locations/{location_name}/targets/{target_name}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/targets/[^/]+$", "required": true, @@ -1980,7 +1980,7 @@ "type": "string" }, "updateMask": { - "description": "Required. Field mask is used to specify the fields to be overwritten in the Target 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's in the mask. If the user doesn't provide a mask then all fields are overwritten.", + "description": "Required. Field mask is used to specify the fields to be overwritten by the update in the `Target` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2065,7 +2065,7 @@ } } }, - "revision": "20240614", + "revision": "20240809", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -3020,6 +3020,59 @@ }, "type": "object" }, + "CustomTargetTypeNotificationEvent": { + "description": "Payload proto for \"clouddeploy.googleapis.com/customtargettype_notification\" Platform Log event that describes the failure to send a custom target type status change Pub/Sub notification.", + "id": "CustomTargetTypeNotificationEvent", + "properties": { + "customTargetType": { + "description": "The name of the `CustomTargetType`.", + "type": "string" + }, + "customTargetTypeUid": { + "description": "Unique identifier of the `CustomTargetType`.", + "type": "string" + }, + "message": { + "description": "Debug message for when a notification fails to send.", + "type": "string" + }, + "type": { + "description": "Type of this notification, e.g. for a Pub/Sub failure.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PUBSUB_NOTIFICATION_FAILURE", + "TYPE_RESOURCE_STATE_CHANGE", + "TYPE_PROCESS_ABORTED", + "TYPE_RESTRICTION_VIOLATED", + "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", + "TYPE_RENDER_STATUES_CHANGE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + true + ], + "enumDescriptions": [ + "Type is unspecified.", + "A Pub/Sub notification failed to be sent.", + "Resource state changed.", + "A process aborted.", + "Restriction check failed.", + "Resource deleted.", + "Rollout updated.", + "Deprecated: This field is never used. Use release_render log type instead." + ], + "type": "string" + } + }, + "type": "object" + }, "Date": { "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "id": "Date", @@ -3292,6 +3345,59 @@ }, "type": "object" }, + "DeployPolicyNotificationEvent": { + "description": "Payload proto for \"clouddeploy.googleapis.com/deploypolicy_notification\". Platform Log event that describes the failure to send a pub/sub notification when there is a DeployPolicy status change.", + "id": "DeployPolicyNotificationEvent", + "properties": { + "deployPolicy": { + "description": "The name of the `DeployPolicy`.", + "type": "string" + }, + "deployPolicyUid": { + "description": "Unique identifier of the deploy policy.", + "type": "string" + }, + "message": { + "description": "Debug message for when a deploy policy fails to send a pub/sub notification.", + "type": "string" + }, + "type": { + "description": "Type of this notification, e.g. for a Pub/Sub failure.", + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_PUBSUB_NOTIFICATION_FAILURE", + "TYPE_RESOURCE_STATE_CHANGE", + "TYPE_PROCESS_ABORTED", + "TYPE_RESTRICTION_VIOLATED", + "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", + "TYPE_RENDER_STATUES_CHANGE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + false, + true + ], + "enumDescriptions": [ + "Type is unspecified.", + "A Pub/Sub notification failed to be sent.", + "Resource state changed.", + "A process aborted.", + "Restriction check failed.", + "Resource deleted.", + "Rollout updated.", + "Deprecated: This field is never used. Use release_render log type instead." + ], + "type": "string" + } + }, + "type": "object" + }, "DeploymentJobs": { "description": "Deployment job composition.", "id": "DeploymentJobs", @@ -3419,6 +3525,10 @@ "description": "Required. Name of the Gateway API HTTPRoute.", "type": "string" }, + "podSelectorLabel": { + "description": "Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.", + "type": "string" + }, "routeUpdateWaitTime": { "description": "Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.", "format": "google-duration", @@ -4479,7 +4589,7 @@ "type": "object" }, "PromoteReleaseRule": { - "description": "`PromoteRelease` rule will automatically promote a release from the current target to a specified target.", + "description": "The `PromoteRelease` rule will automatically promote a release from the current target to a specified target.", "id": "PromoteReleaseRule", "properties": { "condition": { @@ -4492,7 +4602,7 @@ "type": "string" }, "destinationTargetId": { - "description": "Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * \"@next\", the next target in the promotion sequence.", + "description": "Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * \"@next\", the next target in the promotion sequence", "type": "string" }, "id": { @@ -5499,6 +5609,10 @@ "description": "Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster.", "type": "boolean" }, + "podSelectorLabel": { + "description": "Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment.", + "type": "string" + }, "service": { "description": "Required. Name of the Kubernetes Service.", "type": "string" @@ -5881,7 +5995,7 @@ "id": "TargetAttribute", "properties": { "id": { - "description": "ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * \"*\", all targets in a location.", + "description": "ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * \"*\", all targets in a location", "type": "string" }, "labels": { diff --git a/discovery/clouderrorreporting-v1beta1.json b/discovery/clouderrorreporting-v1beta1.json index 105d7f28ce..5ff6bf038a 100644 --- a/discovery/clouderrorreporting-v1beta1.json +++ b/discovery/clouderrorreporting-v1beta1.json @@ -117,7 +117,7 @@ ], "parameters": { "projectName": { - "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.", + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -162,7 +162,7 @@ "type": "string" }, "projectName": { - "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.", + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -214,7 +214,7 @@ ] }, "report": { - "description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and can analyze log entries when all of the following are true: * The log entries are stored in a log bucket in the `global` location. * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.", + "description": "Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true: * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns.", "flatPath": "v1beta1/projects/{projectsId}/events:report", "httpMethod": "POST", "id": "clouderrorreporting.projects.events.report", @@ -312,7 +312,7 @@ "type": "string" }, "projectName": { - "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). Examples: `projects/my-project-123`, `projects/5551234`.", + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID}/locations/{location}` where `{location}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -383,7 +383,7 @@ ], "parameters": { "groupName": { - "description": "Required. The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "description": "Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+/groups/[^/]+$", "required": true, @@ -408,7 +408,7 @@ ], "parameters": { "name": { - "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "location": "path", "pattern": "^projects/[^/]+/groups/[^/]+$", "required": true, @@ -427,11 +427,308 @@ ] } } + }, + "locations": { + "methods": { + "deleteEvents": { + "description": "Deletes all error events of a given project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/events", + "httpMethod": "DELETE", + "id": "clouderrorreporting.projects.locations.deleteEvents", + "parameterOrder": [ + "projectName" + ], + "parameters": { + "projectName": { + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+projectName}/events", + "response": { + "$ref": "DeleteEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "events": { + "methods": { + "list": { + "description": "Lists the specified events.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/events", + "httpMethod": "GET", + "id": "clouderrorreporting.projects.locations.events.list", + "parameterOrder": [ + "projectName" + ], + "parameters": { + "groupId": { + "description": "Required. The group for which events shall be returned. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return per response.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A `next_page_token` provided by a previous response.", + "location": "query", + "type": "string" + }, + "projectName": { + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectID}/locations/{location}`, where `{projectID}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "serviceFilter.resourceType": { + "description": "Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", + "location": "query", + "type": "string" + }, + "serviceFilter.service": { + "description": "Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).", + "location": "query", + "type": "string" + }, + "serviceFilter.version": { + "description": "Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", + "location": "query", + "type": "string" + }, + "timeRange.period": { + "description": "Restricts the query to the specified time range.", + "enum": [ + "PERIOD_UNSPECIFIED", + "PERIOD_1_HOUR", + "PERIOD_6_HOURS", + "PERIOD_1_DAY", + "PERIOD_1_WEEK", + "PERIOD_30_DAYS" + ], + "enumDescriptions": [ + "Do not use.", + "Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.", + "Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.", + "Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.", + "Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.", + "Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+projectName}/events", + "response": { + "$ref": "ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "groupStats": { + "methods": { + "list": { + "description": "Lists the specified groups.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/groupStats", + "httpMethod": "GET", + "id": "clouderrorreporting.projects.locations.groupStats.list", + "parameterOrder": [ + "projectName" + ], + "parameters": { + "alignment": { + "description": "Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`.", + "enum": [ + "ERROR_COUNT_ALIGNMENT_UNSPECIFIED", + "ALIGNMENT_EQUAL_ROUNDED", + "ALIGNMENT_EQUAL_AT_END" + ], + "enumDescriptions": [ + "No alignment specified.", + "The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the alignment_time provided in the request. The alignment_time does not have to be inside the query period but even if it is outside, only time periods are returned which overlap with the query period. A rounded alignment will typically result in a different size of the first or the last time period.", + "The time periods shall be consecutive, have width equal to the requested duration, and be aligned at the end of the requested time period. This can result in a different size of the first time period." + ], + "location": "query", + "type": "string" + }, + "alignmentTime": { + "description": "Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.", + "format": "google-datetime", + "location": "query", + "type": "string" + }, + "groupId": { + "description": "Optional. List all ErrorGroupStats with these IDs. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice] (https://cloud.google.com/terms/cloud-privacy-notice).", + "location": "query", + "repeated": true, + "type": "string" + }, + "order": { + "description": "Optional. The sort order in which the results are returned. Default is `COUNT_DESC`.", + "enum": [ + "GROUP_ORDER_UNSPECIFIED", + "COUNT_DESC", + "LAST_SEEN_DESC", + "CREATED_DESC", + "AFFECTED_USERS_DESC" + ], + "enumDescriptions": [ + "No group order specified.", + "Total count of errors in the given time window in descending order.", + "Timestamp when the group was last seen in the given time window in descending order.", + "Timestamp when the group was created in descending order.", + "Number of affected users in the given time window in descending order." + ], + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return per response. Default is 20.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.", + "location": "query", + "type": "string" + }, + "projectName": { + "description": "Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID}/locations/{location}` where `{location}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "serviceFilter.resourceType": { + "description": "Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", + "location": "query", + "type": "string" + }, + "serviceFilter.service": { + "description": "Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).", + "location": "query", + "type": "string" + }, + "serviceFilter.version": { + "description": "Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", + "location": "query", + "type": "string" + }, + "timeRange.period": { + "description": "Restricts the query to the specified time range.", + "enum": [ + "PERIOD_UNSPECIFIED", + "PERIOD_1_HOUR", + "PERIOD_6_HOURS", + "PERIOD_1_DAY", + "PERIOD_1_WEEK", + "PERIOD_30_DAYS" + ], + "enumDescriptions": [ + "Do not use.", + "Retrieve data for the last hour. Recommended minimum timed count duration: 1 min.", + "Retrieve data for the last 6 hours. Recommended minimum timed count duration: 10 min.", + "Retrieve data for the last day. Recommended minimum timed count duration: 1 hour.", + "Retrieve data for the last week. Recommended minimum timed count duration: 6 hours.", + "Retrieve data for the last 30 days. Recommended minimum timed count duration: 1 day." + ], + "location": "query", + "type": "string" + }, + "timedCountDuration": { + "description": "Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+projectName}/groupStats", + "response": { + "$ref": "ListGroupStatsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "groups": { + "methods": { + "get": { + "description": "Get the specified group.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", + "httpMethod": "GET", + "id": "clouderrorreporting.projects.locations.groups.get", + "parameterOrder": [ + "groupName" + ], + "parameters": { + "groupName": { + "description": "Required. The group resource name. Written as either `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+groupName}", + "response": { + "$ref": "ErrorGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Replace the data for the specified group. Fails if the group does not exist.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/groups/{groupsId}", + "httpMethod": "PUT", + "id": "clouderrorreporting.projects.locations.groups.update", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/groups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "ErrorGroup" + }, + "response": { + "$ref": "ErrorGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } } } } }, - "revision": "20240426", + "revision": "20240705", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { @@ -499,7 +796,7 @@ "type": "string" }, "name": { - "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice).", + "description": "The group resource name. Written as `projects/{projectID}/groups/{group_id}` or `projects/{projectID}/locations/{location}/groups/{group_id}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified.", "type": "string" }, "resolutionStatus": { @@ -682,7 +979,7 @@ "type": "string" }, "message": { - "description": "Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `\"PHP (Notice|Parse error|Fatal error|Warning): \"` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).", + "description": "Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `\"PHP (Notice|Parse error|Fatal error|Warning): \"` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack).", "type": "string" }, "serviceContext": { diff --git a/discovery/cloudfunctions-v1.json b/discovery/cloudfunctions-v1.json index 70eef292b9..570954a7bd 100644 --- a/discovery/cloudfunctions-v1.json +++ b/discovery/cloudfunctions-v1.json @@ -552,7 +552,7 @@ } } }, - "revision": "20240523", + "revision": "20240725", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -691,7 +691,7 @@ "type": "string" }, "buildServiceAccount": { - "description": "Optional. A service account the user provides for use with Cloud Build.", + "description": "A service account the user provides for use with Cloud Build. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.", "type": "string" }, "buildWorkerPool": { @@ -1019,6 +1019,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1220,6 +1224,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1421,6 +1429,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1942,7 +1954,7 @@ "type": "string" }, "url": { - "description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.", + "description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.", "type": "string" } }, diff --git a/discovery/cloudfunctions-v2.json b/discovery/cloudfunctions-v2.json index 380cd99994..f44abcc3f9 100644 --- a/discovery/cloudfunctions-v2.json +++ b/discovery/cloudfunctions-v2.json @@ -448,7 +448,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.", + "description": "The list of fields to be updated. If no field mask is provided, all fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -716,7 +716,7 @@ } } }, - "revision": "20240523", + "revision": "20240725", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -850,7 +850,7 @@ "type": "string" }, "serviceAccount": { - "description": "[Preview] Service account to be used for building the container", + "description": "Service account to be used for building the container. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.", "type": "string" }, "source": { @@ -1197,6 +1197,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1398,6 +1402,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1599,6 +1607,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" diff --git a/discovery/cloudfunctions-v2alpha.json b/discovery/cloudfunctions-v2alpha.json index 65d903cdf5..9b510dee40 100644 --- a/discovery/cloudfunctions-v2alpha.json +++ b/discovery/cloudfunctions-v2alpha.json @@ -448,7 +448,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.", + "description": "The list of fields to be updated. If no field mask is provided, all fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -716,7 +716,7 @@ } } }, - "revision": "20240523", + "revision": "20240725", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -850,7 +850,7 @@ "type": "string" }, "serviceAccount": { - "description": "[Preview] Service account to be used for building the container", + "description": "Service account to be used for building the container. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.", "type": "string" }, "source": { @@ -1197,6 +1197,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1398,6 +1402,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1599,6 +1607,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" diff --git a/discovery/cloudfunctions-v2beta.json b/discovery/cloudfunctions-v2beta.json index a4eefebc95..6ae1fbe8b9 100644 --- a/discovery/cloudfunctions-v2beta.json +++ b/discovery/cloudfunctions-v2beta.json @@ -448,7 +448,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated.", + "description": "The list of fields to be updated. If no field mask is provided, all fields will be updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -716,7 +716,7 @@ } } }, - "revision": "20240523", + "revision": "20240725", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { @@ -850,7 +850,7 @@ "type": "string" }, "serviceAccount": { - "description": "[Preview] Service account to be used for building the container", + "description": "Service account to be used for building the container. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.", "type": "string" }, "source": { @@ -1197,6 +1197,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1398,6 +1402,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" @@ -1599,6 +1607,10 @@ "description": "API version used to start the operation.", "type": "string" }, + "buildName": { + "description": "The build name of the function for create and update operations.", + "type": "string" + }, "cancelRequested": { "description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "type": "boolean" diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json index ba8aea016f..d668249f4b 100644 --- a/discovery/cloudkms-v1.json +++ b/discovery/cloudkms-v1.json @@ -20,24 +20,64 @@ "documentationLink": "https://cloud.google.com/kms/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://cloudkms.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-east7.rep.googleapis.com/", + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://cloudkms.us-west4.rep.googleapis.com/", + "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -2061,7 +2101,7 @@ } } }, - "revision": "20240613", + "revision": "20240801", "rootUrl": "https://cloudkms.googleapis.com/", "schemas": { "AsymmetricDecryptRequest": { @@ -2378,7 +2418,7 @@ "type": "string" }, "destroyScheduledDuration": { - "description": "Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours.", + "description": "Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days.", "format": "google-duration", "type": "string" }, diff --git a/discovery/cloudtrace-v2beta1.json b/discovery/cloudtrace-v2beta1.json index 4b5d691cd3..e332ace69d 100644 --- a/discovery/cloudtrace-v2beta1.json +++ b/discovery/cloudtrace-v2beta1.json @@ -273,7 +273,7 @@ } } }, - "revision": "20220428", + "revision": "20240712", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { @@ -305,7 +305,7 @@ "id": "OutputConfig", "properties": { "destination": { - "description": "The destination for writing trace data. Supported formats include: \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"", + "description": "Required. The destination for writing trace data. Supported formats include: \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"", "type": "string" } }, @@ -316,7 +316,7 @@ "id": "TraceSink", "properties": { "name": { - "description": "Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", + "description": "Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", "type": "string" }, "outputConfig": { diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index efcfe2d14c..bf63b3a4a3 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -966,7 +966,7 @@ } } }, - "revision": "20240520", + "revision": "20240716", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1304,6 +1304,11 @@ "description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index e0749f6893..b0ae932429 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -994,7 +994,7 @@ } } }, - "revision": "20240317", + "revision": "20240716", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1339,6 +1339,11 @@ "description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index d06cf7ddfb..5b33a7dd53 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -1409,6 +1409,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "listUsable": { + "description": "Retrieves a list of all usable backend buckets in the specified project.", + "flatPath": "projects/{project}/global/backendBuckets/listUsable", + "httpMethod": "GET", + "id": "compute.backendBuckets.listUsable", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/backendBuckets/listUsable", + "response": { + "$ref": "BackendBucketListUsable" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "patch": { "description": "Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", "flatPath": "projects/{project}/global/backendBuckets/{backendBucket}", @@ -6614,7 +6669,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6645,7 +6700,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6735,7 +6790,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6773,7 +6828,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6801,7 +6856,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -14084,6 +14139,210 @@ } } }, + "instantSnapshotGroups": { + "methods": { + "delete": { + "description": "deletes a Zonal InstantSnapshotGroup resource", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "DELETE", + "id": "compute.instantSnapshotGroups.delete", + "parameterOrder": [ + "project", + "zone", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the InstantSnapshot resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "returns the specified InstantSnapshotGroup resource in the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "GET", + "id": "compute.instantSnapshotGroups.get", + "parameterOrder": [ + "project", + "zone", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the InstantSnapshotGroup resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "InstantSnapshotGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "inserts a Zonal InstantSnapshotGroup resource", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "httpMethod": "POST", + "id": "compute.instantSnapshotGroups.insert", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "sourceConsistencyGroup": { + "description": "begin_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "request": { + "$ref": "InstantSnapshotGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "retrieves the list of InstantSnapshotGroup resources contained within the specified zone.", + "flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "httpMethod": "GET", + "id": "compute.instantSnapshotGroups.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instantSnapshotGroups", + "response": { + "$ref": "ListInstantSnapshotGroups" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "instantSnapshots": { "methods": { "aggregatedList": { @@ -26304,6 +26563,106 @@ } } }, + "regionInstanceGroupManagerResizeRequests": { + "methods": { + "get": { + "description": "Returns all of the details about the specified resize request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "httpMethod": "GET", + "id": "compute.regionInstanceGroupManagerResizeRequests.get", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", + "response": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagerResizeRequests.insert", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", + "request": { + "$ref": "InstanceGroupManagerResizeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "regionInstanceGroupManagers": { "methods": { "abandonInstances": { @@ -28207,6 +28566,210 @@ } } }, + "regionInstantSnapshotGroups": { + "methods": { + "delete": { + "description": "deletes a Regional InstantSnapshotGroup resource", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "DELETE", + "id": "compute.regionInstantSnapshotGroups.delete", + "parameterOrder": [ + "project", + "region", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the InstantSnapshotGroup resource to delete.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "returns the specified InstantSnapshotGroup resource in the specified region.", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", + "httpMethod": "GET", + "id": "compute.regionInstantSnapshotGroups.get", + "parameterOrder": [ + "project", + "region", + "instantSnapshotGroup" + ], + "parameters": { + "instantSnapshotGroup": { + "description": "Name of the InstantSnapshotGroup resource to return.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", + "response": { + "$ref": "InstantSnapshotGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "creates a Regional InstantSnapshotGroup resource", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", + "httpMethod": "POST", + "id": "compute.regionInstantSnapshotGroups.insert", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "sourceConsistencyGroup": { + "description": "begin_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups", + "request": { + "$ref": "InstantSnapshotGroup" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "retrieves the list of InstantSnapshotGroup resources contained within the specified region.", + "flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", + "httpMethod": "GET", + "id": "compute.regionInstantSnapshotGroups.list", + "parameterOrder": [ + "project", + "region" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/instantSnapshotGroups", + "response": { + "$ref": "ListInstantSnapshotGroups" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + } + } + }, "regionInstantSnapshots": { "methods": { "delete": { @@ -28596,204 +29159,6 @@ } } }, - "regionMultiMigs": { - "methods": { - "delete": { - "description": "Deletes a regional multiMIG in the specified project.", - "flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}", - "httpMethod": "DELETE", - "id": "compute.regionMultiMigs.delete", - "parameterOrder": [ - "project", - "region", - "multiMig" - ], - "parameters": { - "multiMig": { - "description": "Name of the multiMIG to delete.", - "location": "path", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/multiMigs/{multiMig}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "get": { - "description": "Returns the specified MultiMIG resource.", - "flatPath": "projects/{project}/regions/{region}/multiMigs/{multiMig}", - "httpMethod": "GET", - "id": "compute.regionMultiMigs.get", - "parameterOrder": [ - "project", - "region", - "multiMig" - ], - "parameters": { - "multiMig": { - "description": "Name of the MultiMig resource to return.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/multiMigs/{multiMig}", - "response": { - "$ref": "MultiMig" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - }, - "insert": { - "description": "Creates a regional multiMIG in the specified project.", - "flatPath": "projects/{project}/regions/{region}/multiMigs", - "httpMethod": "POST", - "id": "compute.regionMultiMigs.insert", - "parameterOrder": [ - "project", - "region" - ], - "parameters": { - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", - "location": "query", - "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/multiMigs", - "request": { - "$ref": "MultiMig" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "list": { - "description": "Retrieves a list of MultiMIGs in a project and region.", - "flatPath": "projects/{project}/regions/{region}/multiMigs", - "httpMethod": "GET", - "id": "compute.regionMultiMigs.list", - "parameterOrder": [ - "project", - "region" - ], - "parameters": { - "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", - "location": "query", - "type": "string" - }, - "maxResults": { - "default": "500", - "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", - "format": "uint32", - "location": "query", - "minimum": "0", - "type": "integer" - }, - "orderBy": { - "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", - "location": "query", - "type": "string" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", - "location": "query", - "type": "string" - }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" - }, - "region": { - "description": "Name of the region for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, - "type": "string" - }, - "returnPartialSuccess": { - "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", - "location": "query", - "type": "boolean" - } - }, - "path": "projects/{project}/regions/{region}/multiMigs", - "response": { - "$ref": "MultiMigsList" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ] - } - } - }, "regionNetworkEndpointGroups": { "methods": { "attachNetworkEndpoints": { @@ -30391,7 +30756,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -30430,7 +30795,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -30536,7 +30901,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -33564,7 +33929,7 @@ "regions": { "methods": { "get": { - "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", + "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -44132,7 +44497,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -44171,7 +44536,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -44277,7 +44642,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -44715,7 +45080,7 @@ } } }, - "revision": "20240618", + "revision": "20240805", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45459,6 +45824,7 @@ "PRIVATE_SERVICE_CONNECT", "SERVERLESS", "SHARED_LOADBALANCER_VIP", + "SYSTEM_MANAGED", "VPC_PEERING" ], "enumDescriptions": [ @@ -45469,6 +45835,7 @@ "A private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", "A private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.", + "A regional internal IP address that is reserved and managed by Google Cloud. It can not be assigned to Google Cloud compute resources such as VM and internal load balancer.", "IP range for peer networks." ], "type": "string" @@ -46001,7 +46368,7 @@ "type": "integer" }, "turboMode": { - "description": "Turbo mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the default turbo mode.", + "description": "Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode.", "type": "string" }, "visibleCoreCount": { @@ -46048,11 +46415,15 @@ "vmFamily": { "description": "The VM family that all instances scheduled against this reservation must belong to.", "enum": [ + "VM_FAMILY_CLOUD_TPU_DEVICE_CT3", "VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", "VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" ], "enumDescriptions": [ + "", + "", "", "", "" @@ -46139,6 +46510,14 @@ "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" + }, + "utilizations": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", + "type": "object" } }, "type": "object" @@ -47479,11 +47858,13 @@ "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.", "enum": [ "CONNECTION", + "CUSTOM_METRICS", "RATE", "UTILIZATION" ], "enumDescriptions": [ "Balance based on the number of simultaneous connections.", + "Based on custom defined and reported metrics.", "Balance based on requests per second (RPS).", "Balance based on the backend utilization." ], @@ -47494,6 +47875,13 @@ "format": "float", "type": "number" }, + "customMetrics": { + "description": "List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", + "items": { + "$ref": "BackendCustomMetric" + }, + "type": "array" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -47637,6 +48025,13 @@ "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" + }, + "usedBy": { + "description": "[Output Only] List of resources referencing that backend bucket.", + "items": { + "$ref": "BackendBucketUsedBy" + }, + "type": "array" } }, "type": "object" @@ -47923,6 +48318,187 @@ }, "type": "object" }, + "BackendBucketListUsable": { + "id": "BackendBucketListUsable", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of BackendBucket resources.", + "items": { + "$ref": "BackendBucket" + }, + "type": "array" + }, + "kind": { + "default": "compute#usableBackendBucketList", + "description": "[Output Only] Type of resource. Always compute#usableBackendBucketList for lists of usable backend buckets.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "BackendBucketUsedBy": { + "id": "BackendBucketUsedBy", + "properties": { + "reference": { + "description": "[Output Only] Server-defined URL for UrlMaps referencing that BackendBucket.", + "type": "string" + } + }, + "type": "object" + }, + "BackendCustomMetric": { + "description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", + "id": "BackendCustomMetric", + "properties": { + "dryRun": { + "description": "If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.", + "type": "boolean" + }, + "maxUtilization": { + "description": "Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].", + "format": "float", + "type": "number" + }, + "name": { + "description": "Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", + "type": "string" + } + }, + "type": "object" + }, "BackendService": { "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -48096,7 +48672,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -48105,7 +48681,8 @@ "RANDOM", "RING_HASH", "ROUND_ROBIN", - "WEIGHTED_MAGLEV" + "WEIGHTED_MAGLEV", + "WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -48115,7 +48692,8 @@ "The load balancer selects a random healthy host.", "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", - "Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." + "Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.", + "Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." ], "type": "string" }, @@ -48256,7 +48834,12 @@ "format": "int32", "type": "integer" }, + "tlsSettings": { + "$ref": "BackendServiceTlsSettings", + "description": "Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2." + }, "usedBy": { + "description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -49091,7 +49674,8 @@ "RANDOM", "RING_HASH", "ROUND_ROBIN", - "WEIGHTED_MAGLEV" + "WEIGHTED_MAGLEV", + "WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -49101,7 +49685,8 @@ "The load balancer selects a random healthy host.", "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", - "Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." + "Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.", + "Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." ], "type": "string" } @@ -49208,10 +49793,47 @@ }, "type": "object" }, + "BackendServiceTlsSettings": { + "id": "BackendServiceTlsSettings", + "properties": { + "authenticationConfig": { + "description": "Reference to the BackendAuthenticationConfig resource from the networksecurity.googleapis.com namespace. Can be used in authenticating TLS connections to the backend, as specified by the authenticationMode field. Can only be specified if authenticationMode is not NONE.", + "type": "string" + }, + "sni": { + "description": "Server Name Indication - see RFC3546 section 3.1. If set, the load balancer sends this string as the SNI hostname in the TLS connection to the backend, and requires that this string match a Subject Alternative Name (SAN) in the backend's server certificate. With a Regional Internet NEG backend, if the SNI is specified here, the load balancer uses it regardless of whether the Regional Internet NEG is specified with FQDN or IP address and port. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].", + "type": "string" + }, + "subjectAltNames": { + "description": "A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[].", + "items": { + "$ref": "BackendServiceTlsSettingsSubjectAltName" + }, + "type": "array" + } + }, + "type": "object" + }, + "BackendServiceTlsSettingsSubjectAltName": { + "description": "A Subject Alternative Name that the load balancer matches against the SAN field in the TLS certificate provided by the backend, specified as either a DNS name or a URI, in accordance with RFC 5280 4.2.1.6", + "id": "BackendServiceTlsSettingsSubjectAltName", + "properties": { + "dnsName": { + "description": "The SAN specified as a DNS Name.", + "type": "string" + }, + "uniformResourceIdentifier": { + "description": "The SAN specified as a URI.", + "type": "string" + } + }, + "type": "object" + }, "BackendServiceUsedBy": { "id": "BackendServiceUsedBy", "properties": { "reference": { + "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -50058,6 +50680,10 @@ "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, + "customEndTimestamp": { + "description": "[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.", + "type": "string" + }, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -50548,6 +51174,10 @@ "cancellationInformation": { "$ref": "CommitmentResourceStatusCancellationInformation", "description": "[Output Only] An optional, contains all the needed information of cancellation." + }, + "customTermEligibilityEndTimestamp": { + "description": "[Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.", + "type": "string" } }, "type": "object" @@ -53808,7 +54438,7 @@ "id": "FirewallPolicyRule", "properties": { "action": { - "description": "The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\".", + "description": "The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: \"allow\", \"deny\", \"apply_security_profile_group\" and \"goto_next\". Valid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\" and \"goto_next\".", "type": "string" }, "description": { @@ -53837,7 +54467,7 @@ }, "kind": { "default": "compute#firewallPolicyRule", - "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules", + "description": "[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.", "type": "string" }, "match": { @@ -53845,7 +54475,7 @@ "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." }, "priority": { - "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.", + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", "format": "int32", "type": "integer" }, @@ -53859,7 +54489,7 @@ "type": "integer" }, "securityProfileGroup": { - "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.", + "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.", "type": "string" }, "targetResources": { @@ -54972,6 +55602,10 @@ }, "type": "array" }, + "existingMatchingUsageInfo": { + "$ref": "FutureReservationStatusExistingMatchingUsageInfo", + "description": "[Output Only] Represents the existing matching usage for the future reservation." + }, "fulfilledCount": { "description": "This count indicates the fulfilled capacity so far. This is set during \"PROVISIONING\" state. This count also includes capacity delivered as part of existing matching reservations.", "format": "int64", @@ -55025,6 +55659,22 @@ }, "type": "object" }, + "FutureReservationStatusExistingMatchingUsageInfo": { + "description": "[Output Only] Represents the existing matching usage for the future reservation.", + "id": "FutureReservationStatusExistingMatchingUsageInfo", + "properties": { + "count": { + "description": "Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances)", + "format": "int64", + "type": "string" + }, + "timestamp": { + "description": "Timestamp when the matching usage was calculated", + "type": "string" + } + }, + "type": "object" + }, "FutureReservationStatusLastKnownGoodState": { "description": "The state that the future reservation will be reverted to should the amendment be declined.", "id": "FutureReservationStatusLastKnownGoodState", @@ -55033,6 +55683,10 @@ "description": "[Output Only] The description of the FutureReservation before an amendment was requested.", "type": "string" }, + "existingMatchingUsageInfo": { + "$ref": "FutureReservationStatusExistingMatchingUsageInfo", + "description": "[Output Only] Represents the matching usage for the future reservation before an amendment was requested." + }, "futureReservationSpecs": { "$ref": "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs" }, @@ -59606,8 +60260,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", - "pattern": "[a-z][-a-z0-9]{0,57}", + "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -59707,6 +60360,10 @@ "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, + "resourcePolicies": { + "$ref": "InstanceGroupManagerResourcePolicies", + "description": "Resource policies for this managed instance group." + }, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" @@ -59757,6 +60414,10 @@ "format": "int32", "type": "integer" }, + "targetSizePolicy": { + "$ref": "InstanceGroupManagerTargetSizePolicy", + "description": "Configures how target size of MIG is achieved." + }, "targetSizeUnit": { "description": "The unit of measure for the target size.", "enum": [ @@ -60418,12 +61079,16 @@ "deprecated": true, "description": "This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible." }, + "region": { + "description": "[Output Only] The URL of a region where the resize request is located. Populated only for regional resize requests.", + "type": "string" + }, "requestedRunDuration": { "$ref": "Duration", "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted." }, "resizeBy": { - "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number.", + "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.", "format": "int32", "type": "integer" }, @@ -60749,6 +61414,16 @@ }, "type": "object" }, + "InstanceGroupManagerResourcePolicies": { + "id": "InstanceGroupManagerResourcePolicies", + "properties": { + "workloadPolicy": { + "description": "The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerStandbyPolicy": { "id": "InstanceGroupManagerStandbyPolicy", "properties": { @@ -60783,6 +61458,10 @@ "description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.", "type": "string" }, + "bulkInstanceOperation": { + "$ref": "InstanceGroupManagerStatusBulkInstanceOperation", + "description": "[Output Only] Status of bulk instance operation." + }, "isStable": { "description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.", "type": "boolean" @@ -60812,6 +61491,79 @@ }, "type": "object" }, + "InstanceGroupManagerStatusBulkInstanceOperation": { + "id": "InstanceGroupManagerStatusBulkInstanceOperation", + "properties": { + "inProgress": { + "description": "[Output Only] Informs whether bulk instance operation is in progress.", + "type": "boolean" + }, + "lastProgressCheck": { + "$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", + "description": "[Output Only] Information from last progress check of bulk instance operation." + } + }, + "type": "object" + }, + "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck": { + "id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck", + "properties": { + "error": { + "description": "[Output Only] Contains errors encountered during bulk instance operation.", + "properties": { + "errors": { + "description": "[Output Only] The array of errors encountered while processing this operation.", + "items": { + "properties": { + "code": { + "description": "[Output Only] The error type identifier for this error.", + "type": "string" + }, + "errorDetails": { + "description": "[Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.", + "items": { + "properties": { + "errorInfo": { + "$ref": "ErrorInfo" + }, + "help": { + "$ref": "Help" + }, + "localizedMessage": { + "$ref": "LocalizedMessage" + }, + "quotaInfo": { + "$ref": "QuotaExceededInfo" + } + }, + "type": "object" + }, + "type": "array" + }, + "location": { + "description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.", + "type": "string" + }, + "message": { + "description": "[Output Only] An optional, human-readable error message.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "timestamp": { + "description": "[Output Only] Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerStatusStateful": { "id": "InstanceGroupManagerStatusStateful", "properties": { @@ -60851,6 +61603,26 @@ }, "type": "object" }, + "InstanceGroupManagerTargetSizePolicy": { + "id": "InstanceGroupManagerTargetSizePolicy", + "properties": { + "mode": { + "description": "Mode in which operations on size are processed.", + "enum": [ + "BULK", + "INDIVIDUAL", + "UNSPECIFIED_MODE" + ], + "enumDescriptions": [ + "Mode in which MIG creates and starts VMs in all-or-nothing manner. If any VM from the request cannot be provisioned, the whole request waits for conditions that allow for provisioning whole capacity in bulk.", + "Default mode in which MIG creates and starts VMs individually without cross-dependency between VMs. This means that in case of something blocking part of VMs to be provisioned, the other part will be created.", + "If mode is unspecified, MIG will behave as in the default `INDIVIDUAL` mode." + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerUpdatePolicy": { "id": "InstanceGroupManagerUpdatePolicy", "properties": { @@ -63613,6 +64385,14 @@ "description": "[Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name.", "type": "string" }, + "sourceInstantSnapshotGroup": { + "description": "[Output Only] URL of the source instant snapshot this instant snapshot is part of. Note that the source instant snapshot group must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL.", + "type": "string" + }, + "sourceInstantSnapshotGroupId": { + "description": "[Output Only] The ID value of the source instant snapshot group this InstantSnapshot is part of. This value may be used to determine whether the InstantSnapshot was created as part of an InstantSnapshotGroup creation.", + "type": "string" + }, "status": { "description": "[Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY.", "enum": [ @@ -63797,6 +64577,105 @@ }, "type": "object" }, + "InstantSnapshotGroup": { + "description": "Represents an InstantSnapshotGroup resource. An instant snapshot group is a set of instant snapshots that represents a point in time state of a consistency group.", + "id": "InstantSnapshotGroup", + "properties": { + "creationTimestamp": { + "description": "[Output Only] Creation timestamp in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "Optional. An optional description of this resource. Provide this property when you create the resource.", + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#instantSnapshotGroup", + "description": "[Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.", + "type": "string" + }, + "name": { + "description": "Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "region": { + "description": "[Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + }, + "resourceStatus": { + "$ref": "InstantSnapshotGroupResourceStatus" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for the resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource's resource id.", + "type": "string" + }, + "sourceConsistencyGroup": { + "type": "string" + }, + "status": { + "description": "[Output Only]", + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "INVALID", + "READY", + "UNKNOWN" + ], + "enumDescriptions": [ + "", + "", + "", + "", + "", + "" + ], + "type": "string" + }, + "zone": { + "description": "[Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", + "type": "string" + } + }, + "type": "object" + }, + "InstantSnapshotGroupResourceStatus": { + "id": "InstantSnapshotGroupResourceStatus", + "properties": { + "consistencyMembershipResolutionTime": { + "description": "[Output Only]", + "format": "google-datetime", + "type": "string" + }, + "sourceInfo": { + "$ref": "InstantSnapshotGroupSourceInfo", + "description": "[Output Only]" + } + }, + "type": "object" + }, + "InstantSnapshotGroupSourceInfo": { + "id": "InstantSnapshotGroupSourceInfo", + "properties": { + "consistencyGroup": { + "type": "string" + }, + "consistencyGroupId": { + "type": "string" + } + }, + "type": "object" + }, "InstantSnapshotList": { "description": "Contains a list of InstantSnapshot resources.", "id": "InstantSnapshotList", @@ -67126,6 +68005,168 @@ }, "type": "object" }, + "ListInstantSnapshotGroups": { + "description": "Contains a list of InstantSnapshotGroup resources.", + "id": "ListInstantSnapshotGroups", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of InstantSnapshotGroup resources.", + "items": { + "$ref": "InstantSnapshotGroup" + }, + "type": "array" + }, + "kind": { + "default": "compute#instantSnapshotGroupsList", + "description": "Type of resource.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -68592,271 +69633,6 @@ }, "type": "object" }, - "MultiMig": { - "description": "MultiMIG represents a group of Managed Instance Groups.", - "id": "MultiMig", - "properties": { - "creationTimestamp": { - "description": "[Output Only] Creation timestamp in RFC3339 text format.", - "type": "string" - }, - "description": { - "description": "An optional description of this resource. Provide this property when you create the resource.", - "type": "string" - }, - "id": { - "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", - "format": "uint64", - "type": "string" - }, - "kind": { - "default": "compute#multiMig", - "description": "[Output Only] Type of the resource. Always compute#multiMig for MultiMIGs.", - "type": "string" - }, - "locationPolicy": { - "$ref": "MultiMigLocationPolicy" - }, - "name": { - "description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "type": "string" - }, - "parts": { - "additionalProperties": { - "$ref": "MultiMigPart" - }, - "description": "User-provided names for Parts of MultiMIG and the Parts themselves.", - "type": "object" - }, - "region": { - "description": "[Output Only] URL of the region where the resource resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", - "type": "string" - }, - "schedulingPolicy": { - "$ref": "MultiMigSchedulingPolicy", - "description": "Policy for handling provisioning and other scheduling-related events." - }, - "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", - "type": "string" - }, - "selfLinkWithId": { - "description": "[Output Only] Server-defined URL for this resource with the resource id.", - "type": "string" - } - }, - "type": "object" - }, - "MultiMigLocationPolicy": { - "description": "Policy regarding where to create MIGs Initially only zonal MIGs in the same zone are supported.", - "id": "MultiMigLocationPolicy", - "properties": { - "provisioningZones": { - "description": "List of zones where MIGs will be provisioned. Should be valid RFC1035 name", - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "MultiMigPart": { - "description": "Config for an MMIG part.", - "id": "MultiMigPart", - "properties": { - "instanceGroupManager": { - "description": "Link to an existing InstanceGroupManager that will be adopted by a MultiMIG.", - "type": "string" - }, - "instanceGroupManagerProperties": { - "$ref": "InstanceGroupManager", - "description": "InstanceGroupManager to be created by the multiMig" - } - }, - "type": "object" - }, - "MultiMigSchedulingPolicy": { - "description": "Policy for handling provisioning and other scheduling-related events.", - "id": "MultiMigSchedulingPolicy", - "properties": { - "provisioning": { - "description": "How provisioning of MIGs should be scheduled (coordinated or not)", - "enum": [ - "ANY", - "COOORDINATED" - ], - "enumDescriptions": [ - "Allows idependent lifecycles of parts.", - "Requires all parts at the same time." - ], - "type": "string" - } - }, - "type": "object" - }, - "MultiMigsList": { - "id": "MultiMigsList", - "properties": { - "etag": { - "type": "string" - }, - "id": { - "description": "Unique identifier for the resource; defined by the server.", - "type": "string" - }, - "items": { - "description": "A list of MultiMig resources.", - "items": { - "$ref": "MultiMig" - }, - "type": "array" - }, - "kind": { - "default": "compute#multiMigList", - "description": "Type of resource.", - "type": "string" - }, - "nextPageToken": { - "description": "This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", - "type": "string" - }, - "selfLink": { - "description": "[Output only] Server-defined URL for this resource.", - "type": "string" - }, - "unreachables": { - "description": "[Output only] Unreachable resources.", - "items": { - "type": "string" - }, - "type": "array" - }, - "warning": { - "description": "Informational warning message.", - "properties": { - "code": { - "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", - "enum": [ - "CLEANUP_FAILED", - "DEPRECATED_RESOURCE_USED", - "DEPRECATED_TYPE_USED", - "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", - "EXPERIMENTAL_TYPE_USED", - "EXTERNAL_API_WARNING", - "FIELD_VALUE_OVERRIDEN", - "INJECTED_KERNELS_DEPRECATED", - "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", - "LARGE_DEPLOYMENT_WARNING", - "LIST_OVERHEAD_QUOTA_EXCEED", - "MISSING_TYPE_DEPENDENCY", - "NEXT_HOP_ADDRESS_NOT_ASSIGNED", - "NEXT_HOP_CANNOT_IP_FORWARD", - "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", - "NEXT_HOP_INSTANCE_NOT_FOUND", - "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", - "NEXT_HOP_NOT_RUNNING", - "NOT_CRITICAL_ERROR", - "NO_RESULTS_ON_PAGE", - "PARTIAL_SUCCESS", - "REQUIRED_TOS_AGREEMENT", - "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", - "RESOURCE_NOT_DELETED", - "SCHEMA_VALIDATION_IGNORED", - "SINGLE_INSTANCE_PROPERTY_TEMPLATE", - "UNDECLARED_PROPERTIES", - "UNREACHABLE" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false - ], - "enumDescriptions": [ - "Warning about failed cleanup of transient changes made by a failed operation.", - "A link to a deprecated resource was created.", - "When deploying and at least one of the resources has a type marked as deprecated", - "The user created a boot disk that is larger than image size.", - "When deploying and at least one of the resources has a type marked as experimental", - "Warning that is present in an external api call", - "Warning that value of a field has been overridden. Deprecated unused field.", - "The operation involved use of an injected kernel, which is deprecated.", - "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", - "When deploying a deployment with a exceedingly large number of resources", - "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", - "A resource depends on a missing type", - "The route's nextHopIp address is not assigned to an instance on the network.", - "The route's next hop instance cannot ip forward.", - "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", - "The route's nextHopInstance URL refers to an instance that does not exist.", - "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", - "The route's next hop instance does not have a status of RUNNING.", - "Error which is not critical. We decided to continue the process despite the mentioned error.", - "No results are present on a particular list page.", - "Success is reported, but some results may be missing due to errors", - "The user attempted to use a resource that requires a TOS they have not accepted.", - "Warning that a resource is in use.", - "One or more of the resources set to auto-delete could not be deleted because they were in use.", - "When a resource schema validation is ignored.", - "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", - "When undeclared properties in the schema are present", - "A given scope cannot be reached." - ], - "type": "string" - }, - "data": { - "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", - "items": { - "properties": { - "key": { - "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", - "type": "string" - }, - "value": { - "description": "[Output Only] A warning data value corresponding to the key.", - "type": "string" - } - }, - "type": "object" - }, - "type": "array" - }, - "message": { - "description": "[Output Only] A human-readable description of the warning code.", - "type": "string" - } - }, - "type": "object" - } - }, - "type": "object" - }, "MutualTls": { "description": "[Deprecated] Configuration for the mutual Tls mode for peer authentication. Configuration for the mutual Tls mode for peer authentication.", "id": "MutualTls", @@ -70061,12 +70837,6 @@ "format": "int32", "type": "integer" }, - "clientPort": { - "deprecated": true, - "description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", - "format": "int32", - "type": "integer" - }, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -70110,19 +70880,6 @@ "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, - "clientPortMappingMode": { - "deprecated": true, - "description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", - "enum": [ - "CLIENT_PORT_PER_ENDPOINT", - "PORT_MAPPING_DISABLED" - ], - "enumDescriptions": [ - "For each endpoint there is exactly one client port.", - "NEG should not be used for mapping client port to destination." - ], - "type": "string" - }, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -71988,6 +72745,7 @@ "PRIVATE_SERVICE_CONNECT", "SERVERLESS", "SHARED_LOADBALANCER_VIP", + "SYSTEM_MANAGED", "VPC_PEERING" ], "enumDescriptions": [ @@ -71998,6 +72756,7 @@ "A private network IP address that can be used to configure Private Service Connect. This purpose can be specified only for GLOBAL addresses of Type INTERNAL", "A regional internal IP address range reserved for Serverless.", "A private network IP address that can be shared by multiple Internal Load Balancer forwarding rules.", + "A regional internal IP address that is reserved and managed by Google Cloud. It can not be assigned to Google Cloud compute resources such as VM and internal load balancer.", "IP range for peer networks." ], "type": "string" @@ -82117,6 +82876,9 @@ "vmMaintenancePolicy": { "$ref": "ResourcePolicyVmMaintenancePolicy", "description": "Resource policy applicable to VMs for infrastructure maintenance." + }, + "workloadPolicy": { + "$ref": "ResourcePolicyWorkloadPolicy" } }, "type": "object" @@ -82796,6 +83558,24 @@ }, "type": "object" }, + "ResourcePolicyWorkloadPolicy": { + "description": "Represents the workload policy.", + "id": "ResourcePolicyWorkloadPolicy", + "properties": { + "type": { + "enum": [ + "HIGH_AVAILABILITY", + "HIGH_THROUGHPUT" + ], + "enumDescriptions": [ + "VMs will be provisioned in such a way which provides high availability.", + "VMs will be provisioned in such a way which provides high throughput." + ], + "type": "string" + } + }, + "type": "object" + }, "ResourceStatus": { "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.", "id": "ResourceStatus", @@ -82874,7 +83654,7 @@ "id": "ResourceStatusScheduling", "properties": { "availabilityDomain": { - "description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", + "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", "format": "int32", "type": "integer" }, @@ -84426,6 +85206,13 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "nat64Subnetworks": { + "description": "List of Subnetwork resources whose traffic should be translated by NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is selected for the SubnetworkIpRangeToNat64Option above.", + "items": { + "$ref": "RouterNatSubnetworkToNat64" + }, + "type": "array" + }, "natIpAllocateOption": { "description": "Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. ", "enum": [ @@ -84466,6 +85253,18 @@ ], "type": "string" }, + "sourceSubnetworkIpRangesToNat64": { + "description": "Specify the Nat option for NAT64, which can take one of the following values: - ALL_IPV6_SUBNETWORKS: All of the IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field nat64_subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other Router.Nat section in this region can also enable NAT64 for any Subnetworks in this network. Other Router.Nat sections can still be present to enable NAT44 only.", + "enum": [ + "ALL_IPV6_SUBNETWORKS", + "LIST_OF_IPV6_SUBNETWORKS" + ], + "enumDescriptions": [ + "NAT64 is enabled for all the IPv6 subnet ranges. In dual stack subnets, NAT64 will only be enabled for IPv6-only VMs.", + "NAT64 is enabled for a list of IPv6 subnet ranges. In dual stack subnets, NAT64 will only be enabled for IPv6-only VMs. If this option is used, the nat64_subnetworks field must be specified." + ], + "type": "string" + }, "subnetworks": { "description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.", "items": { @@ -84625,6 +85424,17 @@ }, "type": "object" }, + "RouterNatSubnetworkToNat64": { + "description": "Specifies a subnetwork to enable NAT64.", + "id": "RouterNatSubnetworkToNat64", + "properties": { + "name": { + "description": "URL for the subnetwork resource that will use NAT64.", + "type": "string" + } + }, + "type": "object" + }, "RouterStatus": { "id": "RouterStatus", "properties": { @@ -85854,7 +86664,7 @@ "type": "boolean" }, "availabilityDomain": { - "description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", + "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", "format": "int32", "type": "integer" }, @@ -85971,26 +86781,6 @@ "terminationTime": { "description": "Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.", "type": "string" - }, - "windowsLicenseOptimizationMode": { - "description": "Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`.", - "enum": [ - "AUTO", - "BALANCED", - "COST_OPTIMIZED", - "OFF", - "PERFORMANCE", - "UNSPECIFIED" - ], - "enumDescriptions": [ - "\"Automatically maximize savings and minimize performance impact by matching license optimization mode to current CPU utilization.", - "Significant license cost savings via moderate throttles (40% baseline, 10 minute maximum burst at full utilization).", - "Maximum license cost savings via restrictive throttles (20% baseline, 3.75 minute maximum burst at full utilization).", - "No license cost savings with maximum CPU performance.", - "Moderate license cost savings via least restrictive throttles (60% baseline, 22.5 minute maximum burst at full utilization).", - "Unspecified license optimization mode defaults to `OFF`." - ], - "type": "string" } }, "type": "object" @@ -92666,6 +93456,7 @@ "enum": [ "AGGREGATE", "CLOUD_EXTENSION", + "CUSTOM_HARDWARE_LINK", "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", "PRIVATE", @@ -92677,6 +93468,7 @@ "enumDescriptions": [ "Subnetwork used to aggregate multiple private subnetworks.", "Subnetworks created for Cloud Extension Machines.", + "Subnetwork used for Custom Hardware Link.", "Subnet reserved for Global Envoy-based Load Balancing.", "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", "Regular user created or automatically created subnet.", @@ -94441,7 +95233,7 @@ "type": "string" }, "certificateMap": { - "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", + "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", "type": "string" }, "creationTimestamp": { @@ -94519,7 +95311,7 @@ "type": "string" }, "sslCertificates": { - "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.", + "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. ", "items": { "type": "string" }, @@ -97616,7 +98408,7 @@ "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { - "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", + "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { @@ -98319,6 +99111,7 @@ "enum": [ "AGGREGATE", "CLOUD_EXTENSION", + "CUSTOM_HARDWARE_LINK", "GLOBAL_MANAGED_PROXY", "INTERNAL_HTTPS_LOAD_BALANCER", "PRIVATE", @@ -98330,6 +99123,7 @@ "enumDescriptions": [ "Subnetwork used to aggregate multiple private subnetworks.", "Subnetworks created for Cloud Extension Machines.", + "Subnetwork used for Custom Hardware Link.", "Subnet reserved for Global Envoy-based Load Balancing.", "Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy purpose, please use REGIONAL_MANAGED_PROXY instead.", "Regular user created or automatically created subnet.", @@ -98900,7 +99694,7 @@ "type": "string" }, "stackType": { - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", + "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", @@ -99534,7 +100328,7 @@ "type": "object" }, "localTrafficSelector": { - "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.", + "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -99564,7 +100358,7 @@ "type": "string" }, "peerIp": { - "description": "IP address of the peer VPN gateway. Only IPv4 is supported.", + "description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.", "type": "string" }, "region": { @@ -99572,7 +100366,7 @@ "type": "string" }, "remoteTrafficSelector": { - "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.", + "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -99629,7 +100423,7 @@ "type": "string" }, "targetVpnGateway": { - "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", + "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.", "type": "string" }, "vpnGateway": { diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 4e768d5c6f..20e394e8d4 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -3669,6 +3669,40 @@ "https://www.googleapis.com/auth/compute" ] }, + "addPacketMirroringRule": { + "description": "Inserts a packet mirroring rule into a firewall policy.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.firewallPolicies.addPacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule", @@ -3862,6 +3896,39 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getPacketMirroringRule": { + "description": "Gets a packet mirroring rule of the specified priority.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "httpMethod": "GET", + "id": "compute.firewallPolicies.getPacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to which the queried rule belongs.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to get from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + } + }, + "path": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "response": { + "$ref": "FirewallPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule", @@ -4066,6 +4133,46 @@ "https://www.googleapis.com/auth/compute" ] }, + "patchPacketMirroringRule": { + "description": "Patches a packet mirroring rule of the specified priority.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.firewallPolicies.patchPacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -4142,6 +4249,43 @@ "https://www.googleapis.com/auth/compute" ] }, + "removePacketMirroringRule": { + "description": "Deletes a packet mirroring rule of the specified priority.", + "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "httpMethod": "POST", + "id": "compute.firewallPolicies.removePacketMirroringRule", + "parameterOrder": [ + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "(firewallPolicies/)?[0-9]{0,20}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -6346,7 +6490,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6377,7 +6521,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6467,7 +6611,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6505,7 +6649,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -6533,7 +6677,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -17184,6 +17328,60 @@ "https://www.googleapis.com/auth/compute" ] }, + "addPacketMirroringRule": { + "description": "Inserts a packet mirroring rule into a firewall policy.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.networkFirewallPolicies.addPacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "maxPriority": { + "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "minPriority": { + "description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", @@ -17437,6 +17635,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getPacketMirroringRule": { + "description": "Gets a packet mirroring rule of the specified priority.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "httpMethod": "GET", + "id": "compute.networkFirewallPolicies.getPacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to which the queried rule belongs.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to get from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", + "response": { + "$ref": "FirewallPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", @@ -17609,6 +17848,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "patchPacketMirroringRule": { + "description": "Patches a packet mirroring rule of the specified priority.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "httpMethod": "POST", + "id": "compute.networkFirewallPolicies.patchPacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", + "request": { + "$ref": "FirewallPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -17701,6 +17988,51 @@ "https://www.googleapis.com/auth/compute" ] }, + "removePacketMirroringRule": { + "description": "Deletes a packet mirroring rule of the specified priority.", + "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "httpMethod": "POST", + "id": "compute.networkFirewallPolicies.removePacketMirroringRule", + "parameterOrder": [ + "project", + "firewallPolicy" + ], + "parameters": { + "firewallPolicy": { + "description": "Name of the firewall policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "priority": { + "description": "The priority of the rule to remove from the firewall policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -28492,7 +28824,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -28531,7 +28863,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -28637,7 +28969,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -31184,7 +31516,7 @@ "regions": { "methods": { "get": { - "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", + "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -41306,7 +41638,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41345,7 +41677,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41451,7 +41783,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -41579,7 +41911,7 @@ } } }, - "revision": "20240618", + "revision": "20240805", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -42833,6 +43165,10 @@ "format": "int32", "type": "integer" }, + "turboMode": { + "description": "Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode.", + "type": "string" + }, "visibleCoreCount": { "description": "The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width.", "format": "int32", @@ -42877,11 +43213,15 @@ "vmFamily": { "description": "The VM family that all instances scheduled against this reservation must belong to.", "enum": [ + "VM_FAMILY_CLOUD_TPU_DEVICE_CT3", "VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", "VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" ], "enumDescriptions": [ + "", + "", "", "", "" @@ -42930,6 +43270,26 @@ }, "type": "object" }, + "AllocationReservationSharingPolicy": { + "id": "AllocationReservationSharingPolicy", + "properties": { + "serviceShareType": { + "description": "Sharing config for all Google Cloud services.", + "enum": [ + "ALLOW_ALL", + "DISALLOW_ALL", + "SERVICE_SHARE_TYPE_UNSPECIFIED" + ], + "enumDescriptions": [ + "Allow all Google Cloud managed services to share reservations.", + "[Default] Disallow sharing with all Google Cloud services.", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "AllocationResourceStatus": { "description": "[Output Only] Contains output only fields.", "id": "AllocationResourceStatus", @@ -42948,6 +43308,14 @@ "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" + }, + "utilizations": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", + "type": "object" } }, "type": "object" @@ -44708,6 +45076,25 @@ "description": "If true, enables Cloud CDN for the backend service of a global external Application Load Balancer.", "type": "boolean" }, + "externalManagedMigrationState": { + "description": "Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.", + "enum": [ + "PREPARE", + "TEST_ALL_TRAFFIC", + "TEST_BY_PERCENTAGE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "externalManagedMigrationTestingPercentage": { + "description": "Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.", + "format": "float", + "type": "number" + }, "failoverPolicy": { "$ref": "BackendServiceFailoverPolicy", "description": "Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview)." @@ -44782,7 +45169,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -44904,7 +45291,8 @@ "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", - "NONE" + "NONE", + "STRONG_COOKIE_AFFINITY" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -44914,10 +45302,15 @@ "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", - "No session affinity. Connections from the same client IP may go to any instance in the pool." + "No session affinity. Connections from the same client IP may go to any instance in the pool.", + "Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "type": "string" }, + "strongSessionAffinityCookie": { + "$ref": "BackendServiceHttpCookie", + "description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." + }, "subsetting": { "$ref": "Subsetting" }, @@ -44927,6 +45320,7 @@ "type": "integer" }, "usedBy": { + "description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -45293,6 +45687,25 @@ }, "type": "object" }, + "BackendServiceHttpCookie": { + "description": "The HTTP cookie used for stateful session affinity.", + "id": "BackendServiceHttpCookie", + "properties": { + "name": { + "description": "Name of the cookie.", + "type": "string" + }, + "path": { + "description": "Path to set for the cookie.", + "type": "string" + }, + "ttl": { + "$ref": "Duration", + "description": "Lifetime of the cookie." + } + }, + "type": "object" + }, "BackendServiceIAP": { "description": "Identity-Aware Proxy", "id": "BackendServiceIAP", @@ -45729,6 +46142,7 @@ "id": "BackendServiceUsedBy", "properties": { "reference": { + "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -46586,6 +47000,7 @@ "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", + "GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -46616,6 +47031,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49848,6 +50264,13 @@ "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.", "type": "string" }, + "packetMirroringRules": { + "description": "A list of packet mirroring rules that belong to this policy.", + "items": { + "$ref": "FirewallPolicyRule" + }, + "type": "array" + }, "parent": { "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" @@ -50063,7 +50486,7 @@ "id": "FirewallPolicyRule", "properties": { "action": { - "description": "The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\".", + "description": "The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: \"allow\", \"deny\", \"apply_security_profile_group\" and \"goto_next\". Valid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\" and \"goto_next\".", "type": "string" }, "description": { @@ -50092,7 +50515,7 @@ }, "kind": { "default": "compute#firewallPolicyRule", - "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules", + "description": "[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.", "type": "string" }, "match": { @@ -50100,7 +50523,7 @@ "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." }, "priority": { - "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.", + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", "format": "int32", "type": "integer" }, @@ -50114,7 +50537,7 @@ "type": "integer" }, "securityProfileGroup": { - "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.", + "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.", "type": "string" }, "targetResources": { @@ -50360,6 +50783,25 @@ "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" }, + "externalManagedBackendBucketMigrationState": { + "description": "Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.", + "enum": [ + "PREPARE", + "TEST_ALL_TRAFFIC", + "TEST_BY_PERCENTAGE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, + "externalManagedBackendBucketMigrationTestingPercentage": { + "description": "Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE.", + "format": "float", + "type": "number" + }, "fingerprint": { "description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule.", "format": "byte", @@ -51088,6 +51530,10 @@ "$ref": "ShareSettings", "description": "List of Projects/Folders to share with." }, + "specificReservationRequired": { + "description": "Indicates whether the auto-created reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation.", + "type": "boolean" + }, "specificSkuProperties": { "$ref": "FutureReservationSpecificSKUProperties", "description": "Future Reservation configuration to indicate instance properties and total count." @@ -51153,6 +51599,10 @@ }, "type": "array" }, + "existingMatchingUsageInfo": { + "$ref": "FutureReservationStatusExistingMatchingUsageInfo", + "description": "[Output Only] Represents the existing matching usage for the future reservation." + }, "fulfilledCount": { "description": "This count indicates the fulfilled capacity so far. This is set during \"PROVISIONING\" state. This count also includes capacity delivered as part of existing matching reservations.", "format": "int64", @@ -51206,6 +51656,22 @@ }, "type": "object" }, + "FutureReservationStatusExistingMatchingUsageInfo": { + "description": "[Output Only] Represents the existing matching usage for the future reservation.", + "id": "FutureReservationStatusExistingMatchingUsageInfo", + "properties": { + "count": { + "description": "Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances)", + "format": "int64", + "type": "string" + }, + "timestamp": { + "description": "Timestamp when the matching usage was calculated", + "type": "string" + } + }, + "type": "object" + }, "FutureReservationStatusLastKnownGoodState": { "description": "The state that the future reservation will be reverted to should the amendment be declined.", "id": "FutureReservationStatusLastKnownGoodState", @@ -51214,6 +51680,10 @@ "description": "[Output Only] The description of the FutureReservation before an amendment was requested.", "type": "string" }, + "existingMatchingUsageInfo": { + "$ref": "FutureReservationStatusExistingMatchingUsageInfo", + "description": "[Output Only] Represents the matching usage for the future reservation before an amendment was requested." + }, "futureReservationSpecs": { "$ref": "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs" }, @@ -55330,8 +55800,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", - "pattern": "[a-z][-a-z0-9]{0,57}", + "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -55763,13 +56232,6 @@ "InstanceGroupManagerInstanceFlexibilityPolicy": { "id": "InstanceGroupManagerInstanceFlexibilityPolicy", "properties": { - "instanceSelectionLists": { - "additionalProperties": { - "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" - }, - "description": "Named instance selections configuring properties that the group will use when creating new VMs.", - "type": "object" - }, "instanceSelections": { "additionalProperties": { "$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection" @@ -56059,7 +56521,7 @@ "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted." }, "resizeBy": { - "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number.", + "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.", "format": "int32", "type": "integer" }, @@ -58756,6 +59218,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -58773,9 +59240,13 @@ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "", "", @@ -62646,6 +63117,20 @@ }, "type": "array" }, + "architecture": { + "description": "[Output Only] The architecture of the machine type.", + "enum": [ + "ARCHITECTURE_UNSPECIFIED", + "ARM64", + "X86_64" + ], + "enumDescriptions": [ + "Default value indicating Architecture is not set.", + "Machines with architecture ARM64", + "Machines with architecture X86_64" + ], + "type": "string" + }, "bundledLocalSsds": { "$ref": "BundledLocalSsds", "description": "[Output Only] The configuration of bundled local SSD for the machine type." @@ -63208,11 +63693,6 @@ "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.", "type": "string" }, - "instanceFlexibilityOverride": { - "$ref": "ManagedInstanceInstanceFlexibilityOverride", - "deprecated": true, - "description": "[Output Only] The overrides to instance properties resulting from InstanceFlexibilityPolicy." - }, "instanceHealth": { "description": "[Output Only] Health state of the instance per health-check.", "items": { @@ -63303,16 +63783,6 @@ }, "type": "object" }, - "ManagedInstanceInstanceFlexibilityOverride": { - "id": "ManagedInstanceInstanceFlexibilityOverride", - "properties": { - "machineType": { - "description": "The machine type to be used for this instance.", - "type": "string" - } - }, - "type": "object" - }, "ManagedInstanceInstanceHealth": { "id": "ManagedInstanceInstanceHealth", "properties": { @@ -64659,12 +65129,6 @@ "format": "int32", "type": "integer" }, - "clientPort": { - "deprecated": true, - "description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", - "format": "int32", - "type": "integer" - }, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -64704,19 +65168,6 @@ "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, - "clientPortMappingMode": { - "deprecated": true, - "description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", - "enum": [ - "CLIENT_PORT_PER_ENDPOINT", - "PORT_MAPPING_DISABLED" - ], - "enumDescriptions": [ - "For each endpoint there is exactly one client port.", - "NEG should not be used for mapping client port to destination." - ], - "type": "string" - }, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -65985,6 +66436,34 @@ "description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.", "id": "NetworkRoutingConfig", "properties": { + "bgpAlwaysCompareMed": { + "description": "Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm.", + "type": "boolean" + }, + "bgpBestPathSelectionMode": { + "description": "The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD.", + "enum": [ + "LEGACY", + "STANDARD" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, + "bgpInterRegionCost": { + "description": "Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED.", + "enum": [ + "ADD_COST_TO_MED", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "routingMode": { "description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.", "enum": [ @@ -66066,6 +66545,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -66082,9 +66566,11 @@ "enum": [ "HIERARCHY", "NETWORK", + "SYSTEM", "UNSPECIFIED" ], "enumDescriptions": [ + "", "", "", "" @@ -73434,6 +73920,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -73447,9 +73938,13 @@ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "", "", @@ -73582,6 +74077,10 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "reservationSharingPolicy": { + "$ref": "AllocationReservationSharingPolicy", + "description": "Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services." + }, "resourcePolicies": { "additionalProperties": { "type": "string" @@ -75020,6 +75519,11 @@ "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "properties": { + "availabilityDomain": { + "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", + "format": "int32", + "type": "integer" + }, "terminationTimestamp": { "description": "Time in future when the instance will be terminated in RFC3339 text format.", "type": "string" @@ -75118,6 +75622,11 @@ "description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/", "type": "string" }, + "nextHopInterRegionCost": { + "description": "[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.", + "format": "uint32", + "type": "integer" + }, "nextHopInterconnectAttachment": { "description": "[Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment.", "type": "string" @@ -75126,10 +75635,29 @@ "description": "The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.", "type": "string" }, + "nextHopMed": { + "description": "[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.", + "format": "uint32", + "type": "integer" + }, "nextHopNetwork": { "description": "The URL of the local network if it should handle matching packets.", "type": "string" }, + "nextHopOrigin": { + "description": "[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE.", + "enum": [ + "EGP", + "IGP", + "INCOMPLETE" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + }, "nextHopPeering": { "description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.", "type": "string" @@ -77646,6 +78174,11 @@ "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, + "availabilityDomain": { + "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", + "format": "int32", + "type": "integer" + }, "hostErrorTimeoutSeconds": { "description": "Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.", "format": "int32", @@ -85371,7 +85904,7 @@ "type": "string" }, "certificateMap": { - "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", + "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", "type": "string" }, "creationTimestamp": { @@ -85445,7 +85978,7 @@ "type": "string" }, "sslCertificates": { - "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.", + "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. ", "items": { "type": "string" }, @@ -86364,7 +86897,8 @@ "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", - "NONE" + "NONE", + "STRONG_COOKIE_AFFINITY" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -86374,7 +86908,8 @@ "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", - "No session affinity. Connections from the same client IP may go to any instance in the pool." + "No session affinity. Connections from the same client IP may go to any instance in the pool.", + "Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "type": "string" } @@ -88396,7 +88931,7 @@ "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { - "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", + "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { @@ -89651,7 +90186,7 @@ "type": "string" }, "stackType": { - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", + "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", @@ -90285,7 +90820,7 @@ "type": "object" }, "localTrafficSelector": { - "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.", + "description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -90315,7 +90850,7 @@ "type": "string" }, "peerIp": { - "description": "IP address of the peer VPN gateway. Only IPv4 is supported.", + "description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels.", "type": "string" }, "region": { @@ -90323,7 +90858,7 @@ "type": "string" }, "remoteTrafficSelector": { - "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.", + "description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels.", "items": { "type": "string" }, @@ -90380,7 +90915,7 @@ "type": "string" }, "targetVpnGateway": { - "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.", + "description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels.", "type": "string" }, "vpnGateway": { diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index 9518b041c9..c824c1b651 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -4814,6 +4814,364 @@ } } }, + "futureReservations": { + "methods": { + "aggregatedList": { + "description": "Retrieves an aggregated list of future reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.", + "flatPath": "projects/{project}/aggregated/futureReservations", + "httpMethod": "GET", + "id": "compute.futureReservations.aggregatedList", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "includeAllScopes": { + "description": "Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.", + "location": "query", + "type": "boolean" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "serviceProjectNumber": { + "description": "The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/aggregated/futureReservations", + "response": { + "$ref": "FutureReservationsAggregatedListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "cancel": { + "description": "Cancel the specified future reservation.", + "flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel", + "httpMethod": "POST", + "id": "compute.futureReservations.cancel", + "parameterOrder": [ + "project", + "zone", + "futureReservation" + ], + "parameters": { + "futureReservation": { + "description": "Name of the future reservation to retrieve. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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" + }, + "zone": { + "description": "Name of the zone for this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "delete": { + "description": "Deletes the specified future reservation.", + "flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}", + "httpMethod": "DELETE", + "id": "compute.futureReservations.delete", + "parameterOrder": [ + "project", + "zone", + "futureReservation" + ], + "parameters": { + "futureReservation": { + "description": "Name of the future reservation to retrieve. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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" + }, + "zone": { + "description": "Name of the zone for this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "get": { + "description": "Retrieves information about the specified future reservation.", + "flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}", + "httpMethod": "GET", + "id": "compute.futureReservations.get", + "parameterOrder": [ + "project", + "zone", + "futureReservation" + ], + "parameters": { + "futureReservation": { + "description": "Name of the future reservation to retrieve. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}", + "response": { + "$ref": "FutureReservation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "insert": { + "description": "Creates a new Future Reservation.", + "flatPath": "projects/{project}/zones/{zone}/futureReservations", + "httpMethod": "POST", + "id": "compute.futureReservations.insert", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/futureReservations", + "request": { + "$ref": "FutureReservation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "list": { + "description": "A list of all the future reservations that have been configured for the specified project in specified zone.", + "flatPath": "projects/{project}/zones/{zone}/futureReservations", + "httpMethod": "GET", + "id": "compute.futureReservations.list", + "parameterOrder": [ + "project", + "zone" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", + "location": "query", + "type": "boolean" + }, + "zone": { + "description": "Name of the zone for this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/futureReservations", + "response": { + "$ref": "FutureReservationsListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, + "update": { + "description": "Updates the specified future reservation.", + "flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}", + "httpMethod": "PATCH", + "id": "compute.futureReservations.update", + "parameterOrder": [ + "project", + "zone", + "futureReservation" + ], + "parameters": { + "futureReservation": { + "description": "Name of the reservation to update. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 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": "update_mask indicates fields to be updated as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "zone": { + "description": "Name of the zone for this request. Name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}", + "request": { + "$ref": "FutureReservation" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "globalAddresses": { "methods": { "delete": { @@ -5736,7 +6094,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -5767,7 +6125,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -5857,7 +6215,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -5895,7 +6253,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -5923,7 +6281,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -25614,7 +25972,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -25653,7 +26011,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -25759,7 +26117,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -27980,7 +28338,7 @@ "regions": { "methods": { "get": { - "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", + "description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -37148,7 +37506,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to delete.", + "description": "Name of the Operations resource to delete, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -37187,7 +37545,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -37293,7 +37651,7 @@ ], "parameters": { "operation": { - "description": "Name of the Operations resource to return.", + "description": "Name of the Operations resource to return, or its unique numeric identifier.", "location": "path", "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, @@ -37421,7 +37779,7 @@ } } }, - "revision": "20240618", + "revision": "20240730", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -38719,11 +39077,15 @@ "vmFamily": { "description": "The VM family that all instances scheduled against this reservation must belong to.", "enum": [ + "VM_FAMILY_CLOUD_TPU_DEVICE_CT3", "VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L", "VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP", + "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P", "VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P" ], "enumDescriptions": [ + "", + "", "", "", "" @@ -40542,7 +40904,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -40687,6 +41049,7 @@ "type": "integer" }, "usedBy": { + "description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -41489,6 +41852,7 @@ "id": "BackendServiceUsedBy", "properties": { "reference": { + "description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -42242,6 +42606,7 @@ "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", + "GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -42272,6 +42637,7 @@ "", "", "", + "", "" ], "type": "string" @@ -45661,7 +46027,7 @@ "id": "FirewallPolicyRule", "properties": { "action": { - "description": "The Action to perform when the client connection triggers the rule. Valid actions are \"allow\", \"deny\" and \"goto_next\".", + "description": "The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: \"allow\", \"deny\", \"apply_security_profile_group\" and \"goto_next\". Valid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\" and \"goto_next\".", "type": "string" }, "description": { @@ -45690,7 +46056,7 @@ }, "kind": { "default": "compute#firewallPolicyRule", - "description": "[Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules", + "description": "[Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules.", "type": "string" }, "match": { @@ -45698,7 +46064,7 @@ "description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced." }, "priority": { - "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.", + "description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority.", "format": "int32", "type": "integer" }, @@ -45712,7 +46078,7 @@ "type": "integer" }, "securityProfileGroup": { - "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.", + "description": "A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions.", "type": "string" }, "targetResources": { @@ -46609,6 +46975,786 @@ }, "type": "object" }, + "FutureReservation": { + "id": "FutureReservation", + "properties": { + "autoCreatedReservationsDeleteTime": { + "description": "Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid href=\"https://www.ietf.org/rfc/rfc3339.txt\">RFC3339 value.", + "type": "string" + }, + "autoCreatedReservationsDuration": { + "$ref": "Duration", + "description": "Specifies the duration of auto-created reservations. It represents relative time to future reservation start_time when auto-created reservations will be automatically deleted by Compute Engine. Duration time unit is represented as a count of seconds and fractions of seconds at nanosecond resolution." + }, + "autoDeleteAutoCreatedReservations": { + "description": "Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.", + "type": "boolean" + }, + "creationTimestamp": { + "description": "[Output Only] The creation timestamp for this future reservation in RFC3339 text format.", + "type": "string" + }, + "description": { + "description": "An optional description of this resource. Provide this property when you create the future reservation.", + "type": "string" + }, + "id": { + "description": "[Output Only] A unique identifier for this future reservation. The server defines this identifier.", + "format": "uint64", + "type": "string" + }, + "kind": { + "default": "compute#futureReservation", + "description": "[Output Only] Type of the resource. Always compute#futureReservation for future reservations.", + "type": "string" + }, + "name": { + "annotations": { + "required": [ + "compute.instances.insert" + ] + }, + "description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "type": "string" + }, + "namePrefix": { + "description": "Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####.", + "type": "string" + }, + "planningStatus": { + "description": "Planning state before being submitted for evaluation", + "enum": [ + "DRAFT", + "PLANNING_STATUS_UNSPECIFIED", + "SUBMITTED" + ], + "enumDescriptions": [ + "Future Reservation is being drafted.", + "", + "Future Reservation has been submitted for evaluation by GCP." + ], + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined fully-qualified URL for this resource.", + "type": "string" + }, + "selfLinkWithId": { + "description": "[Output Only] Server-defined URL for this resource with the resource id.", + "type": "string" + }, + "shareSettings": { + "$ref": "ShareSettings", + "description": "List of Projects/Folders to share with." + }, + "specificReservationRequired": { + "description": "Indicates whether the auto-created reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation.", + "type": "boolean" + }, + "specificSkuProperties": { + "$ref": "FutureReservationSpecificSKUProperties", + "description": "Future Reservation configuration to indicate instance properties and total count." + }, + "status": { + "$ref": "FutureReservationStatus", + "description": "[Output only] Status of the Future Reservation" + }, + "timeWindow": { + "$ref": "FutureReservationTimeWindow", + "description": "Time window for this Future Reservation." + }, + "zone": { + "description": "[Output Only] URL of the Zone where this future reservation resides.", + "type": "string" + } + }, + "type": "object" + }, + "FutureReservationSpecificSKUProperties": { + "id": "FutureReservationSpecificSKUProperties", + "properties": { + "instanceProperties": { + "$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties", + "description": "Properties of the SKU instances being reserved." + }, + "sourceInstanceTemplate": { + "description": "The instance template that will be used to populate the ReservedInstanceProperties of the future reservation", + "type": "string" + }, + "totalCount": { + "description": "Total number of instances for which capacity assurance is requested at a future time period.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "FutureReservationStatus": { + "description": "[Output only] Represents status related to the future reservation.", + "id": "FutureReservationStatus", + "properties": { + "amendmentStatus": { + "description": "[Output Only] The current status of the requested amendment.", + "enum": [ + "AMENDMENT_APPROVED", + "AMENDMENT_DECLINED", + "AMENDMENT_IN_REVIEW", + "AMENDMENT_STATUS_UNSPECIFIED" + ], + "enumDescriptions": [ + "The requested amendment to the Future Resevation has been approved and applied by GCP.", + "The requested amendment to the Future Reservation has been declined by GCP and the original state was restored.", + "The requested amendment to the Future Reservation is currently being reviewd by GCP.", + "" + ], + "type": "string" + }, + "autoCreatedReservations": { + "description": "Fully qualified urls of the automatically created reservations at start_time.", + "items": { + "type": "string" + }, + "type": "array" + }, + "existingMatchingUsageInfo": { + "$ref": "FutureReservationStatusExistingMatchingUsageInfo", + "description": "[Output Only] Represents the existing matching usage for the future reservation." + }, + "fulfilledCount": { + "description": "This count indicates the fulfilled capacity so far. This is set during \"PROVISIONING\" state. This count also includes capacity delivered as part of existing matching reservations.", + "format": "int64", + "type": "string" + }, + "lastKnownGoodState": { + "$ref": "FutureReservationStatusLastKnownGoodState", + "description": "[Output Only] This field represents the future reservation before an amendment was requested. If the amendment is declined, the Future Reservation will be reverted to the last known good state. The last known good state is not set when updating a future reservation whose Procurement Status is DRAFTING." + }, + "lockTime": { + "description": "Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time.", + "type": "string" + }, + "procurementStatus": { + "description": "Current state of this Future Reservation", + "enum": [ + "APPROVED", + "CANCELLED", + "COMMITTED", + "DECLINED", + "DRAFTING", + "FAILED", + "FAILED_PARTIALLY_FULFILLED", + "FULFILLED", + "PENDING_AMENDMENT_APPROVAL", + "PENDING_APPROVAL", + "PROCUREMENT_STATUS_UNSPECIFIED", + "PROCURING", + "PROVISIONING" + ], + "enumDescriptions": [ + "Future reservation is approved by GCP.", + "Future reservation is cancelled by the customer.", + "Future reservation is committed by the customer.", + "Future reservation is rejected by GCP.", + "Related status for PlanningStatus.Draft. Transitions to PENDING_APPROVAL upon user submitting FR.", + "Future reservation failed. No additional reservations were provided.", + "Future reservation is partially fulfilled. Additional reservations were provided but did not reach total_count reserved instance slots.", + "Future reservation is fulfilled completely.", + "An Amendment to the Future Reservation has been requested. If the Amendment is declined, the Future Reservation will be restored to the last known good state.", + "Future reservation is pending approval by GCP.", + "", + "Future reservation is being procured by GCP. Beyond this point, Future reservation is locked and no further modifications are allowed.", + "Future reservation capacity is being provisioned. This state will be entered after start_time, while reservations are being created to provide total_count reserved instance slots. This state will not persist past start_time + 24h." + ], + "type": "string" + }, + "specificSkuProperties": { + "$ref": "FutureReservationStatusSpecificSKUProperties" + } + }, + "type": "object" + }, + "FutureReservationStatusExistingMatchingUsageInfo": { + "description": "[Output Only] Represents the existing matching usage for the future reservation.", + "id": "FutureReservationStatusExistingMatchingUsageInfo", + "properties": { + "count": { + "description": "Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances)", + "format": "int64", + "type": "string" + }, + "timestamp": { + "description": "Timestamp when the matching usage was calculated", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "FutureReservationStatusLastKnownGoodState": { + "description": "The state that the future reservation will be reverted to should the amendment be declined.", + "id": "FutureReservationStatusLastKnownGoodState", + "properties": { + "description": { + "description": "[Output Only] The description of the FutureReservation before an amendment was requested.", + "type": "string" + }, + "existingMatchingUsageInfo": { + "$ref": "FutureReservationStatusExistingMatchingUsageInfo", + "description": "[Output Only] Represents the matching usage for the future reservation before an amendment was requested." + }, + "futureReservationSpecs": { + "$ref": "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs" + }, + "lockTime": { + "description": "[Output Only] The lock time of the FutureReservation before an amendment was requested.", + "type": "string" + }, + "namePrefix": { + "description": "[Output Only] The name prefix of the Future Reservation before an amendment was requested.", + "type": "string" + }, + "procurementStatus": { + "description": "[Output Only] The status of the last known good state for the Future Reservation.", + "enum": [ + "APPROVED", + "CANCELLED", + "COMMITTED", + "DECLINED", + "DRAFTING", + "FAILED", + "FAILED_PARTIALLY_FULFILLED", + "FULFILLED", + "PENDING_AMENDMENT_APPROVAL", + "PENDING_APPROVAL", + "PROCUREMENT_STATUS_UNSPECIFIED", + "PROCURING", + "PROVISIONING" + ], + "enumDescriptions": [ + "Future reservation is approved by GCP.", + "Future reservation is cancelled by the customer.", + "Future reservation is committed by the customer.", + "Future reservation is rejected by GCP.", + "Related status for PlanningStatus.Draft. Transitions to PENDING_APPROVAL upon user submitting FR.", + "Future reservation failed. No additional reservations were provided.", + "Future reservation is partially fulfilled. Additional reservations were provided but did not reach total_count reserved instance slots.", + "Future reservation is fulfilled completely.", + "An Amendment to the Future Reservation has been requested. If the Amendment is declined, the Future Reservation will be restored to the last known good state.", + "Future reservation is pending approval by GCP.", + "", + "Future reservation is being procured by GCP. Beyond this point, Future reservation is locked and no further modifications are allowed.", + "Future reservation capacity is being provisioned. This state will be entered after start_time, while reservations are being created to provide total_count reserved instance slots. This state will not persist past start_time + 24h." + ], + "type": "string" + } + }, + "type": "object" + }, + "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs": { + "description": "The properties of the last known good state for the Future Reservation.", + "id": "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs", + "properties": { + "shareSettings": { + "$ref": "ShareSettings", + "description": "[Output Only] The previous share settings of the Future Reservation." + }, + "specificSkuProperties": { + "$ref": "FutureReservationSpecificSKUProperties", + "description": "[Output Only] The previous instance related properties of the Future Reservation." + }, + "timeWindow": { + "$ref": "FutureReservationTimeWindow", + "description": "[Output Only] The previous time window of the Future Reservation." + } + }, + "type": "object" + }, + "FutureReservationStatusSpecificSKUProperties": { + "description": "Properties to be set for the Future Reservation.", + "id": "FutureReservationStatusSpecificSKUProperties", + "properties": { + "sourceInstanceTemplateId": { + "description": "ID of the instance template used to populate the Future Reservation properties.", + "type": "string" + } + }, + "type": "object" + }, + "FutureReservationTimeWindow": { + "id": "FutureReservationTimeWindow", + "properties": { + "duration": { + "$ref": "Duration" + }, + "endTime": { + "type": "string" + }, + "startTime": { + "description": "Start time of the Future Reservation. The start_time is an RFC3339 string.", + "type": "string" + } + }, + "type": "object" + }, + "FutureReservationsAggregatedListResponse": { + "description": "Contains a list of future reservations.", + "id": "FutureReservationsAggregatedListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "additionalProperties": { + "$ref": "FutureReservationsScopedList", + "description": "Name of the scope containing this set of future reservations." + }, + "description": "A list of Future reservation resources.", + "type": "object" + }, + "kind": { + "default": "compute#futureReservationsAggregatedListResponse", + "description": "[Output Only] Type of resource. Always compute#futureReservationsAggregatedListResponse for future resevation aggregated list response.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "FutureReservationsListResponse": { + "id": "FutureReservationsListResponse", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", + "type": "string" + }, + "items": { + "description": "[Output Only] A list of future reservation resources.", + "items": { + "$ref": "FutureReservation" + }, + "type": "array" + }, + "kind": { + "default": "compute#futureReservationsListResponse", + "description": "[Output Only] Type of resource.Always compute#FutureReservationsListResponse for lists of reservations", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "unreachables": { + "description": "[Output Only] Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "FutureReservationsScopedList": { + "id": "FutureReservationsScopedList", + "properties": { + "futureReservations": { + "description": "A list of future reservations contained in this scope.", + "items": { + "$ref": "FutureReservation" + }, + "type": "array" + }, + "warning": { + "description": "Informational warning which replaces the list of future reservations when the list is empty.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "GRPCHealthCheck": { "id": "GRPCHealthCheck", "properties": { @@ -47067,6 +48213,13 @@ "description": "[Output Only] Server-defined URL for the resource.", "type": "string" }, + "sourceRegions": { + "description": "The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. ", + "items": { + "type": "string" + }, + "type": "array" + }, "sslHealthCheck": { "$ref": "SSLHealthCheck" }, @@ -50039,8 +51192,7 @@ "type": "array" }, "baseInstanceName": { - "description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", - "pattern": "[a-z][-a-z0-9]{0,57}", + "description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -50650,7 +51802,7 @@ "description": "Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted." }, "resizeBy": { - "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number.", + "description": "The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.", "format": "int32", "type": "integer" }, @@ -53180,6 +54332,11 @@ "description": "[Output Only] The name of the firewall policy.", "type": "string" }, + "priority": { + "description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", + "format": "int32", + "type": "integer" + }, "rules": { "description": "The rules that apply to the network.", "items": { @@ -53197,9 +54354,13 @@ "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", + "SYSTEM_GLOBAL", + "SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ + "", + "", "", "", "", @@ -69005,12 +70166,26 @@ "description": "[Output Only] An opaque ID of the host on which the VM is running.", "type": "string" }, + "scheduling": { + "$ref": "ResourceStatusScheduling" + }, "upcomingMaintenance": { "$ref": "UpcomingMaintenance" } }, "type": "object" }, + "ResourceStatusScheduling": { + "id": "ResourceStatusScheduling", + "properties": { + "availabilityDomain": { + "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Route": { "description": "Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.", "id": "Route", @@ -71222,6 +72397,11 @@ "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, + "availabilityDomain": { + "description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", + "format": "int32", + "type": "integer" + }, "instanceTerminationAction": { "description": "Specifies the termination action for the instance.", "enum": [ @@ -78411,7 +79591,7 @@ "type": "string" }, "certificateMap": { - "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", + "description": "URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}.", "type": "string" }, "creationTimestamp": { @@ -78478,7 +79658,7 @@ "type": "string" }, "sslCertificates": { - "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED.", + "description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project}/locations/{ location}/certificates/{resourceName}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project }/locations/{location}/certificates/{resourceName}. ", "items": { "type": "string" }, @@ -81429,7 +82609,7 @@ "description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions, such as URL rewrites and header transformations, before forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. URL maps for classic Application Load Balancers only support the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true." }, "defaultService": { - "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", + "description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.", "type": "string" }, "defaultUrlRedirect": { @@ -82684,7 +83864,7 @@ "type": "string" }, "stackType": { - "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", + "description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/discovery/config-v1.json b/discovery/config-v1.json index 7942e93605..6c3fdb72f3 100644 --- a/discovery/config-v1.json +++ b/discovery/config-v1.json @@ -1187,7 +1187,7 @@ } } }, - "revision": "20240424", + "revision": "20240710", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -2545,12 +2545,12 @@ "id": "TerraformBlueprint", "properties": { "gcsSource": { - "description": "Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", + "description": "URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", "type": "string" }, "gitSource": { "$ref": "GitSource", - "description": "Required. URI of a public Git repo." + "description": "URI of a public Git repo." }, "inputValues": { "additionalProperties": { diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index 26acbb8389..ddffab3251 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -2427,7 +2427,7 @@ } } }, - "revision": "20240625", + "revision": "20240729", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2600,7 +2600,7 @@ }, "omitQueryParams": { "description": "Optional. Omit query params from the redirect URI.", - "type": "string" + "type": "boolean" }, "scopes": { "description": "The scopes for which the user will authorize Google Cloud Connectors on the connector data source.", @@ -2826,6 +2826,10 @@ "description": "Connection represents an instance of connector.", "id": "Connection", "properties": { + "asyncOperationsEnabled": { + "description": "Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.", + "type": "boolean" + }, "authConfig": { "$ref": "AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." @@ -3252,6 +3256,15 @@ "format": "int64", "type": "string" }, + "maxInstanceRequestConcurrency": { + "description": "Max Instance Request Conncurrency for Cloud Run service.", + "format": "int32", + "type": "integer" + }, + "migrateDeploymentModel": { + "description": "Indicate whether connector is being migrated to cloud run deployment model.", + "type": "boolean" + }, "ratelimitThreshold": { "description": "Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -3331,6 +3344,16 @@ "description": "Output only. Eventing configuration supported by the Connector.", "readOnly": true }, + "isCustomActionsSupported": { + "description": "Output only. Is custom actions supported.", + "readOnly": true, + "type": "boolean" + }, + "isCustomEntitiesSupported": { + "description": "Output only. Is custom entities supported.", + "readOnly": true, + "type": "boolean" + }, "labels": { "additionalProperties": { "type": "string" @@ -3395,6 +3418,22 @@ "description": "Output only. Information about the runtime features supported by the Connector.", "readOnly": true }, + "supportedStandardActions": { + "description": "Output only. Supported standard actions.", + "items": { + "$ref": "StandardAction" + }, + "readOnly": true, + "type": "array" + }, + "supportedStandardEntities": { + "description": "Output only. Supported standard entities.", + "items": { + "$ref": "StandardEntity" + }, + "readOnly": true, + "type": "array" + }, "unsupportedConnectionTypes": { "description": "Output only. Unsupported connection types.", "items": { @@ -3448,6 +3487,25 @@ ], "type": "string" }, + "deploymentModelMigrationState": { + "description": "Output only. Status of the deployment model migration.", + "enum": [ + "DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED", + "IN_PROGRESS", + "COMPLETED", + "ROLLEDBACK", + "ROLLBACK_IN_PROGRESS" + ], + "enumDescriptions": [ + "Deployment model migration state is not specified.", + "Deployment model migration is in progress.", + "Deployment model migration is completed.", + "Deployment model migration rolledback.", + "Deployment model migration rollback in progress." + ], + "readOnly": true, + "type": "string" + }, "hpaConfig": { "$ref": "HPAConfig", "description": "Output only. HPA autoscaling config.", @@ -3459,6 +3517,12 @@ "readOnly": true, "type": "string" }, + "maxInstanceRequestConcurrency": { + "description": "Output only. Max instance request concurrency.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, "ratelimitThreshold": { "description": "Output only. Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -5892,7 +5956,7 @@ "type": "array" }, "valueSeparator": { - "description": "Required. Value separator.", + "description": "Required. Value separator. Only \",\" can be used for OAuth auth code flow scope field.", "type": "string" } }, @@ -6536,6 +6600,10 @@ ], "type": "string" }, + "defaultValue": { + "description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", + "type": "any" + }, "description": { "description": "A brief description of the field.", "type": "string" @@ -6547,6 +6615,10 @@ "jsonSchema": { "$ref": "JsonSchema", "description": "JsonSchema representation of this action's result" + }, + "nullable": { + "description": "Specifies whether a null value is allowed.", + "type": "boolean" } }, "type": "object" @@ -7157,6 +7229,28 @@ }, "type": "object" }, + "StandardAction": { + "description": "Standard action", + "id": "StandardAction", + "properties": { + "name": { + "description": "Name of the standard action.", + "type": "string" + } + }, + "type": "object" + }, + "StandardEntity": { + "description": "Standard entity", + "id": "StandardEntity", + "properties": { + "name": { + "description": "Name of the standard entity.", + "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", diff --git a/discovery/connectors-v2.json b/discovery/connectors-v2.json index 1da3a38be4..080f2b678a 100644 --- a/discovery/connectors-v2.json +++ b/discovery/connectors-v2.json @@ -660,7 +660,7 @@ } } }, - "revision": "20240619", + "revision": "20240729", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -724,6 +724,25 @@ }, "type": "object" }, + "AuthCodeData": { + "description": "AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens.", + "id": "AuthCodeData", + "properties": { + "authCode": { + "description": "OAuth authorization code.", + "type": "string" + }, + "pkceVerifier": { + "description": "OAuth PKCE verifier, needed if PKCE is enabled for this particular connection.", + "type": "string" + }, + "redirectUri": { + "description": "OAuth redirect URI passed in during the auth code flow, required by some OAuth backends.", + "type": "string" + } + }, + "type": "object" + }, "CheckReadinessResponse": { "description": "Response containing status of the connector for readiness prober.", "id": "CheckReadinessResponse", @@ -888,9 +907,14 @@ "type": "object" }, "ExchangeAuthCodeRequest": { - "description": "ExchangeAuthCodeRequest currently includes no fields.", + "description": "ExchangeAuthCodeRequest currently includes the auth code data.", "id": "ExchangeAuthCodeRequest", - "properties": {}, + "properties": { + "authCodeData": { + "$ref": "AuthCodeData", + "description": "Optional. AuthCodeData contains the data the runtime requires to exchange for access and refresh tokens. If the data is not provided, the runtime will read the data from the secret manager." + } + }, "type": "object" }, "ExchangeAuthCodeResponse": { @@ -2105,9 +2129,14 @@ "type": "object" }, "RefreshAccessTokenRequest": { - "description": "RefreshAccessTokenRequest currently includes no fields.", + "description": "RefreshAccessTokenRequest includes the refresh token.", "id": "RefreshAccessTokenRequest", - "properties": {}, + "properties": { + "refreshToken": { + "description": "Optional. Refresh Token String. If the Refresh Token is not provided, the runtime will read the data from the secret manager.", + "type": "string" + } + }, "type": "object" }, "RefreshAccessTokenResponse": { @@ -2269,6 +2298,10 @@ ], "type": "string" }, + "defaultValue": { + "description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", + "type": "any" + }, "description": { "description": "A brief description of the metadata field.", "type": "string" @@ -2280,6 +2313,10 @@ "name": { "description": "Name of the metadata field.", "type": "string" + }, + "nullable": { + "description": "Specifies whether a null value is allowed.", + "type": "boolean" } }, "type": "object" diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index 7d799fe621..5eb074f8b6 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -109,6 +109,31 @@ "resources": { "locations": { "methods": { + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "contactcenterinsights.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getSettings": { "description": "Gets project-level settings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", @@ -640,6 +665,38 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:initialize", + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "insightsdata": { "methods": { "export": { @@ -1474,7 +1531,7 @@ } } }, - "revision": "20240624", + "revision": "20240805", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -2646,6 +2703,21 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1Entity": { "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "id": "GoogleCloudContactcenterinsightsV1Entity", @@ -3193,6 +3265,54 @@ "properties": {}, "type": "object" }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", + "properties": { + "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" + }, + "partialErrors": { + "description": "Partial errors during initialising operation that might cause the operation output to be incomplete.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { + "description": "The response to initialize a location-level encryption specification.", + "id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1Intent", @@ -3235,6 +3355,10 @@ "readOnly": true, "type": "string" }, + "displayDescription": { + "description": "Representative description of the issue.", + "type": "string" + }, "displayName": { "description": "The representative name for the issue.", "type": "string" @@ -3806,6 +3930,20 @@ "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY" + ], + "enumDescriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." + ], + "type": "string" } }, "type": "object" @@ -5166,6 +5304,21 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1Entity": { "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "id": "GoogleCloudContactcenterinsightsV1alpha1Entity", @@ -5702,6 +5855,54 @@ "properties": {}, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata", + "properties": { + "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" + }, + "partialErrors": { + "description": "Partial errors during initialising operation that might cause the operation output to be incomplete.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "request": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, + "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { + "description": "The response to initialize a location-level encryption specification.", + "id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1alpha1Intent", @@ -6037,6 +6238,20 @@ "query": { "description": "Query text. Article Search uses this to store the input query used to generate the search results.", "type": "string" + }, + "querySource": { + "description": "Query source for the answer.", + "enum": [ + "QUERY_SOURCE_UNSPECIFIED", + "AGENT_QUERY", + "SUGGESTED_QUERY" + ], + "enumDescriptions": [ + "Unknown query source.", + "The query is from agents.", + "The query is a query from previous suggestions, e.g. from a preceding SuggestKnowledgeAssist response." + ], + "type": "string" } }, "type": "object" diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 713284b93e..34e9ad78db 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20240608", + "revision": "20240722", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2592,14 +2592,14 @@ "properties": { "maxPodsPerNode": { "$ref": "MaxPodsConstraint", - "description": "The maximum number of pods per node which use this pod network" + "description": "The maximum number of pods per node which use this pod network." }, "secondaryPodRange": { - "description": "The name of the secondary range on the subnet which provides IP address for this pod range", + "description": "The name of the secondary range on the subnet which provides IP address for this pod range.", "type": "string" }, "subnetwork": { - "description": "Name of the subnetwork where the additional pod network belongs", + "description": "Name of the subnetwork where the additional pod network belongs.", "type": "string" } }, @@ -2610,7 +2610,7 @@ "id": "AdditionalPodRangesConfig", "properties": { "podRangeInfo": { - "description": "Output only. [Output only] Information for additional pod range.", + "description": "Output only. Information for additional pod range.", "items": { "$ref": "RangeInfo" }, @@ -2676,6 +2676,10 @@ "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes." }, + "rayOperatorConfig": { + "$ref": "RayOperatorConfig", + "description": "Optional. Configuration for Ray Operator addon." + }, "statefulHaConfig": { "$ref": "StatefulHAConfig", "description": "Optional. Configuration for the StatefulHA add-on." @@ -2750,11 +2754,13 @@ "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { - "description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "description": { - "description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", + "description": "Output only. This field is set when upgrades are about to commence with the description of the upgrade.", + "readOnly": true, "type": "string" } }, @@ -3157,22 +3163,26 @@ "description": "Configuration for the fine-grained cost management feature." }, "createTime": { - "description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "currentMasterVersion": { - "description": "[Output only] The current software version of the master endpoint.", + "description": "Output only. The current software version of the master endpoint.", + "readOnly": true, "type": "string" }, "currentNodeCount": { "deprecated": true, - "description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", + "description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "format": "int32", + "readOnly": true, "type": "integer" }, "currentNodeVersion": { "deprecated": true, - "description": "[Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", + "description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", + "readOnly": true, "type": "string" }, "databaseEncryption": { @@ -3200,7 +3210,8 @@ "type": "boolean" }, "endpoint": { - "description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", + "description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", + "readOnly": true, "type": "string" }, "enterpriseConfig": { @@ -3212,7 +3223,8 @@ "type": "string" }, "expireTime": { - "description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "fleet": { @@ -3240,10 +3252,11 @@ }, "instanceGroupUrls": { "deprecated": true, - "description": "Deprecated. Use node_pools.instance_group_urls.", + "description": "Output only. Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "ipAllocationPolicy": { @@ -3259,7 +3272,8 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { - "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "readOnly": true, "type": "string" }, "locations": { @@ -3323,8 +3337,9 @@ "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { - "description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", + "description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", + "readOnly": true, "type": "integer" }, "nodePoolAutoConfig": { @@ -3384,11 +3399,13 @@ "description": "Enable/Disable Security Posture API features for the cluster." }, "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", + "description": "Output only. Server-defined URL for the resource.", + "readOnly": true, "type": "string" }, "servicesIpv4Cidr": { - "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", + "description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", + "readOnly": true, "type": "string" }, "shieldedNodes": { @@ -3396,7 +3413,7 @@ "description": "Shielded Nodes configuration." }, "status": { - "description": "[Output only] The current status of this cluster.", + "description": "Output only. The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -3415,11 +3432,13 @@ "The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], + "readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, - "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", + "description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", + "readOnly": true, "type": "string" }, "subnetwork": { @@ -3427,7 +3446,8 @@ "type": "string" }, "tpuIpv4CidrBlock": { - "description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", + "description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", + "readOnly": true, "type": "string" }, "verticalPodAutoscaling": { @@ -3440,7 +3460,8 @@ }, "zone": { "deprecated": true, - "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", + "readOnly": true, "type": "string" } }, @@ -3980,7 +4001,8 @@ "id": "DailyMaintenanceWindow", "properties": { "duration": { - "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".", + "description": "Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".", + "readOnly": true, "type": "string" }, "startTime": { @@ -4087,7 +4109,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { - "description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", + "description": "Output only. cluster_tier indicates the effective tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", @@ -4158,11 +4180,13 @@ "id": "Fleet", "properties": { "membership": { - "description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", + "description": "Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", + "readOnly": true, "type": "string" }, "preRegistered": { - "description": "[Output only] Whether the cluster has been registered through the fleet API.", + "description": "Output only. Whether the cluster has been registered through the fleet API.", + "readOnly": true, "type": "boolean" }, "project": { @@ -4464,7 +4488,7 @@ "properties": { "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", - "description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", + "description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, "clusterIpv4Cidr": { @@ -4485,7 +4509,7 @@ "type": "boolean" }, "defaultPodIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4527,7 +4551,7 @@ "type": "string" }, "servicesIpv6CidrBlock": { - "description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", + "description": "Output only. The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, @@ -4550,7 +4574,7 @@ "type": "string" }, "subnetIpv6CidrBlock": { - "description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", + "description": "Output only. The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, @@ -4928,7 +4952,8 @@ "id": "MasterAuth", "properties": { "clientCertificate": { - "description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", + "description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", + "readOnly": true, "type": "string" }, "clientCertificateConfig": { @@ -4936,11 +4961,13 @@ "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued." }, "clientKey": { - "description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", + "description": "Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.", + "readOnly": true, "type": "string" }, "clusterCaCertificate": { - "description": "[Output only] Base64-encoded public certificate that is the root of trust for the cluster.", + "description": "Output only. Base64-encoded public certificate that is the root of trust for the cluster.", + "readOnly": true, "type": "string" }, "password": { @@ -5157,6 +5184,7 @@ }, "network": { "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", + "readOnly": true, "type": "string" }, "networkPerformanceConfig": { @@ -5185,6 +5213,7 @@ }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", + "readOnly": true, "type": "string" } }, @@ -5601,7 +5630,7 @@ "type": "string" }, "podIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -5646,10 +5675,11 @@ "type": "integer" }, "instanceGroupUrls": { - "description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", + "description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "locations": { @@ -5680,8 +5710,9 @@ "description": "Specifies the node placement policy." }, "podIpv4CidrSize": { - "description": "[Output only] The pod CIDR block size per node in this node pool.", + "description": "Output only. The pod CIDR block size per node in this node pool.", "format": "int32", + "readOnly": true, "type": "integer" }, "queuedProvisioning": { @@ -5689,11 +5720,12 @@ "description": "Specifies the configuration of queued provisioning." }, "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", + "description": "Output only. Server-defined URL for the resource.", + "readOnly": true, "type": "string" }, "status": { - "description": "[Output only] The status of the nodes in this pool instance.", + "description": "Output only. The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -5712,16 +5744,18 @@ "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], + "readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, - "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", + "description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", + "readOnly": true, "type": "string" }, "updateInfo": { "$ref": "UpdateInfo", - "description": "Output only. [Output only] Update info contains relevant information during a node pool update.", + "description": "Output only. Update info contains relevant information during a node pool update.", "readOnly": true }, "upgradeSettings": { @@ -5894,11 +5928,13 @@ "type": "array" }, "detail": { - "description": "Detailed operation progress, if available.", + "description": "Output only. Detailed operation progress, if available.", + "readOnly": true, "type": "string" }, "endTime": { - "description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "error": { @@ -5906,11 +5942,13 @@ "description": "The error result of the operation in case of failure." }, "location": { - "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "readOnly": true, "type": "string" }, "name": { - "description": "The server-assigned ID for the operation.", + "description": "Output only. The server-assigned ID for the operation.", + "readOnly": true, "type": "string" }, "nodepoolConditions": { @@ -5922,7 +5960,7 @@ "type": "array" }, "operationType": { - "description": "The operation type.", + "description": "Output only. The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", @@ -5986,23 +6024,26 @@ "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], + "readOnly": true, "type": "string" }, "progress": { "$ref": "OperationProgress", - "description": "Output only. [Output only] Progress information for an operation.", + "description": "Output only. Progress information for an operation.", "readOnly": true }, "selfLink": { - "description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", + "description": "Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", + "readOnly": true, "type": "string" }, "startTime": { - "description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "status": { - "description": "The current status of the operation.", + "description": "Output only. The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", @@ -6017,6 +6058,7 @@ "The operation is done, either cancelled or completed.", "The operation is aborting." ], + "readOnly": true, "type": "string" }, "statusMessage": { @@ -6026,12 +6068,14 @@ "type": "string" }, "targetLink": { - "description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", + "description": "Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", + "readOnly": true, "type": "string" }, "zone": { "deprecated": true, - "description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", + "readOnly": true, "type": "string" } }, @@ -6178,10 +6222,12 @@ }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", + "readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", + "readOnly": true, "type": "string" }, "privateEndpointSubnetwork": { @@ -6190,6 +6236,7 @@ }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", + "readOnly": true, "type": "string" } }, @@ -6259,12 +6306,12 @@ "id": "RangeInfo", "properties": { "rangeName": { - "description": "Output only. [Output only] Name of a range.", + "description": "Output only. Name of a range.", "readOnly": true, "type": "string" }, "utilization": { - "description": "Output only. [Output only] The utilization of the range.", + "description": "Output only. The utilization of the range.", "format": "double", "readOnly": true, "type": "number" @@ -6272,6 +6319,47 @@ }, "type": "object" }, + "RayClusterLoggingConfig": { + "description": "RayClusterLoggingConfig specifies configuration of Ray logging.", + "id": "RayClusterLoggingConfig", + "properties": { + "enabled": { + "description": "Enable log collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayClusterMonitoringConfig": { + "description": "RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.", + "id": "RayClusterMonitoringConfig", + "properties": { + "enabled": { + "description": "Enable metrics collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayOperatorConfig": { + "description": "Configuration options for the Ray Operator add-on.", + "id": "RayOperatorConfig", + "properties": { + "enabled": { + "description": "Whether the Ray Operator addon is enabled for this cluster.", + "type": "boolean" + }, + "rayClusterLoggingConfig": { + "$ref": "RayClusterLoggingConfig", + "description": "Optional. Logging configuration for Ray clusters." + }, + "rayClusterMonitoringConfig": { + "$ref": "RayClusterMonitoringConfig", + "description": "Optional. Monitoring configuration for Ray clusters." + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", @@ -6297,13 +6385,15 @@ "UNSPECIFIED", "RAPID", "REGULAR", - "STABLE" + "STABLE", + "EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", - "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." + "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", + "Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" } @@ -6320,13 +6410,15 @@ "UNSPECIFIED", "RAPID", "REGULAR", - "STABLE" + "STABLE", + "EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", - "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." + "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", + "Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" }, diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 5812847424..cbd2695256 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20240618", + "revision": "20240730", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2641,7 +2641,7 @@ "id": "AdditionalPodRangesConfig", "properties": { "podRangeInfo": { - "description": "Output only. [Output only] Information for additional pod range.", + "description": "Output only. Information for additional pod range.", "items": { "$ref": "RangeInfo" }, @@ -2717,6 +2717,10 @@ "$ref": "NetworkPolicyConfig", "description": "Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes." }, + "rayOperatorConfig": { + "$ref": "RayOperatorConfig", + "description": "Optional. Configuration for Ray Operator addon." + }, "statefulHaConfig": { "$ref": "StatefulHAConfig", "description": "Optional. Configuration for the StatefulHA add-on." @@ -2791,11 +2795,13 @@ "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { - "description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "description": { - "description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", + "description": "Output only. This field is set when upgrades are about to commence with the description of the upgrade.", + "readOnly": true, "type": "string" } }, @@ -3270,22 +3276,26 @@ "description": "Configuration for the fine-grained cost management feature." }, "createTime": { - "description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "currentMasterVersion": { - "description": "[Output only] The current software version of the master endpoint.", + "description": "Output only. The current software version of the master endpoint.", + "readOnly": true, "type": "string" }, "currentNodeCount": { "deprecated": true, - "description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", + "description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "format": "int32", + "readOnly": true, "type": "integer" }, "currentNodeVersion": { "deprecated": true, - "description": "[Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", + "description": "Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", + "readOnly": true, "type": "string" }, "databaseEncryption": { @@ -3313,7 +3323,8 @@ "type": "boolean" }, "endpoint": { - "description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", + "description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", + "readOnly": true, "type": "string" }, "enterpriseConfig": { @@ -3325,7 +3336,8 @@ "type": "string" }, "expireTime": { - "description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "fleet": { @@ -3353,10 +3365,11 @@ }, "instanceGroupUrls": { "deprecated": true, - "description": "Deprecated. Use node_pools.instance_group_urls.", + "description": "Output only. Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "ipAllocationPolicy": { @@ -3372,7 +3385,8 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { - "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "readOnly": true, "type": "string" }, "locations": { @@ -3445,8 +3459,9 @@ "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { - "description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", + "description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", + "readOnly": true, "type": "integer" }, "nodePoolAutoConfig": { @@ -3524,11 +3539,13 @@ "description": "Enable/Disable Security Posture API features for the cluster." }, "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", + "description": "Output only. Server-defined URL for the resource.", + "readOnly": true, "type": "string" }, "servicesIpv4Cidr": { - "description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", + "description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", + "readOnly": true, "type": "string" }, "shieldedNodes": { @@ -3536,7 +3553,7 @@ "description": "Shielded Nodes configuration." }, "status": { - "description": "[Output only] The current status of this cluster.", + "description": "Output only. The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -3555,11 +3572,13 @@ "The ERROR state indicates the cluster may be unusable. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], + "readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, - "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", + "description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", + "readOnly": true, "type": "string" }, "subnetwork": { @@ -3571,7 +3590,8 @@ "description": "Configuration for Cloud TPU support;" }, "tpuIpv4CidrBlock": { - "description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", + "description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", + "readOnly": true, "type": "string" }, "verticalPodAutoscaling": { @@ -3592,7 +3612,8 @@ }, "zone": { "deprecated": true, - "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", + "readOnly": true, "type": "string" } }, @@ -4236,7 +4257,8 @@ "id": "DailyMaintenanceWindow", "properties": { "duration": { - "description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", + "description": "Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.", + "readOnly": true, "type": "string" }, "startTime": { @@ -4365,7 +4387,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { - "description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", + "description": "Output only. cluster_tier indicates the effective tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", @@ -4448,11 +4470,13 @@ "id": "Fleet", "properties": { "membership": { - "description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", + "description": "Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", + "readOnly": true, "type": "string" }, "preRegistered": { - "description": "[Output only] Whether the cluster has been registered through the fleet API.", + "description": "Output only. Whether the cluster has been registered through the fleet API.", + "readOnly": true, "type": "boolean" }, "project": { @@ -4779,7 +4803,7 @@ "properties": { "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", - "description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", + "description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, "allowRouteOverlap": { @@ -4804,7 +4828,7 @@ "type": "boolean" }, "defaultPodIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4846,7 +4870,7 @@ "type": "string" }, "servicesIpv6CidrBlock": { - "description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", + "description": "Output only. The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, @@ -4869,7 +4893,7 @@ "type": "string" }, "subnetIpv6CidrBlock": { - "description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", + "description": "Output only. The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, @@ -5337,7 +5361,8 @@ "id": "MasterAuth", "properties": { "clientCertificate": { - "description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", + "description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", + "readOnly": true, "type": "string" }, "clientCertificateConfig": { @@ -5345,10 +5370,13 @@ "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued." }, "clientKey": { - "description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", + "description": "Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.", + "readOnly": true, "type": "string" }, "clusterCaCertificate": { + "description": "Output only. Base64-encoded public certificate that is the root of trust for the cluster.", + "readOnly": true, "type": "string" }, "password": { @@ -5584,6 +5612,7 @@ }, "network": { "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", + "readOnly": true, "type": "string" }, "networkPerformanceConfig": { @@ -5612,6 +5641,7 @@ }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", + "readOnly": true, "type": "string" } }, @@ -5900,6 +5930,13 @@ "description": "Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.", "type": "boolean" }, + "storagePools": { + "description": "List of Storage Pools where boot disks are provisioned.", + "items": { + "type": "string" + }, + "type": "array" + }, "tags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.", "items": { @@ -6052,7 +6089,7 @@ "type": "string" }, "podIpv4RangeUtilization": { - "description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", + "description": "Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -6097,10 +6134,11 @@ "type": "integer" }, "instanceGroupUrls": { - "description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", + "description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, "locations": { @@ -6131,8 +6169,9 @@ "description": "Specifies the node placement policy." }, "podIpv4CidrSize": { - "description": "[Output only] The pod CIDR block size per node in this node pool.", + "description": "Output only. The pod CIDR block size per node in this node pool.", "format": "int32", + "readOnly": true, "type": "integer" }, "queuedProvisioning": { @@ -6140,11 +6179,12 @@ "description": "Specifies the configuration of queued provisioning." }, "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", + "description": "Output only. Server-defined URL for the resource.", + "readOnly": true, "type": "string" }, "status": { - "description": "[Output only] The status of the nodes in this pool instance.", + "description": "Output only. The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -6163,16 +6203,18 @@ "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], + "readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, - "description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", + "description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", + "readOnly": true, "type": "string" }, "updateInfo": { "$ref": "UpdateInfo", - "description": "Output only. [Output only] Update info contains relevant information during a node pool update.", + "description": "Output only. Update info contains relevant information during a node pool update.", "readOnly": true }, "upgradeSettings": { @@ -6345,11 +6387,13 @@ "type": "array" }, "detail": { - "description": "Detailed operation progress, if available.", + "description": "Output only. Detailed operation progress, if available.", + "readOnly": true, "type": "string" }, "endTime": { - "description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "error": { @@ -6357,11 +6401,13 @@ "description": "The error result of the operation in case of failure." }, "location": { - "description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", + "readOnly": true, "type": "string" }, "name": { - "description": "The server-assigned ID for the operation.", + "description": "Output only. The server-assigned ID for the operation.", + "readOnly": true, "type": "string" }, "nodepoolConditions": { @@ -6373,7 +6419,7 @@ "type": "array" }, "operationType": { - "description": "The operation type.", + "description": "Output only. The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", @@ -6437,23 +6483,26 @@ "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], + "readOnly": true, "type": "string" }, "progress": { "$ref": "OperationProgress", - "description": "Output only. [Output only] Progress information for an operation.", + "description": "Output only. Progress information for an operation.", "readOnly": true }, "selfLink": { - "description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", + "description": "Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", + "readOnly": true, "type": "string" }, "startTime": { - "description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "description": "Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "readOnly": true, "type": "string" }, "status": { - "description": "The current status of the operation.", + "description": "Output only. The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", @@ -6468,6 +6517,7 @@ "The operation is done, either cancelled or completed.", "The operation is aborting." ], + "readOnly": true, "type": "string" }, "statusMessage": { @@ -6477,12 +6527,14 @@ "type": "string" }, "targetLink": { - "description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", + "description": "Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", + "readOnly": true, "type": "string" }, "zone": { "deprecated": true, - "description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", + "description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", + "readOnly": true, "type": "string" } }, @@ -6673,10 +6725,12 @@ }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", + "readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", + "readOnly": true, "type": "string" }, "privateEndpointSubnetwork": { @@ -6685,6 +6739,7 @@ }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", + "readOnly": true, "type": "string" } }, @@ -6779,12 +6834,12 @@ "id": "RangeInfo", "properties": { "rangeName": { - "description": "Output only. [Output only] Name of a range.", + "description": "Output only. Name of a range.", "readOnly": true, "type": "string" }, "utilization": { - "description": "Output only. [Output only] The utilization of the range.", + "description": "Output only. The utilization of the range.", "format": "double", "readOnly": true, "type": "number" @@ -6792,6 +6847,47 @@ }, "type": "object" }, + "RayClusterLoggingConfig": { + "description": "RayClusterLoggingConfig specifies logging configuration for Ray clusters.", + "id": "RayClusterLoggingConfig", + "properties": { + "enabled": { + "description": "Enable log collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayClusterMonitoringConfig": { + "description": "RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.", + "id": "RayClusterMonitoringConfig", + "properties": { + "enabled": { + "description": "Enable metrics collection for Ray clusters.", + "type": "boolean" + } + }, + "type": "object" + }, + "RayOperatorConfig": { + "description": "Configuration options for the Ray Operator add-on.", + "id": "RayOperatorConfig", + "properties": { + "enabled": { + "description": "Whether the Ray addon is enabled for this cluster.", + "type": "boolean" + }, + "rayClusterLoggingConfig": { + "$ref": "RayClusterLoggingConfig", + "description": "Optional. Logging configuration for Ray clusters." + }, + "rayClusterMonitoringConfig": { + "$ref": "RayClusterMonitoringConfig", + "description": "Optional. Monitoring configuration for Ray clusters." + } + }, + "type": "object" + }, "RecurringTimeWindow": { "description": "Represents an arbitrary window of time that recurs.", "id": "RecurringTimeWindow", @@ -6817,13 +6913,15 @@ "UNSPECIFIED", "RAPID", "REGULAR", - "STABLE" + "STABLE", + "EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", - "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." + "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", + "Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" } @@ -6848,13 +6946,15 @@ "UNSPECIFIED", "RAPID", "REGULAR", - "STABLE" + "STABLE", + "EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", - "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." + "Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", + "Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" }, @@ -7067,7 +7167,7 @@ "id": "SecretManagerConfig", "properties": { "enabled": { - "description": "Whether the cluster is configured to use secret manager CSI component.", + "description": "Enable/Disable Secret Manager Config.", "type": "boolean" } }, @@ -8059,6 +8159,13 @@ "$ref": "ResourceManagerTags", "description": "Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values." }, + "storagePools": { + "description": "List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools.", + "items": { + "type": "string" + }, + "type": "array" + }, "tags": { "$ref": "NetworkTags", "description": "The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags." diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index 3fd786e2ff..44d5b5398a 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -118,6 +118,92 @@ "resources": { "notes": { "methods": { + "batchCreate": { + "description": "Creates new notes in batch.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notes:batchCreate", + "request": { + "$ref": "BatchCreateNotesRequest" + }, + "response": { + "$ref": "BatchCreateNotesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new note.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "noteId": { + "description": "Required. The ID to use for this note.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/notes", + "request": { + "$ref": "Note" + }, + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified note.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", + "httpMethod": "DELETE", + "id": "containeranalysis.projects.locations.notes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the specified note.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", @@ -183,6 +269,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the specified note.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", + "httpMethod": "PATCH", + "id": "containeranalysis.projects.locations.notes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Note" + }, + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -235,6 +355,87 @@ }, "occurrences": { "methods": { + "batchCreate": { + "description": "Creates new occurrences in batch.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/occurrences:batchCreate", + "request": { + "$ref": "BatchCreateOccurrencesRequest" + }, + "response": { + "$ref": "BatchCreateOccurrencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new occurrence.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/occurrences", + "request": { + "$ref": "Occurrence" + }, + "response": { + "$ref": "Occurrence" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", + "httpMethod": "DELETE", + "id": "containeranalysis.projects.locations.occurrences.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the specified occurrence.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", @@ -355,6 +556,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the specified occurrence.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", + "httpMethod": "PATCH", + "id": "containeranalysis.projects.locations.occurrences.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Occurrence" + }, + "response": { + "$ref": "Occurrence" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1072,7 +1307,7 @@ } } }, - "revision": "20240625", + "revision": "20240726", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2968,26 +3203,6 @@ }, "type": "object" }, - "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig", @@ -3004,12 +3219,8 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" - }, - "proxySslCaInfo": { - "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" @@ -3748,10 +3959,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." - }, - "vulnerabilityAttestation": { - "$ref": "VulnerabilityAttestation", - "description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -5905,36 +6112,6 @@ }, "type": "object" }, - "VulnerabilityAttestation": { - "description": "The status of an vulnerability attestation generation.", - "id": "VulnerabilityAttestation", - "properties": { - "error": { - "description": "If failure, the error reason for why the attestation generation failed.", - "type": "string" - }, - "lastAttemptTime": { - "description": "The last time we attempted to generate an attestation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The success/failure state of the latest attestation attempt.", - "enum": [ - "VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", - "SUCCESS", - "FAILURE" - ], - "enumDescriptions": [ - "Default unknown state.", - "Attestation was successfully generated and stored.", - "Attestation was unsuccessfully generated and stored." - ], - "type": "string" - } - }, - "type": "object" - }, "VulnerabilityNote": { "description": "A security vulnerability that can be found in resources.", "id": "VulnerabilityNote", diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 3de1414253..97ccd278e8 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -17,9 +17,9 @@ "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "endpoints": [ { - "location": "me-central2", + "description": "Regional Endpoint", "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/", - "description": "Regional Endpoint" + "location": "me-central2" } ], "fullyEncodeReservedExpansion": true, @@ -1240,7 +1240,7 @@ } } }, - "revision": "20240625", + "revision": "20240704", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -2942,26 +2942,6 @@ }, "type": "object" }, - "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig", @@ -2978,12 +2958,8 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" - }, - "proxySslCaInfo": { - "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index 630b59af54..b52db9d33b 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -17,9 +17,9 @@ "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "endpoints": [ { - "location": "me-central2", "description": "Regional Endpoint", - "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/" + "endpointUrl": "https://containeranalysis.me-central2.rep.googleapis.com/", + "location": "me-central2" } ], "fullyEncodeReservedExpansion": true, @@ -118,6 +118,92 @@ "resources": { "notes": { "methods": { + "batchCreate": { + "description": "Creates new notes in batch.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes:batchCreate", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/notes:batchCreate", + "request": { + "$ref": "BatchCreateNotesRequest" + }, + "response": { + "$ref": "BatchCreateNotesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new note.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.notes.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "noteId": { + "description": "Required. The ID to use for this note.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/notes", + "request": { + "$ref": "Note" + }, + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified note.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", + "httpMethod": "DELETE", + "id": "containeranalysis.projects.locations.notes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the specified note.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", @@ -183,6 +269,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the specified note.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/notes/{notesId}", + "httpMethod": "PATCH", + "id": "containeranalysis.projects.locations.notes.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/notes/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "Note" + }, + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -235,6 +355,87 @@ }, "occurrences": { "methods": { + "batchCreate": { + "description": "Creates new occurrences in batch.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences:batchCreate", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/occurrences:batchCreate", + "request": { + "$ref": "BatchCreateOccurrencesRequest" + }, + "response": { + "$ref": "BatchCreateOccurrencesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a new occurrence.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences", + "httpMethod": "POST", + "id": "containeranalysis.projects.locations.occurrences.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/occurrences", + "request": { + "$ref": "Occurrence" + }, + "response": { + "$ref": "Occurrence" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", + "httpMethod": "DELETE", + "id": "containeranalysis.projects.locations.occurrences.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets the specified occurrence.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", @@ -355,6 +556,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates the specified occurrence.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/occurrences/{occurrencesId}", + "httpMethod": "PATCH", + "id": "containeranalysis.projects.locations.occurrences.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/occurrences/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "Occurrence" + }, + "response": { + "$ref": "Occurrence" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -1128,7 +1363,7 @@ } } }, - "revision": "20240625", + "revision": "20240726", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2924,26 +3159,6 @@ }, "type": "object" }, - "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfig", @@ -2960,12 +3175,8 @@ "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" - }, - "proxySslCaInfo": { - "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index c0ec1726d5..ee4aeafc30 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -6219,7 +6219,7 @@ } } }, - "revision": "20240614", + "revision": "20240723", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -10806,6 +10806,10 @@ "format": "int64", "type": "string" }, + "memberPriceEffectiveDate": { + "description": "Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.", + "type": "string" + }, "price": { "$ref": "Price", "description": "Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price." @@ -14496,7 +14500,7 @@ "type": "array" }, "source": { - "description": "The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", + "description": "Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", "type": "string" }, "structuredDescription": { diff --git a/discovery/contentwarehouse-v1.json b/discovery/contentwarehouse-v1.json index afd79c875c..d3bfb746d8 100644 --- a/discovery/contentwarehouse-v1.json +++ b/discovery/contentwarehouse-v1.json @@ -1156,7 +1156,7 @@ } } }, - "revision": "20240506", + "revision": "20240723", "rootUrl": "https://contentwarehouse.googleapis.com/", "schemas": { "CloudAiPlatformTenantresourceCloudSqlInstanceConfig": { @@ -3994,11 +3994,19 @@ "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.", "id": "GoogleCloudDocumentaiV1Document", "properties": { + "chunkedDocument": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocument", + "description": "Document chunked based on chunking config." + }, "content": { "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", "format": "byte", "type": "string" }, + "documentLayout": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayout", + "description": "Parsed layout of the document." + }, "entities": { "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", "items": { @@ -4065,6 +4073,282 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1DocumentChunkedDocument": { + "description": "Represents the chunks that the document is divided into.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocument", + "properties": { + "chunks": { + "description": "List of chunks.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk": { + "description": "Represents a chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk", + "properties": { + "chunkId": { + "description": "ID of the chunk.", + "type": "string" + }, + "content": { + "description": "Text content of the chunk.", + "type": "string" + }, + "pageFooters": { + "description": "Page footers associated with the chunk.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter" + }, + "type": "array" + }, + "pageHeaders": { + "description": "Page headers associated with the chunk.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader" + }, + "type": "array" + }, + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "description": "Page span of the chunk." + }, + "sourceBlockIds": { + "description": "Unused.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter": { + "description": "Represents the page footer associated with the chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter", + "properties": { + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "description": "Page span of the footer." + }, + "text": { + "description": "Footer in text format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader": { + "description": "Represents the page header associated with the chunk.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader", + "properties": { + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "description": "Page span of the header." + }, + "text": { + "description": "Header in text format.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan": { + "description": "Represents where the chunk starts and ends in the document.", + "id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", + "properties": { + "pageEnd": { + "description": "Page where chunk ends in the document.", + "format": "int32", + "type": "integer" + }, + "pageStart": { + "description": "Page where chunk starts in the document.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayout": { + "description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayout", + "properties": { + "blocks": { + "description": "List of blocks in the document.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock": { + "description": "Represents a block. A block could be one of the various types (text, table, list) supported.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock", + "properties": { + "blockId": { + "description": "ID of the block.", + "type": "string" + }, + "listBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", + "description": "Block consisting of list content/structure." + }, + "pageSpan": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", + "description": "Page span of the block." + }, + "tableBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", + "description": "Block consisting of table content/structure." + }, + "textBlock": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", + "description": "Block consisting of text content." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { + "description": "Represents a list type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", + "properties": { + "listEntries": { + "description": "List entries that constitute a list block.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" + }, + "type": "array" + }, + "type": { + "description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { + "description": "Represents an entry in the list.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", + "properties": { + "blocks": { + "description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { + "description": "Represents where the block starts and ends in the document.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", + "properties": { + "pageEnd": { + "description": "Page where block ends in the document.", + "format": "int32", + "type": "integer" + }, + "pageStart": { + "description": "Page where block starts in the document.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { + "description": "Represents a table type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", + "properties": { + "bodyRows": { + "description": "Body rows containing main table content.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" + }, + "type": "array" + }, + "caption": { + "description": "Table caption/title.", + "type": "string" + }, + "headerRows": { + "description": "Header rows at the top of the table.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { + "description": "Represents a cell in a table row.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", + "properties": { + "blocks": { + "description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + }, + "type": "array" + }, + "colSpan": { + "description": "How many columns this cell spans.", + "format": "int32", + "type": "integer" + }, + "rowSpan": { + "description": "How many rows this cell spans.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { + "description": "Represents a row in a table.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", + "properties": { + "cells": { + "description": "A table row is a list of table cells.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { + "description": "Represents a text type block.", + "id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", + "properties": { + "blocks": { + "description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", + "items": { + "$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" + }, + "type": "array" + }, + "text": { + "description": "Text content stored in the block.", + "type": "string" + }, + "type": { + "description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1DocumentEntity": { "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1DocumentEntity", diff --git a/discovery/css-v1.json b/discovery/css-v1.json new file mode 100644 index 0000000000..20fdf7e4d9 --- /dev/null +++ b/discovery/css-v1.json @@ -0,0 +1,1216 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/content": { + "description": "Manage your product listings and accounts for Google Shopping" + } + } + } + }, + "basePath": "", + "baseUrl": "https://css.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Css", + "description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview", + "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": "css:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://css.mtls.googleapis.com/", + "name": "css", + "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": { + "accounts": { + "methods": { + "get": { + "description": "Retrieves a single CSS/MC account by ID.", + "flatPath": "v1/accounts/{accountsId}", + "httpMethod": "GET", + "id": "css.accounts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the managed CSS/MC account. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + }, + "parent": { + "description": "Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "listChildAccounts": { + "description": "Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.", + "flatPath": "v1/accounts/{accountsId}:listChildAccounts", + "httpMethod": "GET", + "id": "css.accounts.listChildAccounts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "fullName": { + "description": "If set, only the MC accounts with the given name (case sensitive) will be returned.", + "location": "query", + "type": "string" + }, + "labelId": { + "description": "If set, only the MC accounts with the given label ID will be returned.", + "format": "int64", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account. Must be a CSS group or domain. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:listChildAccounts", + "response": { + "$ref": "ListChildAccountsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateLabels": { + "description": "Updates labels assigned to CSS/MC accounts by a CSS domain.", + "flatPath": "v1/accounts/{accountsId}:updateLabels", + "httpMethod": "POST", + "id": "css.accounts.updateLabels", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The label resource name. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:updateLabels", + "request": { + "$ref": "UpdateAccountLabelsRequest" + }, + "response": { + "$ref": "Account" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + }, + "resources": { + "cssProductInputs": { + "methods": { + "delete": { + "description": "Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.", + "flatPath": "v1/accounts/{accountsId}/cssProductInputs/{cssProductInputsId}", + "httpMethod": "DELETE", + "id": "css.accounts.cssProductInputs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}", + "location": "path", + "pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", + "required": true, + "type": "string" + }, + "supplementalFeedId": { + "description": "The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "insert": { + "description": "Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.", + "flatPath": "v1/accounts/{accountsId}/cssProductInputs:insert", + "httpMethod": "POST", + "id": "css.accounts.cssProductInputs.insert", + "parameterOrder": [ + "parent" + ], + "parameters": { + "feedId": { + "description": "Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account where this CSS Product will be inserted. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cssProductInputs:insert", + "request": { + "$ref": "CssProductInput" + }, + "response": { + "$ref": "CssProductInput" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "cssProducts": { + "methods": { + "get": { + "description": "Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.", + "flatPath": "v1/accounts/{accountsId}/cssProducts/{cssProductsId}", + "httpMethod": "GET", + "id": "css.accounts.cssProducts.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the CSS product to retrieve.", + "location": "path", + "pattern": "^accounts/[^/]+/cssProducts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CssProduct" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.", + "flatPath": "v1/accounts/{accountsId}/cssProducts", + "httpMethod": "GET", + "id": "css.accounts.cssProducts.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The account/domain to list processed CSS Products for. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/cssProducts", + "response": { + "$ref": "ListCssProductsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "labels": { + "methods": { + "create": { + "description": "Creates a new label, not assigned to any account.", + "flatPath": "v1/accounts/{accountsId}/labels", + "httpMethod": "POST", + "id": "css.accounts.labels.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent account. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/labels", + "request": { + "$ref": "AccountLabel" + }, + "response": { + "$ref": "AccountLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "delete": { + "description": "Deletes a label and removes it from all accounts to which it was assigned.", + "flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", + "httpMethod": "DELETE", + "id": "css.accounts.labels.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the label to delete. Format: accounts/{account}/labels/{label}", + "location": "path", + "pattern": "^accounts/[^/]+/labels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "list": { + "description": "Lists the labels assigned to an account.", + "flatPath": "v1/accounts/{accountsId}/labels", + "httpMethod": "GET", + "id": "css.accounts.labels.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent account. Format: accounts/{account}", + "location": "path", + "pattern": "^accounts/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/labels", + "response": { + "$ref": "ListAccountLabelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "patch": { + "description": "Updates a label.", + "flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", + "httpMethod": "PATCH", + "id": "css.accounts.labels.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the label. Format: accounts/{account}/labels/{label}", + "location": "path", + "pattern": "^accounts/[^/]+/labels/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "AccountLabel" + }, + "response": { + "$ref": "AccountLabel" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + } + } + } + }, + "revision": "20240719", + "rootUrl": "https://css.googleapis.com/", + "schemas": { + "Account": { + "description": "Information about CSS/MC account.", + "id": "Account", + "properties": { + "accountType": { + "description": "Output only. The type of this account.", + "enum": [ + "ACCOUNT_TYPE_UNSPECIFIED", + "CSS_GROUP", + "CSS_DOMAIN", + "MC_PRIMARY_CSS_MCA", + "MC_CSS_MCA", + "MC_MARKETPLACE_MCA", + "MC_OTHER_MCA", + "MC_STANDALONE", + "MC_MCA_SUBACCOUNT" + ], + "enumDescriptions": [ + "Unknown account type.", + "CSS group account.", + "CSS domain account.", + "MC Primary CSS MCA account.", + "MC CSS MCA account.", + "MC Marketplace MCA account.", + "MC Other MCA account.", + "MC Standalone account.", + "MC MCA sub-account." + ], + "readOnly": true, + "type": "string" + }, + "automaticLabelIds": { + "description": "Automatically created label IDs assigned to the MC account by CSS Center.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The CSS/MC account's short display name.", + "type": "string" + }, + "fullName": { + "description": "Output only. Immutable. The CSS/MC account's full name.", + "readOnly": true, + "type": "string" + }, + "homepageUri": { + "description": "Output only. Immutable. The CSS/MC account's homepage.", + "readOnly": true, + "type": "string" + }, + "labelIds": { + "description": "Manually created label IDs assigned to the CSS/MC account by a CSS parent account.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The label resource name. Format: accounts/{account}", + "type": "string" + }, + "parent": { + "description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.", + "type": "string" + } + }, + "type": "object" + }, + "AccountLabel": { + "description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.", + "id": "AccountLabel", + "properties": { + "accountId": { + "description": "Output only. The ID of account this label belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of this label.", + "type": "string" + }, + "displayName": { + "description": "The display name of this label.", + "type": "string" + }, + "labelId": { + "description": "Output only. The ID of the label.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "labelType": { + "description": "Output only. The type of this label.", + "enum": [ + "LABEL_TYPE_UNSPECIFIED", + "MANUAL", + "AUTOMATIC" + ], + "enumDescriptions": [ + "Unknown label type.", + "Indicates that the label was created manually.", + "Indicates that the label was created automatically by CSS Center." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The resource name of the label. Format: accounts/{account}/labels/{label}", + "type": "string" + } + }, + "type": "object" + }, + "Attributes": { + "description": "Attributes for CSS Product.", + "id": "Attributes", + "properties": { + "additionalImageLinks": { + "description": "Additional URL of images of the item.", + "items": { + "type": "string" + }, + "type": "array" + }, + "adult": { + "description": "Set to true if the item is targeted towards adults.", + "type": "boolean" + }, + "ageGroup": { + "description": "Target age group of the item.", + "type": "string" + }, + "brand": { + "description": "Product Related Attributes.[14-36] Brand of the item.", + "type": "string" + }, + "certifications": { + "description": "A list of certificates claimed by the CSS for the given product.", + "items": { + "$ref": "Certification" + }, + "type": "array" + }, + "color": { + "description": "Color of the item.", + "type": "string" + }, + "cppAdsRedirect": { + "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.", + "type": "string" + }, + "cppLink": { + "description": "URL directly linking to your the Product Detail Page of the CSS.", + "type": "string" + }, + "cppMobileLink": { + "description": "URL for the mobile-optimized version of the Product Detail Page of the CSS.", + "type": "string" + }, + "customLabel0": { + "description": "Custom label 0 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel1": { + "description": "Custom label 1 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel2": { + "description": "Custom label 2 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel3": { + "description": "Custom label 3 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "customLabel4": { + "description": "Custom label 4 for custom grouping of items in a Shopping campaign.", + "type": "string" + }, + "description": { + "description": "Description of the item.", + "type": "string" + }, + "excludedDestinations": { + "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).", + "items": { + "type": "string" + }, + "type": "array" + }, + "expirationDate": { + "description": "Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.", + "format": "google-datetime", + "type": "string" + }, + "gender": { + "description": "Target gender of the item.", + "type": "string" + }, + "googleProductCategory": { + "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.", + "type": "string" + }, + "gtin": { + "description": "Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.", + "type": "string" + }, + "headlineOfferCondition": { + "description": "Condition of the headline offer.", + "type": "string" + }, + "headlineOfferLink": { + "description": "Link to the headline offer.", + "type": "string" + }, + "headlineOfferMobileLink": { + "description": "Mobile Link to the headline offer.", + "type": "string" + }, + "headlineOfferPrice": { + "$ref": "Price", + "description": "Headline Price of the aggregate offer." + }, + "headlineOfferShippingPrice": { + "$ref": "Price", + "description": "Headline Price of the aggregate offer." + }, + "highPrice": { + "$ref": "Price", + "description": "High Price of the aggregate offer." + }, + "imageLink": { + "description": "URL of an image of the item.", + "type": "string" + }, + "includedDestinations": { + "description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "isBundle": { + "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.", + "type": "boolean" + }, + "itemGroupId": { + "description": "Shared identifier for all variants of the same product.", + "type": "string" + }, + "lowPrice": { + "$ref": "Price", + "description": "Low Price of the aggregate offer." + }, + "material": { + "description": "The material of which the item is made.", + "type": "string" + }, + "mpn": { + "description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", + "type": "string" + }, + "multipack": { + "description": "The number of identical products in a merchant-defined multipack.", + "format": "int64", + "type": "string" + }, + "numberOfOffers": { + "description": "The number of aggregate offers.", + "format": "int64", + "type": "string" + }, + "pattern": { + "description": "The item's pattern (e.g. polka dots).", + "type": "string" + }, + "pause": { + "description": "Publication of this item will be temporarily paused.", + "type": "string" + }, + "productDetails": { + "description": "Technical specification or additional product details.", + "items": { + "$ref": "ProductDetail" + }, + "type": "array" + }, + "productHeight": { + "$ref": "ProductDimension", + "description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." + }, + "productHighlights": { + "description": "Bullet points describing the most relevant highlights of a product.", + "items": { + "type": "string" + }, + "type": "array" + }, + "productLength": { + "$ref": "ProductDimension", + "description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." + }, + "productTypes": { + "description": "Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "productWeight": { + "$ref": "ProductWeight", + "description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)." + }, + "productWidth": { + "$ref": "ProductDimension", + "description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." + }, + "size": { + "description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).", + "type": "string" + }, + "sizeSystem": { + "description": "System in which the size is specified. Recommended for apparel items.", + "type": "string" + }, + "sizeTypes": { + "description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).", + "items": { + "type": "string" + }, + "type": "array" + }, + "title": { + "description": "Title of the item.", + "type": "string" + } + }, + "type": "object" + }, + "Certification": { + "description": "The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product.", + "id": "Certification", + "properties": { + "authority": { + "description": "The authority or certification body responsible for issuing the certification. At this time, the most common value is \"EC\" or “European_Commission” for energy labels in the EU.", + "type": "string" + }, + "code": { + "description": "The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels.", + "type": "string" + }, + "name": { + "description": "The name of the certification. At this time, the most common value is \"EPREL\", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.", + "type": "string" + } + }, + "type": "object" + }, + "CssProduct": { + "description": "The processed CSS Product(a.k.a Aggregate Offer internally).", + "id": "CssProduct", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "Output only. A list of product attributes.", + "readOnly": true + }, + "contentLanguage": { + "description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", + "readOnly": true, + "type": "string" + }, + "cssProductStatus": { + "$ref": "CssProductStatus", + "description": "Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.", + "readOnly": true + }, + "customAttributes": { + "description": "Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", + "items": { + "$ref": "CustomAttribute" + }, + "readOnly": true, + "type": "array" + }, + "feedLabel": { + "description": "Output only. The feed label for the product.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the CSS Product. Format: `\"accounts/{account}/cssProducts/{css_product}\"`", + "type": "string" + }, + "rawProvidedId": { + "description": "Output only. Your unique raw identifier for the product.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CssProductInput": { + "description": "This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.", + "id": "CssProductInput", + "properties": { + "attributes": { + "$ref": "Attributes", + "description": "A list of CSS Product attributes." + }, + "contentLanguage": { + "description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.", + "type": "string" + }, + "customAttributes": { + "description": "A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", + "items": { + "$ref": "CustomAttribute" + }, + "type": "array" + }, + "feedLabel": { + "description": "Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to \"target country\" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.", + "type": "string" + }, + "finalName": { + "description": "Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` \"", + "readOnly": true, + "type": "string" + }, + "freshnessTime": { + "description": "Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", + "type": "string" + }, + "rawProvidedId": { + "description": "Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.", + "type": "string" + } + }, + "type": "object" + }, + "CssProductStatus": { + "description": "The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously.", + "id": "CssProductStatus", + "properties": { + "creationDate": { + "description": "Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "google-datetime", + "type": "string" + }, + "destinationStatuses": { + "description": "The intended destinations for the product.", + "items": { + "$ref": "DestinationStatus" + }, + "type": "array" + }, + "googleExpirationDate": { + "description": "Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "google-datetime", + "type": "string" + }, + "itemLevelIssues": { + "description": "A list of all issues associated with the product.", + "items": { + "$ref": "ItemLevelIssue" + }, + "type": "array" + }, + "lastUpdateDate": { + "description": "Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "CustomAttribute": { + "description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", + "id": "CustomAttribute", + "properties": { + "groupValues": { + "description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", + "items": { + "$ref": "CustomAttribute" + }, + "type": "array" + }, + "name": { + "description": "The name of the attribute.", + "type": "string" + }, + "value": { + "description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", + "type": "string" + } + }, + "type": "object" + }, + "DestinationStatus": { + "description": "The destination status of the product status.", + "id": "DestinationStatus", + "properties": { + "approvedCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.", + "items": { + "type": "string" + }, + "type": "array" + }, + "destination": { + "description": "The name of the destination", + "type": "string" + }, + "disapprovedCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "ItemLevelIssue": { + "description": "The ItemLevelIssue of the product status.", + "id": "ItemLevelIssue", + "properties": { + "applicableCountries": { + "description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.", + "items": { + "type": "string" + }, + "type": "array" + }, + "attribute": { + "description": "The attribute's name, if the issue is caused by a single attribute.", + "type": "string" + }, + "code": { + "description": "The error code of the issue.", + "type": "string" + }, + "description": { + "description": "A short issue description in English.", + "type": "string" + }, + "destination": { + "description": "The destination the issue applies to.", + "type": "string" + }, + "detail": { + "description": "A detailed issue description in English.", + "type": "string" + }, + "documentation": { + "description": "The URL of a web page to help with resolving this issue.", + "type": "string" + }, + "resolution": { + "description": "Whether the issue can be resolved by the merchant.", + "type": "string" + }, + "servability": { + "description": "How this issue affects serving of the aggregate offer.", + "type": "string" + } + }, + "type": "object" + }, + "ListAccountLabelsResponse": { + "description": "Response message for the `ListAccountLabels` method.", + "id": "ListAccountLabelsResponse", + "properties": { + "accountLabels": { + "description": "The labels from the specified account.", + "items": { + "$ref": "AccountLabel" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListChildAccountsResponse": { + "description": "Response message for the `ListChildAccounts` method.", + "id": "ListChildAccountsResponse", + "properties": { + "accounts": { + "description": "The CSS/MC accounts returned for the specified CSS parent account.", + "items": { + "$ref": "Account" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "ListCssProductsResponse": { + "description": "Response message for the ListCssProducts method.", + "id": "ListCssProductsResponse", + "properties": { + "cssProducts": { + "description": "The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.", + "items": { + "$ref": "CssProduct" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "Price": { + "description": "The price represented as a number and currency.", + "id": "Price", + "properties": { + "amountMicros": { + "description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", + "format": "int64", + "type": "string" + }, + "currencyCode": { + "description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).", + "type": "string" + } + }, + "type": "object" + }, + "ProductDetail": { + "description": "The product details.", + "id": "ProductDetail", + "properties": { + "attributeName": { + "description": "The name of the product detail.", + "type": "string" + }, + "attributeValue": { + "description": "The value of the product detail.", + "type": "string" + }, + "sectionName": { + "description": "The section header used to group a set of product details.", + "type": "string" + } + }, + "type": "object" + }, + "ProductDimension": { + "description": "The dimension of the product.", + "id": "ProductDimension", + "properties": { + "unit": { + "description": "Required. The dimension units. Acceptable values are: * \"`in`\" * \"`cm`\"", + "type": "string" + }, + "value": { + "description": "Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "ProductWeight": { + "description": "The weight of the product.", + "id": "ProductWeight", + "properties": { + "unit": { + "description": "Required. The weight unit. Acceptable values are: * \"`g`\" * \"`kg`\" * \"`oz`\" * \"`lb`\"", + "type": "string" + }, + "value": { + "description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "UpdateAccountLabelsRequest": { + "description": "The request message for the `UpdateLabels` method.", + "id": "UpdateAccountLabelsRequest", + "properties": { + "labelIds": { + "description": "The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "parent": { + "description": "Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "CSS API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 9083259d4c..eb9ab895c1 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -7,9 +7,6 @@ }, "https://www.googleapis.com/auth/compute": { "description": "View and manage your Google Compute Engine resources" - }, - "https://www.googleapis.com/auth/compute.readonly": { - "description": "View your Google Compute Engine resources" } } } @@ -23,29 +20,79 @@ "documentationLink": "https://cloud.google.com/dataflow", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://dataflow.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-east5.rep.googleapis.com/", + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://dataflow.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dataflow.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -172,8 +219,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "workerMessages": { @@ -201,8 +247,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } }, @@ -287,8 +332,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "create": { @@ -343,8 +387,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "get": { @@ -398,8 +441,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "getMetrics": { @@ -442,8 +484,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "list": { @@ -524,8 +565,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "snapshot": { @@ -560,8 +600,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "update": { @@ -607,8 +646,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } }, @@ -647,8 +685,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "sendCapture": { @@ -683,8 +720,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -769,8 +805,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -809,8 +844,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "reportStatus": { @@ -845,8 +879,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -887,8 +920,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } }, @@ -927,8 +959,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -989,8 +1020,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "get": { @@ -1046,8 +1076,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "getExecutionDetails": { @@ -1097,8 +1126,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "getMetrics": { @@ -1143,8 +1171,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "list": { @@ -1227,8 +1254,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "snapshot": { @@ -1270,8 +1296,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "update": { @@ -1319,8 +1344,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } }, @@ -1366,8 +1390,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "sendCapture": { @@ -1409,8 +1432,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -1497,8 +1519,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -1541,8 +1562,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -1615,8 +1635,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -1662,8 +1681,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "reportStatus": { @@ -1705,8 +1723,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -1751,8 +1768,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "get": { @@ -1791,8 +1807,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "list": { @@ -1829,8 +1844,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -1869,8 +1883,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "get": { @@ -1918,8 +1931,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "launch": { @@ -1974,8 +1986,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -2018,8 +2029,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "list": { @@ -2054,8 +2064,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -2087,8 +2096,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "get": { @@ -2134,8 +2142,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] }, "launch": { @@ -2188,8 +2195,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" + "https://www.googleapis.com/auth/compute" ] } } @@ -2197,7 +2203,7 @@ } } }, - "revision": "20240624", + "revision": "20240709", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json index af46b374ad..c6fc8070c4 100644 --- a/discovery/dataform-v1beta1.json +++ b/discovery/dataform-v1beta1.json @@ -2236,7 +2236,7 @@ } } }, - "revision": "20240615", + "revision": "20240629", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { @@ -2543,6 +2543,12 @@ "readOnly": true, "type": "array" }, + "createTime": { + "description": "Output only. The timestamp of when the compilation result was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "dataEncryptionState": { "$ref": "DataEncryptionState", "description": "Output only. Only set if the repository has a KMS Key.", @@ -3983,6 +3989,12 @@ "description": "Represents a Dataform workflow configuration.", "id": "WorkflowConfig", "properties": { + "createTime": { + "description": "Output only. The timestamp of when the WorkflowConfig was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "cronSchedule": { "description": "Optional. Optional schedule (in cron format) for automatic execution of this workflow config.", "type": "string" @@ -4010,6 +4022,12 @@ "timeZone": { "description": "Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.", "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp of when the WorkflowConfig was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/discovery/datafusion-v1.json b/discovery/datafusion-v1.json index 9be84e33ae..60f9cef658 100644 --- a/discovery/datafusion-v1.json +++ b/discovery/datafusion-v1.json @@ -732,7 +732,7 @@ } } }, - "revision": "20240618", + "revision": "20240703", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -777,6 +777,38 @@ }, "type": "object" }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -847,12 +879,49 @@ }, "type": "object" }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "CryptoKeyConfig": { "description": "The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.", "id": "CryptoKeyConfig", @@ -864,6 +933,18 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "DnsPeering": { "description": "DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS.", "id": "DnsPeering", @@ -935,6 +1016,17 @@ }, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "Instance": { "description": "Represents a Data Fusion instance.", "id": "Instance", @@ -1162,6 +1254,127 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListAvailableVersionsResponse": { "description": "Response message for the list available versions request.", "id": "ListAvailableVersionsResponse", @@ -1293,6 +1506,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "MaintenancePolicy": { "description": "Maintenance policy of the instance.", "id": "MaintenancePolicy", @@ -1431,6 +1702,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -1497,6 +1779,25 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, "RestartInstanceRequest": { "description": "Request message for restarting a Data Fusion instance.", "id": "RestartInstanceRequest", @@ -1519,6 +1820,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1546,6 +1867,18 @@ }, "type": "object" }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -1626,6 +1959,15 @@ } }, "type": "object" + }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/datafusion-v1beta1.json b/discovery/datafusion-v1beta1.json index 4c535042e2..81790755b1 100644 --- a/discovery/datafusion-v1beta1.json +++ b/discovery/datafusion-v1beta1.json @@ -930,7 +930,7 @@ } } }, - "revision": "20240618", + "revision": "20240703", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -975,6 +975,38 @@ }, "type": "object" }, + "AssetLocation": { + "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", + "id": "AssetLocation", + "properties": { + "expected": { + "$ref": "IsolationExpectations", + "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." + }, + "extraParameters": { + "description": "Defines extra parameters required for specific asset types.", + "items": { + "$ref": "ExtraParameter" + }, + "type": "array" + }, + "locationData": { + "description": "Contains all kinds of physical location definitions for this asset.", + "items": { + "$ref": "LocationData" + }, + "type": "array" + }, + "parentAsset": { + "description": "Defines parents assets if any in order to allow later generation of child_asset_location data via child assets.", + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -1045,12 +1077,49 @@ }, "type": "object" }, + "BlobstoreLocation": { + "description": "Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains", + "id": "BlobstoreLocation", + "properties": { + "policyId": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, + "CloudAsset": { + "id": "CloudAsset", + "properties": { + "assetName": { + "type": "string" + }, + "assetType": { + "type": "string" + } + }, + "type": "object" + }, + "CloudAssetComposition": { + "id": "CloudAssetComposition", + "properties": { + "childAsset": { + "items": { + "$ref": "CloudAsset" + }, + "type": "array" + } + }, + "type": "object" + }, "CryptoKeyConfig": { "description": "The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature.", "id": "CryptoKeyConfig", @@ -1062,6 +1131,18 @@ }, "type": "object" }, + "DirectLocationAssignment": { + "id": "DirectLocationAssignment", + "properties": { + "location": { + "items": { + "$ref": "LocationAssignment" + }, + "type": "array" + } + }, + "type": "object" + }, "DnsPeering": { "description": "DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS.", "id": "DnsPeering", @@ -1133,6 +1214,17 @@ }, "type": "object" }, + "ExtraParameter": { + "description": "Defines parameters that should only be used for specific asset types.", + "id": "ExtraParameter", + "properties": { + "regionalMigDistributionPolicy": { + "$ref": "RegionalMigDistributionPolicy", + "description": "Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances." + } + }, + "type": "object" + }, "IAMPolicy": { "description": "IAMPolicy encapsulates the IAM policy name, definition and status of policy fetching.", "id": "IAMPolicy", @@ -1375,6 +1467,127 @@ }, "type": "object" }, + "IsolationExpectations": { + "id": "IsolationExpectations", + "properties": { + "ziOrgPolicy": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionPolicy": { + "enum": [ + "ZI_REGION_POLICY_UNSPECIFIED", + "ZI_REGION_POLICY_UNKNOWN", + "ZI_REGION_POLICY_NOT_SET", + "ZI_REGION_POLICY_FAIL_OPEN", + "ZI_REGION_POLICY_FAIL_CLOSED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "ziRegionState": { + "enum": [ + "ZI_REGION_UNSPECIFIED", + "ZI_REGION_UNKNOWN", + "ZI_REGION_NOT_ENABLED", + "ZI_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zoneIsolation": { + "deprecated": true, + "description": "Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zoneSeparation": { + "deprecated": true, + "description": "Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location.", + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsOrgPolicy": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + }, + "zsRegionState": { + "enum": [ + "ZS_REGION_UNSPECIFIED", + "ZS_REGION_UNKNOWN", + "ZS_REGION_NOT_ENABLED", + "ZS_REGION_ENABLED" + ], + "enumDescriptions": [ + "", + "To be used if tracking of the asset ZS-bit is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "ListAvailableVersionsResponse": { "description": "Response message for the list available versions request.", "id": "ListAvailableVersionsResponse", @@ -1524,6 +1737,64 @@ }, "type": "object" }, + "LocationAssignment": { + "id": "LocationAssignment", + "properties": { + "location": { + "type": "string" + }, + "locationType": { + "enum": [ + "UNSPECIFIED", + "CLUSTER", + "POP", + "CLOUD_ZONE", + "CLOUD_REGION", + "MULTI_REGION_GEO", + "MULTI_REGION_JURISDICTION", + "GLOBAL", + "OTHER" + ], + "enumDescriptions": [ + "", + "1-10: Physical failure domains.", + "", + "11-20: Logical failure domains.", + "", + "", + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationData": { + "id": "LocationData", + "properties": { + "blobstoreLocation": { + "$ref": "BlobstoreLocation" + }, + "childAssetLocation": { + "$ref": "CloudAssetComposition" + }, + "directLocation": { + "$ref": "DirectLocationAssignment" + }, + "gcpProjectProxy": { + "$ref": "TenantProjectProxy" + }, + "placerLocation": { + "$ref": "PlacerLocation" + }, + "spannerLocation": { + "$ref": "SpannerLocation" + } + }, + "type": "object" + }, "MaintenancePolicy": { "description": "Maintenance policy of the instance.", "id": "MaintenancePolicy", @@ -1677,6 +1948,17 @@ }, "type": "object" }, + "PlacerLocation": { + "description": "Message describing that the location of the customer resource is tied to placer allocations", + "id": "PlacerLocation", + "properties": { + "placerConfig": { + "description": "Directory with a config related to it in placer (e.g. \"/placer/prod/home/my-root/my-dir\")", + "type": "string" + } + }, + "type": "object" + }, "Policy": { "description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).", "id": "Policy", @@ -1743,6 +2025,25 @@ }, "type": "object" }, + "RegionalMigDistributionPolicy": { + "description": "To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances", + "id": "RegionalMigDistributionPolicy", + "properties": { + "targetShape": { + "description": "The shape in which the group converges around distribution of resources. Instance of proto2 enum", + "format": "int32", + "type": "integer" + }, + "zones": { + "description": "Cloud zones used by regional MIG to create instances.", + "items": { + "$ref": "ZoneConfiguration" + }, + "type": "array" + } + }, + "type": "object" + }, "RemoveIamPolicyRequest": { "description": "Request message for RemoveIamPolicy method.", "id": "RemoveIamPolicyRequest", @@ -1777,6 +2078,26 @@ }, "type": "object" }, + "SpannerLocation": { + "id": "SpannerLocation", + "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, + "dbName": { + "description": "Set of databases used by the resource in format /span//", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", @@ -1804,6 +2125,18 @@ }, "type": "object" }, + "TenantProjectProxy": { + "id": "TenantProjectProxy", + "properties": { + "projectNumbers": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TestIamPermissionsRequest": { "description": "Request message for `TestIamPermissions` method.", "id": "TestIamPermissionsRequest", @@ -1890,6 +2223,15 @@ } }, "type": "object" + }, + "ZoneConfiguration": { + "id": "ZoneConfiguration", + "properties": { + "zone": { + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/datamigration-v1.json b/discovery/datamigration-v1.json index 5acd035000..c98558d1ef 100644 --- a/discovery/datamigration-v1.json +++ b/discovery/datamigration-v1.json @@ -1760,6 +1760,99 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "objects": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:getIamPolicy", + "httpMethod": "GET", + "id": "datamigration.projects.locations.migrationJobs.objects.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:setIamPolicy", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.objects.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/migrationJobs/{migrationJobsId}/objects/{objectsId}:testIamPermissions", + "httpMethod": "POST", + "id": "datamigration.projects.locations.migrationJobs.objects.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/migrationJobs/[^/]+/objects/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } }, "operations": { @@ -2125,7 +2218,7 @@ } } }, - "revision": "20240615", + "revision": "20240812", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2531,6 +2624,8 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", + "MYSQL_8_0_37", + "MYSQL_8_4", "POSTGRES_9_6", "POSTGRES_11", "POSTGRES_10", @@ -2556,6 +2651,8 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", + "The database major version is MySQL 8.0 and the minor version is 37.", + "MySQL 8.4.", "PostgreSQL 9.6.", "PostgreSQL 11.", "PostgreSQL 10.", @@ -4479,8 +4576,7 @@ "PROMOTE_IN_PROGRESS", "WAITING_FOR_SOURCE_WRITES_TO_STOP", "PREPARING_THE_DUMP", - "READY_FOR_PROMOTE", - "DIFF_BACKUP" + "READY_FOR_PROMOTE" ], "enumDescriptions": [ "The phase of the migration job is unknown.", @@ -4489,8 +4585,7 @@ "The migration job is running the promote phase.", "Only RDS flow - waiting for source writes to stop", "Only RDS flow - the sources writes stopped, waiting for dump to begin", - "The migration job is ready to be promoted.", - "The migration job is in the differential backup phase." + "The migration job is ready to be promoted." ], "readOnly": true, "type": "string" @@ -4820,6 +4915,43 @@ }, "type": "object" }, + "OracleAsmConfig": { + "description": "Configuration for Oracle Automatic Storage Management (ASM) connection.", + "id": "OracleAsmConfig", + "properties": { + "asmService": { + "description": "Required. ASM service name for the Oracle ASM connection.", + "type": "string" + }, + "hostname": { + "description": "Required. Hostname for the Oracle ASM connection.", + "type": "string" + }, + "password": { + "description": "Required. Input only. Password for the Oracle ASM connection.", + "type": "string" + }, + "passwordSet": { + "description": "Output only. Indicates whether a new password is included in the request.", + "readOnly": true, + "type": "boolean" + }, + "port": { + "description": "Required. Port for the Oracle ASM connection.", + "format": "int32", + "type": "integer" + }, + "ssl": { + "$ref": "SslConfig", + "description": "Optional. SSL configuration for the Oracle connection." + }, + "username": { + "description": "Required. Username for the Oracle ASM connection.", + "type": "string" + } + }, + "type": "object" + }, "OracleConnectionProfile": { "description": "Specifies connection parameters required specifically for Oracle databases.", "id": "OracleConnectionProfile", @@ -4836,6 +4968,10 @@ "description": "Required. The IP or hostname of the source Oracle database.", "type": "string" }, + "oracleAsmConfig": { + "$ref": "OracleAsmConfig", + "description": "Optional. Configuration for Oracle ASM connection." + }, "password": { "description": "Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.", "type": "string" @@ -5734,6 +5870,10 @@ }, "type": "array" }, + "promoteWhenReady": { + "description": "Optional. Promote databases when ready.", + "type": "boolean" + }, "useDiffBackup": { "description": "Optional. Enable differential backups.", "type": "boolean" diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index f2aa3d7356..b8036f5bae 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -105,6 +105,105 @@ }, "protocol": "rest", "resources": { + "organizations": { + "resources": { + "locations": { + "resources": { + "encryptionConfigs": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataplex.organizations.locations.encryptionConfigs.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataplex.organizations.locations.encryptionConfigs.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.organizations.locations.encryptionConfigs.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "projects": { "resources": { "locations": { @@ -176,7 +275,7 @@ ] }, "lookupEntry": { - "description": "Looks up a single entry.", + "description": "Looks up a single Entry by name using the permission on the source system.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:lookupEntry", "httpMethod": "GET", "id": "dataplex.projects.locations.lookupEntry", @@ -185,7 +284,7 @@ ], "parameters": { "aspectTypes": { - "description": "Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" @@ -203,13 +302,13 @@ "type": "string" }, "paths": { - "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" }, "view": { - "description": "Optional. View for controlling which parts of an entry are to be returned.", + "description": "Optional. View to control which parts of an entry the service should return.", "enum": [ "ENTRY_VIEW_UNSPECIFIED", "BASIC", @@ -221,8 +320,8 @@ "Unspecified EntryView. Defaults to FULL.", "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", - "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.", - "Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned." + "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", + "Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." ], "location": "query", "type": "string" @@ -237,7 +336,7 @@ ] }, "searchEntries": { - "description": "Searches for entries matching given query and scope.", + "description": "Searches for Entries matching the given query and scope.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}:searchEntries", "httpMethod": "POST", "id": "dataplex.projects.locations.searchEntries", @@ -253,17 +352,18 @@ "type": "string" }, "orderBy": { - "description": "Optional. Ordering of the results. Supported options to be added later.", + "description": "Optional. Specifies the ordering of results.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Pagination.", + "description": "Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size > 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { + "description": "Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -273,7 +373,7 @@ "type": "string" }, "scope": { - "description": "Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located.", + "description": "Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located.", "location": "query", "type": "string" } @@ -291,7 +391,7 @@ "aspectTypes": { "methods": { "create": { - "description": "Creates an AspectType", + "description": "Creates an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes", "httpMethod": "POST", "id": "dataplex.projects.locations.aspectTypes.create", @@ -305,14 +405,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the AspectType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -329,7 +429,7 @@ ] }, "delete": { - "description": "Deletes a AspectType resource.", + "description": "Deletes an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.aspectTypes.delete", @@ -338,7 +438,7 @@ ], "parameters": { "etag": { - "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response", + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response.", "location": "query", "type": "string" }, @@ -359,7 +459,7 @@ ] }, "get": { - "description": "Retrieves a AspectType resource.", + "description": "Gets an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.aspectTypes.get", @@ -424,28 +524,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 name = \"value\" These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"These restrictions can be conjoined with AND, OR, and NOT conjunctions.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", + "description": "Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -461,7 +561,7 @@ ] }, "patch": { - "description": "Updates a AspectType resource.", + "description": "Updates an AspectType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/aspectTypes/{aspectTypesId}", "httpMethod": "PATCH", "id": "dataplex.projects.locations.aspectTypes.patch", @@ -1819,7 +1919,7 @@ "entryGroups": { "methods": { "create": { - "description": "Creates an EntryGroup", + "description": "Creates an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups", "httpMethod": "POST", "id": "dataplex.projects.locations.entryGroups.create", @@ -1840,7 +1940,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -1857,7 +1957,7 @@ ] }, "delete": { - "description": "Deletes a EntryGroup resource.", + "description": "Deletes an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.entryGroups.delete", @@ -1866,7 +1966,7 @@ ], "parameters": { "etag": { - "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response", + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response.", "location": "query", "type": "string" }, @@ -1887,7 +1987,7 @@ ] }, "get": { - "description": "Retrieves a EntryGroup resource.", + "description": "Gets an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.get", @@ -1962,18 +2062,18 @@ "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListEntryGroups must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the entryGroup location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1989,7 +2089,7 @@ ] }, "patch": { - "description": "Updates a EntryGroup resource.", + "description": "Updates an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}", "httpMethod": "PATCH", "id": "dataplex.projects.locations.entryGroups.patch", @@ -1998,7 +2098,7 @@ ], "parameters": { "name": { - "description": "Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", + "description": "Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "required": true, @@ -2011,7 +2111,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request, without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -2097,7 +2197,7 @@ ], "parameters": { "entryId": { - "description": "Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.The maximum size of the field is 4000 characters.", + "description": "Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters.", "location": "query", "type": "string" }, @@ -2146,7 +2246,7 @@ ] }, "get": { - "description": "Gets a single entry.", + "description": "Gets an Entry.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries/{entriesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.get", @@ -2155,7 +2255,7 @@ ], "parameters": { "aspectTypes": { - "description": "Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" @@ -2168,13 +2268,13 @@ "type": "string" }, "paths": { - "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected.", + "description": "Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view.", "location": "query", "repeated": true, "type": "string" }, "view": { - "description": "Optional. View for controlling which parts of an entry are to be returned.", + "description": "Optional. View to control which parts of an entry the service should return.", "enum": [ "ENTRY_VIEW_UNSPECIFIED", "BASIC", @@ -2186,8 +2286,8 @@ "Unspecified EntryView. Defaults to FULL.", "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", - "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects would exceed 100, the first 100 will be returned.", - "Returns all aspects. If the number of aspects would exceed 100, the first 100 will be returned." + "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", + "Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." ], "location": "query", "type": "string" @@ -2202,7 +2302,7 @@ ] }, "list": { - "description": "Lists entries within an entry group.", + "description": "Lists Entries within an EntryGroup.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryGroups/{entryGroupsId}/entries", "httpMethod": "GET", "id": "dataplex.projects.locations.entryGroups.entries.list", @@ -2211,17 +2311,18 @@ ], "parameters": { "filter": { - "description": "Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, >, <=, >= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard \"*\" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: \"entry_source.display_name=AnExampleDisplayName\" \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\" \"entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*\" \"NOT entry_source.display_name=AnotherExampleDisplayName\"", + "description": "Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_nameThe comparison operators are =, !=, <, >, <=, >=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard \"*\", but for entry_type you need to provide the full project id or number.Example filter expressions: \"entry_source.display_name=AnExampleDisplayName\" \"entry_type=projects/example-project/locations/global/entryTypes/example-entry_type\" \"entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/*\" \"NOT entry_source.display_name=AnotherExampleDisplayName\"", "location": "query", "type": "string" }, "pageSize": { + "description": "Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. The pagination token returned by a previous request.", + "description": "Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, @@ -2251,30 +2352,30 @@ ], "parameters": { "allowMissing": { - "description": "Optional. If set to true and the entry does not exist, it will be created.", + "description": "Optional. If set to true and the entry doesn't exist, the service will create it.", "location": "query", "type": "boolean" }, "aspectKeys": { - "description": "Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request.", + "description": "Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request.", "location": "query", "repeated": true, "type": "string" }, "deleteMissingAspects": { - "description": "Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted.", + "description": "Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request.", "location": "query", "type": "boolean" }, "name": { - "description": "Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "description": "Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value \"aspects\".If the update_mask is empty, all modifiable fields present in the request will be updated.", + "description": "Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value \"aspects\".If the update_mask is empty, the service will update all modifiable fields present in the request.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2298,7 +2399,7 @@ "entryTypes": { "methods": { "create": { - "description": "Creates an EntryType", + "description": "Creates an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes", "httpMethod": "POST", "id": "dataplex.projects.locations.entryTypes.create", @@ -2312,14 +2413,14 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the EntryType, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -2336,7 +2437,7 @@ ] }, "delete": { - "description": "Deletes a EntryType resource.", + "description": "Deletes an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", "httpMethod": "DELETE", "id": "dataplex.projects.locations.entryTypes.delete", @@ -2345,7 +2446,7 @@ ], "parameters": { "etag": { - "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response", + "description": "Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response.", "location": "query", "type": "string" }, @@ -2366,7 +2467,7 @@ ] }, "get": { - "description": "Retrieves a EntryType resource.", + "description": "Gets an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", "httpMethod": "GET", "id": "dataplex.projects.locations.entryTypes.get", @@ -2431,28 +2532,28 @@ ], "parameters": { "filter": { - "description": "Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = \"value1\" labels:key1 name = \"value\" These restrictions can be coinjoined with AND, OR and NOT conjunctions.", + "description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"These restrictions can be conjoined with AND, OR, and NOT conjunctions.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined.", + "description": "Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.", "location": "query", "type": "string" }, "pageSize": { - "description": "Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", + "description": "Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token.", + "description": "Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to ListEntryTypes must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a GCP region.", + "description": "Required. The resource name of the EntryType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -2468,7 +2569,7 @@ ] }, "patch": { - "description": "Updates a EntryType resource.", + "description": "Updates an EntryType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/entryTypes/{entryTypesId}", "httpMethod": "PATCH", "id": "dataplex.projects.locations.entryTypes.patch", @@ -2490,7 +2591,7 @@ "type": "string" }, "validateOnly": { - "description": "Optional. Only validate the request, but do not perform mutations. The default is false.", + "description": "Optional. The service validates the request without performing any mutations. The default is false.", "location": "query", "type": "boolean" } @@ -2564,6 +2665,97 @@ } } }, + "glossaries": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:getIamPolicy", + "httpMethod": "GET", + "id": "dataplex.projects.locations.glossaries.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:setIamPolicy", + "httpMethod": "POST", + "id": "dataplex.projects.locations.glossaries.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/glossaries/{glossariesId}:testIamPermissions", + "httpMethod": "POST", + "id": "dataplex.projects.locations.glossaries.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "governanceRules": { "methods": { "getIamPolicy": { @@ -5143,6 +5335,142 @@ } } }, + "metadataJobs": { + "methods": { + "cancel": { + "description": "Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel", + "httpMethod": "POST", + "id": "dataplex.projects.locations.metadataJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "GoogleCloudDataplexV1CancelMetadataJobRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs", + "httpMethod": "POST", + "id": "dataplex.projects.locations.metadataJobs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "metadataJobId": { + "description": "Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataJobs", + "request": { + "$ref": "GoogleCloudDataplexV1MetadataJob" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a metadata job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}", + "httpMethod": "GET", + "id": "dataplex.projects.locations.metadataJobs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/metadataJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudDataplexV1MetadataJob" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists metadata jobs.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs", + "httpMethod": "GET", + "id": "dataplex.projects.locations.metadataJobs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"You can combine filters with AND, OR, and NOT operators.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/metadataJobs", + "response": { + "$ref": "GoogleCloudDataplexV1ListMetadataJobsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -5271,7 +5599,7 @@ } } }, - "revision": "20240611", + "revision": "20240802", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -5494,7 +5822,8 @@ "id": "GoogleCloudDataplexV1Aspect", "properties": { "aspectSource": { - "$ref": "GoogleCloudDataplexV1AspectSource" + "$ref": "GoogleCloudDataplexV1AspectSource", + "description": "Optional. Information related to the source system of the aspect." }, "aspectType": { "description": "Output only. The resource name of the type used to create this Aspect.", @@ -5512,7 +5841,7 @@ "description": "Properties of the object.", "type": "any" }, - "description": "Required. The content of the aspect, according to its aspect type schema. This will replace content. The maximum size of the field is 120KB (encoded as UTF-8).", + "description": "Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8).", "type": "object" }, "path": { @@ -5530,16 +5859,16 @@ "type": "object" }, "GoogleCloudDataplexV1AspectSource": { - "description": "AspectSource contains source system related information for the aspect.", + "description": "Information related to the source system of the aspect.", "id": "GoogleCloudDataplexV1AspectSource", "properties": { "createTime": { - "description": "The create time of the aspect in the source system.", + "description": "The time the aspect was created in the source system.", "format": "google-datetime", "type": "string" }, "updateTime": { - "description": "The update time of the aspect in the source system.", + "description": "The time the aspect was last updated in the source system.", "format": "google-datetime", "type": "string" } @@ -5547,12 +5876,12 @@ "type": "object" }, "GoogleCloudDataplexV1AspectType": { - "description": "Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema.", + "description": "AspectType is a template for creating Aspects, and represents the JSON-schema for a given Entry, for example, BigQuery Table Schema.", "id": "GoogleCloudDataplexV1AspectType", "properties": { "authorization": { "$ref": "GoogleCloudDataplexV1AspectTypeAuthorization", - "description": "Immutable. Authorization defined for this type." + "description": "Immutable. Defines the Authorization for this type." }, "createTime": { "description": "Output only. The time when the AspectType was created.", @@ -5569,7 +5898,7 @@ "type": "string" }, "etag": { - "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -5588,23 +5917,8 @@ "readOnly": true, "type": "string" }, - "transferStatus": { - "description": "Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API.", - "enum": [ - "TRANSFER_STATUS_UNSPECIFIED", - "TRANSFER_STATUS_MIGRATED", - "TRANSFER_STATUS_TRANSFERRED" - ], - "enumDescriptions": [ - "The default value. It is set for resources that were not subject for migration from Data Catalog service.", - "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", - "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." - ], - "readOnly": true, - "type": "string" - }, "uid": { - "description": "Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name.", + "description": "Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different.", "readOnly": true, "type": "string" }, @@ -5618,18 +5932,18 @@ "type": "object" }, "GoogleCloudDataplexV1AspectTypeAuthorization": { - "description": "Autorization for an Aspect Type.", + "description": "Autorization for an AspectType.", "id": "GoogleCloudDataplexV1AspectTypeAuthorization", "properties": { "alternateUsePermission": { - "description": "Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex owned Types.", + "description": "Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex owned AspectTypes, only settable for Dataplex owned Types.", "type": "string" } }, "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplate": { - "description": "MetadataTemplate definition for AspectType", + "description": "MetadataTemplate definition for an AspectType.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", "properties": { "annotations": { @@ -5638,14 +5952,14 @@ }, "arrayItems": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", - "description": "Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload." + "description": "Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload." }, "constraints": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints", "description": "Optional. Specifies the constraints on this field." }, "enumValues": { - "description": "Optional. The list of values for an enum type. Needs to be defined if the type is enum.", + "description": "Optional. The list of values for an enum type. You must define it if the type is enum.", "items": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue" }, @@ -5658,61 +5972,61 @@ }, "mapItems": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate", - "description": "Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload." + "description": "Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload." }, "name": { "description": "Required. The name of the field.", "type": "string" }, "recordFields": { - "description": "Optional. Field definition, needs to be specified if the type is record. Defines the nested fields.", + "description": "Optional. Field definition. You must specify it if the type is record. It defines the nested fields.", "items": { "$ref": "GoogleCloudDataplexV1AspectTypeMetadataTemplate" }, "type": "array" }, "type": { - "description": "Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC \"Zulu\" (Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\"). Complex types (enum, array, map, record).", + "description": "Required. The datatype of this field. The following values are supported:Primitive types: string integer boolean double datetime. Must be of the format RFC3339 UTC \"Zulu\" (Examples: \"2014-10-02T15:01:23Z\" and \"2014-10-02T15:01:23.045123456Z\").Complex types: enum array map record", "type": "string" }, "typeId": { - "description": "Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record.", + "description": "Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record.", "type": "string" }, "typeRef": { - "description": "Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields.", + "description": "Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields.", "type": "string" } }, "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations": { - "description": "Definition of the annotations of a field", + "description": "Definition of the annotations of a field.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations", "properties": { "deprecated": { - "description": "Optional. Marks a field as deprecated, a deprecation message can be included.", + "description": "Optional. Marks a field as deprecated. You can include a deprecation message.", "type": "string" }, "description": { - "description": "Optional. Specify a description for a field", + "description": "Optional. Description for a field.", "type": "string" }, "displayName": { - "description": "Optional. Specify a displayname for a field.", + "description": "Optional. Display name for a field.", "type": "string" }, "displayOrder": { - "description": "Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered", + "description": "Optional. Display order for a field. You can use this to reorder where a field is rendered.", "format": "int32", "type": "integer" }, "stringType": { - "description": "Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference.", + "description": "Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference.", "type": "string" }, "stringValues": { - "description": "Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example.", + "description": "Optional. Suggested hints for string fields. You can use them to suggest values to users through console.", "items": { "type": "string" }, @@ -5722,31 +6036,31 @@ "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints": { - "description": "Definition of the constraints of a field", + "description": "Definition of the constraints of a field.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints", "properties": { "required": { - "description": "Optional. Marks this as an optional/required field.", + "description": "Optional. Marks this field as optional or required.", "type": "boolean" } }, "type": "object" }, "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue": { - "description": "Definition of Enumvalue (to be used by enum fields)", + "description": "Definition of Enumvalue, to be used for enum fields.", "id": "GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue", "properties": { "deprecated": { - "description": "Optional. Optional deprecation message to be set if an enum value needs to be deprecated.", + "description": "Optional. You can set this message if you need to deprecate an enum value.", "type": "string" }, "index": { - "description": "Required. Index for the enum. Cannot be modified.", + "description": "Required. Index for the enum value. It can't be modified.", "format": "int32", "type": "integer" }, "name": { - "description": "Required. Name of the enumvalue. This is the actual value that the aspect will contain.", + "description": "Required. Name of the enumvalue. This is the actual value that the aspect can contain.", "type": "string" } }, @@ -6123,6 +6437,12 @@ "properties": {}, "type": "object" }, + "GoogleCloudDataplexV1CancelMetadataJobRequest": { + "description": "Cancel metadata job request.", + "id": "GoogleCloudDataplexV1CancelMetadataJobRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudDataplexV1Content": { "description": "Content represents a user-visible notebook or a sql script", "id": "GoogleCloudDataplexV1Content", @@ -6489,7 +6809,7 @@ "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo", "properties": { "distinctRatio": { - "description": "Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.", + "description": "Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.", "format": "double", "type": "number" }, @@ -6511,7 +6831,7 @@ "description": "String type field information." }, "topNValues": { - "description": "The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.", + "description": "The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.", "items": { "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue" }, @@ -6894,6 +7214,10 @@ "$ref": "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation", "description": "Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range." }, + "suspended": { + "description": "Optional. Whether the Rule is active or suspended. Default is false.", + "type": "boolean" + }, "tableConditionExpectation": { "$ref": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation", "description": "Aggregate rule which evaluates whether the provided expression is true for a table." @@ -7709,6 +8033,12 @@ "description": "A DataScanJob represents an instance of DataScan execution.", "id": "GoogleCloudDataplexV1DataScanJob", "properties": { + "createTime": { + "description": "Output only. The time when the DataScanJob was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "dataProfileResult": { "$ref": "GoogleCloudDataplexV1DataProfileResult", "description": "Output only. The result of the data profile scan.", @@ -8168,36 +8498,36 @@ "type": "object" }, "GoogleCloudDataplexV1Entry": { - "description": "An entry is a representation of a data asset which can be described by various metadata.", + "description": "An entry is a representation of a data resource that can be described by various metadata.", "id": "GoogleCloudDataplexV1Entry", "properties": { "aspects": { "additionalProperties": { "$ref": "GoogleCloudDataplexV1Aspect" }, - "description": "Optional. The Aspects attached to the Entry. The format for the key can be one of the following: 1. {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) 2. {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)", + "description": "Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}", "type": "object" }, "createTime": { - "description": "Output only. The time when the Entry was created.", + "description": "Output only. The time when the entry was created in Dataplex.", "format": "google-datetime", "readOnly": true, "type": "string" }, "entrySource": { "$ref": "GoogleCloudDataplexV1EntrySource", - "description": "Optional. Source system related information for an entry." + "description": "Optional. Information related to the source system of the data resource that is represented by the entry." }, "entryType": { - "description": "Required. Immutable. The resource name of the EntryType used to create this Entry.", + "description": "Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.", "type": "string" }, "fullyQualifiedName": { - "description": "Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters.", + "description": "Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters.", "type": "string" }, "name": { - "description": "Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", + "description": "Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.", "type": "string" }, "parentEntry": { @@ -8205,7 +8535,7 @@ "type": "string" }, "updateTime": { - "description": "Output only. The time when the Entry was last updated.", + "description": "Output only. The time when the entry was last updated in Dataplex.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8232,7 +8562,7 @@ "type": "string" }, "etag": { - "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -8243,27 +8573,12 @@ "type": "object" }, "name": { - "description": "Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", - "readOnly": true, - "type": "string" - }, - "transferStatus": { - "description": "Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API.", - "enum": [ - "TRANSFER_STATUS_UNSPECIFIED", - "TRANSFER_STATUS_MIGRATED", - "TRANSFER_STATUS_TRANSFERRED" - ], - "enumDescriptions": [ - "The default value. It is set for resources that were not subject for migration from Data Catalog service.", - "Indicates that a resource was migrated from Data Catalog service but it hasn't been transferred yet. In particular the resource cannot be updated from Dataplex API.", - "Indicates that a resource was transferred from Data Catalog service. The resource can only be updated from Dataplex API." - ], + "description": "Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.", "readOnly": true, "type": "string" }, "uid": { - "description": "Output only. System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name.", + "description": "Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.", "readOnly": true, "type": "string" }, @@ -8277,27 +8592,27 @@ "type": "object" }, "GoogleCloudDataplexV1EntrySource": { - "description": "EntrySource contains source system related information for the entry.", + "description": "Information related to the source system of the data resource that is represented by the entry.", "id": "GoogleCloudDataplexV1EntrySource", "properties": { "ancestors": { - "description": "Immutable. The ancestors of the Entry in the source system.", + "description": "Immutable. The entries representing the ancestors of the data resource in the source system.", "items": { "$ref": "GoogleCloudDataplexV1EntrySourceAncestor" }, "type": "array" }, "createTime": { - "description": "The create time of the resource in the source system.", + "description": "The time when the resource was created in the source system.", "format": "google-datetime", "type": "string" }, "description": { - "description": "Description of the Entry. The maximum size of the field is 2000 characters.", + "description": "A description of the data resource. Maximum length is 2,000 characters.", "type": "string" }, "displayName": { - "description": "User friendly display name. The maximum size of the field is 500 characters.", + "description": "A user-friendly display name. Maximum length is 500 characters.", "type": "string" }, "labels": { @@ -8308,24 +8623,24 @@ "type": "object" }, "location": { - "description": "Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP.", + "description": "Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.", "readOnly": true, "type": "string" }, "platform": { - "description": "The platform containing the source system. The maximum size of the field is 64 characters.", + "description": "The platform containing the source system. Maximum length is 64 characters.", "type": "string" }, "resource": { - "description": "The name of the resource in the source system. The maximum size of the field is 4000 characters.", + "description": "The name of the resource in the source system. Maximum length is 4,000 characters.", "type": "string" }, "system": { - "description": "The name of the source system. The maximum size of the field is 64 characters.", + "description": "The name of the source system. Maximum length is 64 characters.", "type": "string" }, "updateTime": { - "description": "The update time of the resource in the source system.", + "description": "The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.", "format": "google-datetime", "type": "string" } @@ -8333,7 +8648,7 @@ "type": "object" }, "GoogleCloudDataplexV1EntrySourceAncestor": { - "description": "Ancestor contains information about individual items in the hierarchy of an Entry.", + "description": "Information about individual items in the hierarchy that is associated with the data resource.", "id": "GoogleCloudDataplexV1EntrySourceAncestor", "properties": { "name": { @@ -8370,7 +8685,7 @@ "type": "string" }, "etag": { - "description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", + "description": "Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { @@ -8401,7 +8716,7 @@ "type": "string" }, "typeAliases": { - "description": "Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.", + "description": "Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL.", "items": { "type": "string" }, @@ -8739,6 +9054,29 @@ }, "type": "object" }, + "GoogleCloudDataplexV1ImportItem": { + "description": "An object that describes the values that you want to set for an entry and its attached aspects when you import metadata. Used when you run a metadata import job. See CreateMetadataJob.You provide a collection of import items in a metadata import file. For more information about how to create a metadata import file, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).", + "id": "GoogleCloudDataplexV1ImportItem", + "properties": { + "aspectKeys": { + "description": "The aspects to modify. Supports the following syntaxes: {aspect_type_reference}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference}@{path}: matches aspects that belong to the specified aspect type and path. {aspect_type_reference}@*: matches aspects that belong to the specified aspect type for all paths.Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entry": { + "$ref": "GoogleCloudDataplexV1Entry", + "description": "Information about an entry and its attached aspects." + }, + "updateMask": { + "description": "The fields to update, in paths that are relative to the Entry resource. Separate each field with a comma.In FULL entry sync mode, Dataplex includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex replaces the existing entry with the entry in the metadata import file. All modifiable fields are updated, regardless of the fields that are listed in the update mask, and regardless of whether a field is present in the entry object.The update_mask field is ignored when an entry is created or re-created.Dataplex also determines which entries and aspects to modify by comparing the values and timestamps that you provide in the metadata import file with the values and timestamps that exist in your project. For more information, see Comparison logic (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Job": { "description": "A job represents an instance of a task.", "id": "GoogleCloudDataplexV1Job", @@ -9090,11 +9428,11 @@ "type": "object" }, "GoogleCloudDataplexV1ListAspectTypesResponse": { - "description": "List AspectTypes response", + "description": "List AspectTypes response.", "id": "GoogleCloudDataplexV1ListAspectTypesResponse", "properties": { "aspectTypes": { - "description": "ListAspectTypes under the given parent location.", + "description": "AspectTypes under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1AspectType" }, @@ -9105,7 +9443,7 @@ "type": "string" }, "unreachableLocations": { - "description": "Locations that could not be reached.", + "description": "Locations that the service couldn't reach.", "items": { "type": "string" }, @@ -9287,28 +9625,29 @@ "type": "object" }, "GoogleCloudDataplexV1ListEntriesResponse": { + "description": "List Entries response.", "id": "GoogleCloudDataplexV1ListEntriesResponse", "properties": { "entries": { - "description": "The list of entries.", + "description": "The list of entries under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1Entry" }, "type": "array" }, "nextPageToken": { - "description": "Pagination token.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "type": "object" }, "GoogleCloudDataplexV1ListEntryGroupsResponse": { - "description": "List ListEntryGroups response.", + "description": "List entry groups response.", "id": "GoogleCloudDataplexV1ListEntryGroupsResponse", "properties": { "entryGroups": { - "description": "ListEntryGroups under the given parent location.", + "description": "Entry groups under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1EntryGroup" }, @@ -9319,7 +9658,7 @@ "type": "string" }, "unreachableLocations": { - "description": "Locations that could not be reached.", + "description": "Locations that the service couldn't reach.", "items": { "type": "string" }, @@ -9329,11 +9668,11 @@ "type": "object" }, "GoogleCloudDataplexV1ListEntryTypesResponse": { - "description": "List EntryTypes response", + "description": "List EntryTypes response.", "id": "GoogleCloudDataplexV1ListEntryTypesResponse", "properties": { "entryTypes": { - "description": "ListEntryTypes under the given parent location.", + "description": "EntryTypes under the given parent location.", "items": { "$ref": "GoogleCloudDataplexV1EntryType" }, @@ -9344,7 +9683,7 @@ "type": "string" }, "unreachableLocations": { - "description": "Locations that could not be reached.", + "description": "Locations that the service couldn't reach.", "items": { "type": "string" }, @@ -9414,6 +9753,31 @@ }, "type": "object" }, + "GoogleCloudDataplexV1ListMetadataJobsResponse": { + "description": "List metadata jobs response.", + "id": "GoogleCloudDataplexV1ListMetadataJobsResponse", + "properties": { + "metadataJobs": { + "description": "Metadata jobs under the specified parent location.", + "items": { + "$ref": "GoogleCloudDataplexV1MetadataJob" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. If there are no more results in the list, the value is empty.", + "type": "string" + }, + "unreachableLocations": { + "description": "Locations that the service couldn't reach.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1ListPartitionsResponse": { "description": "List metadata partitions response.", "id": "GoogleCloudDataplexV1ListPartitionsResponse", @@ -9493,6 +9857,250 @@ }, "type": "object" }, + "GoogleCloudDataplexV1MetadataJob": { + "description": "A metadata job resource.", + "id": "GoogleCloudDataplexV1MetadataJob", + "properties": { + "createTime": { + "description": "Output only. The time when the metadata job was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "importResult": { + "$ref": "GoogleCloudDataplexV1MetadataJobImportJobResult", + "description": "Output only. Import job result.", + "readOnly": true + }, + "importSpec": { + "$ref": "GoogleCloudDataplexV1MetadataJobImportJobSpec", + "description": "Import job specification." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. User-defined labels.", + "type": "object" + }, + "name": { + "description": "Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.", + "readOnly": true, + "type": "string" + }, + "status": { + "$ref": "GoogleCloudDataplexV1MetadataJobStatus", + "description": "Output only. Metadata job status.", + "readOnly": true + }, + "type": { + "description": "Required. Metadata job type.", + "enum": [ + "TYPE_UNSPECIFIED", + "IMPORT" + ], + "enumDescriptions": [ + "Unspecified.", + "Import job." + ], + "type": "string" + }, + "uid": { + "description": "Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the metadata job was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1MetadataJobImportJobResult": { + "description": "Results from a metadata import job.", + "id": "GoogleCloudDataplexV1MetadataJobImportJobResult", + "properties": { + "createdEntries": { + "description": "Output only. The total number of entries that were created.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "deletedEntries": { + "description": "Output only. The total number of entries that were deleted.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "recreatedEntries": { + "description": "Output only. The total number of entries that were recreated.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "unchangedEntries": { + "description": "Output only. The total number of entries that were unchanged.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the status was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "updatedEntries": { + "description": "Output only. The total number of entries that were updated.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1MetadataJobImportJobSpec": { + "description": "Job specification for a metadata import job", + "id": "GoogleCloudDataplexV1MetadataJobImportJobSpec", + "properties": { + "aspectSyncMode": { + "description": "Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.", + "enum": [ + "SYNC_MODE_UNSPECIFIED", + "FULL", + "INCREMENTAL" + ], + "enumDescriptions": [ + "Sync mode unspecified.", + "All resources in the job's scope are modified. If a resource exists in Dataplex but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.", + "Only the entries and aspects that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged." + ], + "type": "string" + }, + "entrySyncMode": { + "description": "Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.", + "enum": [ + "SYNC_MODE_UNSPECIFIED", + "FULL", + "INCREMENTAL" + ], + "enumDescriptions": [ + "Sync mode unspecified.", + "All resources in the job's scope are modified. If a resource exists in Dataplex but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.", + "Only the entries and aspects that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged." + ], + "type": "string" + }, + "logLevel": { + "description": "Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.", + "enum": [ + "LOG_LEVEL_UNSPECIFIED", + "DEBUG", + "INFO" + ], + "enumDescriptions": [ + "Log level unspecified.", + "Debug-level logging. Captures detailed logs for each import item. Use debug-level logging to troubleshoot issues with specific import items. For example, use debug-level logging to identify resources that are missing from the job scope, entries or aspects that don't conform to the associated entry type or aspect type, or other misconfigurations with the metadata import file.Depending on the size of your metadata job and the number of logs that are generated, debug-level logging might incur additional costs (https://cloud.google.com/stackdriver/pricing).", + "Info-level logging. Captures logs at the overall job level. Includes aggregate logs about import items, but doesn't specify which import item has an error." + ], + "type": "string" + }, + "scope": { + "$ref": "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope", + "description": "Required. A boundary on the scope of impact that the metadata import job can have." + }, + "sourceCreateTime": { + "description": "Optional. The time when the process that created the metadata import files began.", + "format": "google-datetime", + "type": "string" + }, + "sourceStorageUri": { + "description": "Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope": { + "description": "A boundary on the scope of impact that the metadata import job can have.", + "id": "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope", + "properties": { + "aspectTypes": { + "description": "Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entryGroups": { + "description": "Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.", + "items": { + "type": "string" + }, + "type": "array" + }, + "entryTypes": { + "description": "Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1MetadataJobStatus": { + "description": "Metadata job status.", + "id": "GoogleCloudDataplexV1MetadataJobStatus", + "properties": { + "completionPercent": { + "description": "Output only. Progress tracking.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "message": { + "description": "Output only. Message relating to the progression of a metadata job.", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the metadata job.", + "enum": [ + "STATE_UNSPECIFIED", + "QUEUED", + "RUNNING", + "CANCELING", + "CANCELED", + "SUCCEEDED", + "FAILED", + "SUCCEEDED_WITH_ERRORS" + ], + "enumDescriptions": [ + "State unspecified.", + "The job is queued.", + "The job is running.", + "The job is being canceled.", + "The job is canceled.", + "The job succeeded.", + "The job failed.", + "The job completed with some errors." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the status was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1OperationMetadata": { "description": "Represents the metadata of a long-running operation.", "id": "GoogleCloudDataplexV1OperationMetadata", @@ -9840,7 +10448,7 @@ "id": "GoogleCloudDataplexV1SearchEntriesResponse", "properties": { "nextPageToken": { - "description": "Pagination token.", + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, "results": { @@ -9851,12 +10459,12 @@ "type": "array" }, "totalSize": { - "description": "The estimated total number of matching entries. Not guaranteed to be accurate.", + "description": "The estimated total number of matching entries. This number isn't guaranteed to be accurate.", "format": "int32", "type": "integer" }, "unreachable": { - "description": "Unreachable locations. Search results don't include data from those locations.", + "description": "Locations that the service couldn't reach. Search results don't include data from these locations.", "items": { "type": "string" }, diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index 5693e27bd4..fe85670e83 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -17,19 +17,19 @@ "documentationLink": "https://cloud.google.com/dataproc/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://dataproc.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://dataproc.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" } ], "fullyEncodeReservedExpansion": true, diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 2f4cc9d6c0..d3341e1255 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -4343,6 +4343,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2/projects/{projectsId}/locations", @@ -7717,6 +7743,39 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:initialize", + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "generators": { "methods": { "create": { @@ -8655,7 +8714,7 @@ } } }, - "revision": "20240614", + "revision": "20240724", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8715,12 +8774,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -9034,7 +9097,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -9112,7 +9175,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -9167,6 +9230,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -10383,7 +10450,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -10442,7 +10509,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -10472,11 +10539,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -11105,12 +11172,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -11424,7 +11495,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -11502,7 +11573,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -11557,6 +11628,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -12765,7 +12840,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -12824,7 +12899,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -12854,11 +12929,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -15013,6 +15088,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -16217,6 +16307,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputAudioConfig": { "description": "Instructs the speech recognizer how to process the audio content.", "id": "GoogleCloudDialogflowV2InputAudioConfig", @@ -18581,10 +18694,47 @@ "description": "Configures speech transcription for ConversationProfile.", "id": "GoogleCloudDialogflowV2SpeechToTextConfig", "properties": { + "audioEncoding": { + "description": "Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "languageCode": { + "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ @@ -19551,6 +19701,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -19755,6 +19920,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -21214,6 +21402,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -21363,6 +21558,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "sipUri": { + "description": "Transfer the call to a SIP endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index cef253fd7d..a423480fa1 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -4108,6 +4108,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "getEncryptionSpec": { + "description": "Gets location-level encryption key specification.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", + "httpMethod": "GET", + "id": "dialogflow.projects.locations.getEncryptionSpec", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the encryption spec resource to get.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}", + "response": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2beta1/projects/{projectsId}/locations", @@ -7109,6 +7135,39 @@ } } }, + "encryptionSpec": { + "methods": { + "initialize": { + "description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", + "flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.encryptionSpec.initialize", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", + "required": true, + "type": "string" + } + }, + "path": "v2beta1/{+name}:initialize", + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + } + } + }, "generators": { "methods": { "create": { @@ -8023,7 +8082,7 @@ } } }, - "revision": "20240614", + "revision": "20240724", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8083,12 +8142,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -8402,7 +8465,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -8480,7 +8543,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -8535,6 +8598,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -9751,7 +9818,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -9810,7 +9877,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -9840,11 +9907,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -10473,12 +10540,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -10792,7 +10863,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -10870,7 +10941,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -10925,6 +10996,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -12133,7 +12208,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -12192,7 +12267,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -12222,11 +12297,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -13274,6 +13349,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13517,6 +13607,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15603,7 +15716,7 @@ "id": "GoogleCloudDialogflowV2beta1AudioInput", "properties": { "audio": { - "description": "Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", + "description": "Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", "format": "byte", "type": "string" }, @@ -16512,6 +16625,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17606,6 +17734,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", @@ -19499,6 +19650,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -20363,10 +20521,47 @@ "description": "Configures speech transcription for ConversationProfile.", "id": "GoogleCloudDialogflowV2beta1SpeechToTextConfig", "properties": { + "audioEncoding": { + "description": "Audio encoding of the audio content to process.", + "enum": [ + "AUDIO_ENCODING_UNSPECIFIED", + "AUDIO_ENCODING_LINEAR_16", + "AUDIO_ENCODING_FLAC", + "AUDIO_ENCODING_MULAW", + "AUDIO_ENCODING_AMR", + "AUDIO_ENCODING_AMR_WB", + "AUDIO_ENCODING_OGG_OPUS", + "AUDIO_ENCODING_SPEEX_WITH_HEADER_BYTE" + ], + "enumDescriptions": [ + "Not specified.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).", + "[`FLAC`](https://xiph.org/flac/documentation.html) (Free Lossless Audio Codec) is the recommended encoding because it is lossless (therefore recognition is not compromised) and requires only about half the bandwidth of `LINEAR16`. `FLAC` stream encoding supports 16-bit and 24-bit samples, however, not all fields in `STREAMINFO` are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate_hertz` must be 8000.", + "Adaptive Multi-Rate Wideband codec. `sample_rate_hertz` must be 16000.", + "Opus encoded audio frames in Ogg container ([OggOpus](https://wiki.xiph.org/OggOpus)). `sample_rate_hertz` must be 16000.", + "Although the use of lossy encodings is not recommended, if a very low bitrate encoding is required, `OGG_OPUS` is highly preferred over Speex encoding. The [Speex](https://speex.org/) encoding supported by Dialogflow API has a header byte in each block, as in MIME type `audio/x-speex-with-header-byte`. It is a variant of the RTP Speex encoding defined in [RFC 5574](https://tools.ietf.org/html/rfc5574). The stream is a sequence of blocks, one block per RTP packet. Each block starts with a byte containing the length of the block, in bytes, followed by one or more frames of Speex data, padded to an integral number of bytes (octets) as specified in RFC 5574. In other words, each RTP header is replaced with a single byte containing the block length. Only Speex wideband is supported. `sample_rate_hertz` must be 16000." + ], + "type": "string" + }, + "enableWordInfo": { + "description": "If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information.", + "type": "boolean" + }, + "languageCode": { + "description": "The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language.", + "type": "string" + }, "model": { "description": "Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection.", "type": "string" }, + "sampleRateHertz": { + "description": "Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details.", + "format": "int32", + "type": "integer" + }, "speechModelVariant": { "description": "The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error.", "enum": [ diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index 63873b0e28..f9cacc979e 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -902,7 +902,7 @@ ], "parameters": { "environment": { - "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1110,7 +1110,7 @@ "type": "string" }, "parent": { - "description": "Required. The environment to list results for. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to list results for. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1325,7 +1325,7 @@ ], "parameters": { "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", "required": true, @@ -2396,7 +2396,7 @@ ], "parameters": { "baseVersion": { - "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`.", + "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", "required": true, @@ -3382,7 +3382,7 @@ ], "parameters": { "parent": { - "description": "Required. Agent name. Format: `projects//locations//agents/ `.", + "description": "Required. Agent name. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, @@ -3619,7 +3619,7 @@ ], "parameters": { "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -3654,7 +3654,7 @@ ], "parameters": { "name": { - "description": "Required. Format of test case name to run: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case name to run: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -3729,7 +3729,7 @@ "type": "string" }, "parent": { - "description": "Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "description": "Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -4453,7 +4453,7 @@ } } }, - "revision": "20240614", + "revision": "20240724", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4513,12 +4513,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -4824,7 +4828,7 @@ "id": "GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest", "properties": { "names": { - "description": "Required. Format of test case names: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case names: `projects//locations//agents//testCases/`.", "items": { "type": "string" }, @@ -5273,6 +5277,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5364,6 +5372,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5465,7 +5477,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowRequest", "properties": { "flowVersion": { - "description": "Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`.", + "description": "Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`.", "type": "string" } }, @@ -5476,7 +5488,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -5772,7 +5784,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -5827,6 +5839,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -5882,7 +5898,7 @@ "type": "string" }, "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "type": "string" }, "result": { @@ -6394,6 +6410,10 @@ "$ref": "GoogleCloudDialogflowCxV3KnowledgeConnectorSettings", "description": "Optional. Knowledge connector configuration." }, + "locked": { + "description": "Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.", + "type": "boolean" + }, "multiLanguageSettings": { "$ref": "GoogleCloudDialogflowCxV3FlowMultiLanguageSettings", "description": "Optional. Multi-lingual agent settings for this flow." @@ -6407,7 +6427,7 @@ "description": "NLU related settings of the flow." }, "transitionRouteGroups": { - "description": "A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.", + "description": "A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups.", "items": { "type": "string" }, @@ -7864,6 +7884,7 @@ "NO_MATCH", "NO_INPUT", "EVENT", + "KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -7874,6 +7895,7 @@ "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -9147,7 +9169,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -9206,7 +9228,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -9236,11 +9258,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -10260,12 +10282,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -10579,7 +10605,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -10657,7 +10683,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -10712,6 +10738,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -11920,7 +11950,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -11979,7 +12009,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -12009,11 +12039,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -13061,6 +13091,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13304,6 +13349,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15125,6 +15193,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -15329,6 +15412,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -16788,6 +16894,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -16937,6 +17050,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "sipUri": { + "description": "Transfer the call to a SIP endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index e8e5e5c148..e021ed8782 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -1000,7 +1000,7 @@ ], "parameters": { "environment": { - "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1208,7 +1208,7 @@ "type": "string" }, "parent": { - "description": "Required. The environment to list results for. Format: `projects//locations//agents// environments/`.", + "description": "Required. The environment to list results for. Format: `projects//locations//agents//environments/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+$", "required": true, @@ -1423,7 +1423,7 @@ ], "parameters": { "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/environments/[^/]+/experiments/[^/]+$", "required": true, @@ -2494,7 +2494,7 @@ ], "parameters": { "baseVersion": { - "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`.", + "description": "Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/flows/[^/]+/versions/[^/]+$", "required": true, @@ -3923,7 +3923,7 @@ ], "parameters": { "parent": { - "description": "Required. Agent name. Format: `projects//locations//agents/ `.", + "description": "Required. Agent name. Format: `projects//locations//agents/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", "required": true, @@ -4160,7 +4160,7 @@ ], "parameters": { "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -4195,7 +4195,7 @@ ], "parameters": { "name": { - "description": "Required. Format of test case name to run: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case name to run: `projects//locations//agents//testCases/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -4270,7 +4270,7 @@ "type": "string" }, "parent": { - "description": "Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", + "description": "Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/testCases/[^/]+$", "required": true, @@ -5185,7 +5185,7 @@ } } }, - "revision": "20240614", + "revision": "20240731", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5245,12 +5245,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -5564,7 +5568,7 @@ "id": "GoogleCloudDialogflowCxV3DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -5642,7 +5646,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -5697,6 +5701,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -6913,7 +6921,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -6972,7 +6980,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -7002,11 +7010,11 @@ "id": "GoogleCloudDialogflowCxV3TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -7662,12 +7670,16 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { + "enableConsentBasedRedaction": { + "description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", + "type": "boolean" + }, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" }, "enableStackdriverLogging": { - "description": "Enables StackDriver logging.", + "description": "Enables Google Cloud Logging.", "type": "boolean" } }, @@ -7988,7 +8000,7 @@ "id": "GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest", "properties": { "names": { - "description": "Required. Format of test case names: `projects//locations/ /agents//testCases/`.", + "description": "Required. Format of test case names: `projects//locations//agents//testCases/`.", "items": { "type": "string" }, @@ -8699,6 +8711,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8790,6 +8806,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { + "model": { + "description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", + "type": "string" + }, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8891,7 +8911,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowRequest", "properties": { "flowVersion": { - "description": "Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`.", + "description": "Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`.", "type": "string" } }, @@ -8902,7 +8922,7 @@ "id": "GoogleCloudDialogflowCxV3beta1DeployFlowResponse", "properties": { "deployment": { - "description": "The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`.", + "description": "The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`.", "type": "string" }, "environment": { @@ -9202,7 +9222,7 @@ "type": "boolean" }, "testCases": { - "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/`", + "description": "A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/`", "items": { "type": "string" }, @@ -9257,6 +9277,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, + "targetPlaybook": { + "description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", + "type": "string" + }, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -9388,7 +9412,7 @@ "type": "string" }, "name": { - "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/..", + "description": "The name of the experiment. Format: projects//locations//agents//environments//experiments/.", "type": "string" }, "result": { @@ -9936,6 +9960,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings", "description": "Optional. Knowledge connector configuration." }, + "locked": { + "description": "Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected.", + "type": "boolean" + }, "multiLanguageSettings": { "$ref": "GoogleCloudDialogflowCxV3beta1FlowMultiLanguageSettings", "description": "Optional. Multi-lingual agent settings for this flow." @@ -9997,7 +10025,7 @@ "id": "GoogleCloudDialogflowCxV3beta1FlowInvocation", "properties": { "flow": { - "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents/`.", + "description": "Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`.", "type": "string" }, "flowState": { @@ -10803,6 +10831,35 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1InlineSchema": { + "description": "A type schema object that's specified inline.", + "id": "GoogleCloudDialogflowCxV3beta1InlineSchema", + "properties": { + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1TypeSchema", + "description": "Schema of the elements if this is an ARRAY type." + }, + "type": { + "description": "Data type of the schema.", + "enum": [ + "DATA_TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "BOOLEAN", + "ARRAY" + ], + "enumDescriptions": [ + "Not specified.", + "Represents any string value.", + "Represents any number value.", + "Represents a boolean value.", + "Represents a repeated value." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1InlineSource": { "description": "Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow.", "id": "GoogleCloudDialogflowCxV3beta1InlineSource", @@ -11584,6 +11641,7 @@ "NO_MATCH", "NO_INPUT", "EVENT", + "KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -11594,6 +11652,7 @@ "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", + "The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -11883,7 +11942,8 @@ "type": "string" }, "type": { - "description": "Required. Type of parameter.", + "deprecated": true, + "description": "Type of parameter.", "enum": [ "PARAMETER_TYPE_UNSPECIFIED", "STRING", @@ -11903,6 +11963,10 @@ "Represents a repeated value." ], "type": "string" + }, + "typeSchema": { + "$ref": "GoogleCloudDialogflowCxV3beta1TypeSchema", + "description": "Optional. Type schema of parameter." } }, "type": "object" @@ -13166,7 +13230,7 @@ "description": "The latest test result." }, "name": { - "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`.", + "description": "The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`.", "type": "string" }, "notes": { @@ -13225,7 +13289,7 @@ "type": "string" }, "name": { - "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`.", + "description": "The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`.", "type": "string" }, "testResult": { @@ -13255,11 +13319,11 @@ "id": "GoogleCloudDialogflowCxV3beta1TestConfig", "properties": { "flow": { - "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "page": { - "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow.", + "description": "The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow.", "type": "string" }, "trackingParameters": { @@ -13610,6 +13674,10 @@ "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthentication", "description": "Optional. Authentication information required by the API." }, + "serviceDirectoryConfig": { + "$ref": "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig", + "description": "Optional. Service Directory configuration." + }, "textSchema": { "description": "Required. The OpenAPI schema specified as a text.", "type": "string" @@ -13621,6 +13689,17 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig": { + "description": "Configuration for tools using Service Directory.", + "id": "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig", + "properties": { + "service": { + "description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the agent.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ToolTLSConfig": { "description": "The TLS configuration.", "id": "GoogleCloudDialogflowCxV3beta1ToolTLSConfig", @@ -13934,6 +14013,36 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1TypeSchema": { + "description": "Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition.", + "id": "GoogleCloudDialogflowCxV3beta1TypeSchema", + "properties": { + "inlineSchema": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineSchema", + "description": "Set if this is an inline schema definition." + }, + "schemaReference": { + "$ref": "GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference", + "description": "Set if this is a schema reference." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference": { + "description": "A reference to the schema of an existing tool.", + "id": "GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference", + "properties": { + "schema": { + "description": "The name of the schema.", + "type": "string" + }, + "tool": { + "description": "The tool that contains this schema definition. Format: `projects//locations//agents//tools/`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata": { "description": "Metadata for UpdateDocument operation.", "id": "GoogleCloudDialogflowCxV3beta1UpdateDocumentOperationMetadata", @@ -14982,6 +15091,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -15225,6 +15349,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -17046,6 +17193,21 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1EncryptionSpec": { + "description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", + "id": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "properties": { + "kmsKey": { + "description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", + "type": "string" + }, + "name": { + "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17250,6 +17412,29 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { + "description": "Metadata for initializing a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", + "properties": { + "request": { + "$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "description": "Output only. The original request for initialization.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { + "description": "The request to initialize a location-level encryption specification.", + "id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", + "properties": { + "encryptionSpec": { + "$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", + "description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -18709,6 +18894,13 @@ "readOnly": true, "type": "string" }, + "responseMessages": { + "description": "Optional. Automated agent responses.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" + }, + "type": "array" + }, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -18858,6 +19050,125 @@ }, "type": "object" }, + "GoogleCloudDialogflowV2beta1ResponseMessage": { + "description": "Response messages from an automated agent.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessage", + "properties": { + "endInteraction": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "description": "A signal that indicates the interaction with the Dialogflow agent has ended." + }, + "liveAgentHandoff": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "description": "Hands off conversation to a live agent." + }, + "mixedAudio": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Returns a response containing a custom, platform-specific payload.", + "type": "object" + }, + "telephonyTransferCall": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." + }, + "text": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "description": "Returns a text response." + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { + "description": "Indicates that interaction with the Dialogflow agent has ended.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { + "description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", + "properties": { + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { + "description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", + "properties": { + "segments": { + "description": "Segments this audio response is composed of.", + "items": { + "$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { + "description": "Represents one segment of audio.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", + "properties": { + "allowPlaybackInterruption": { + "description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", + "type": "boolean" + }, + "audio": { + "description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "Client-specific URI that points to an audio clip accessible to the client.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { + "description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", + "properties": { + "phoneNumber": { + "description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", + "type": "string" + }, + "sipUri": { + "description": "Transfer the call to a SIP endpoint.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowV2beta1ResponseMessageText": { + "description": "The text response message.", + "id": "GoogleCloudDialogflowV2beta1ResponseMessageText", + "properties": { + "text": { + "description": "A collection of text responses.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/discovery/discoveryengine-v1.json b/discovery/discoveryengine-v1.json index 76f217377d..94f66f79cf 100644 --- a/discovery/discoveryengine-v1.json +++ b/discovery/discoveryengine-v1.json @@ -287,6 +287,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" + }, + "skipDefaultSchemaCreation": { + "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/dataStores", @@ -449,10 +454,71 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "trainCustomModel": { + "description": "Trains a custom model.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.trainCustomModel", + "parameterOrder": [ + "dataStore" + ], + "parameters": { + "dataStore": { + "description": "Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataStore}:trainCustomModel", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { "branches": { + "methods": { + "batchGetDocumentsMetadata": { + "description": "Gets index freshness metadata for Documents. Supported for website search only.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The exact URIs to match by.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/batchGetDocumentsMetadata", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "documents": { "methods": { @@ -1184,6 +1250,35 @@ } } }, + "customModels": { + "methods": { + "list": { + "description": "Gets a list of all the custom models.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.customModels.list", + "parameterOrder": [ + "dataStore" + ], + "parameters": { + "dataStore": { + "description": "Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+dataStore}/customModels", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "models": { "resources": { "operations": { @@ -2438,6 +2533,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write", @@ -3486,6 +3609,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "skipDefaultSchemaCreation": { + "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/dataStores", @@ -3652,6 +3780,39 @@ }, "resources": { "branches": { + "methods": { + "batchGetDocumentsMetadata": { + "description": "Gets index freshness metadata for Documents. Supported for website search only.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The exact URIs to match by.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/batchGetDocumentsMetadata", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "documents": { "methods": { @@ -5359,6 +5520,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write", @@ -5428,6 +5617,80 @@ } } }, + "identity_mapping_stores": { + "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}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.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/[^/]+/identity_mapping_stores/[^/]+$", + "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": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -5711,7 +5974,7 @@ } } }, - "revision": "20240621", + "revision": "20240813", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -5881,7 +6144,7 @@ "type": "string" }, "projectId": { - "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -5904,7 +6167,9 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -5912,7 +6177,9 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -6156,12 +6423,14 @@ "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type." + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." ], "type": "string" }, @@ -6177,6 +6446,11 @@ "disable": { "description": "Disable query rephraser.", "type": "boolean" + }, + "maxRephraseSteps": { + "description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.", + "format": "int32", + "type": "integer" } }, "type": "object" @@ -6247,7 +6521,7 @@ "type": "string" }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -6398,7 +6672,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1Answer", - "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + "description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -6438,12 +6712,14 @@ "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type." + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." ], "type": "string" } @@ -6458,6 +6734,10 @@ "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -6482,7 +6762,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -6520,6 +6800,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo", @@ -6565,6 +6864,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -6657,6 +6961,14 @@ }, "type": "array" }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "type": "object" + }, "title": { "description": "Title.", "type": "string" @@ -6681,7 +6993,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -6759,34 +7071,91 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest", - "properties": {}, + "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse": { + "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", + "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse", + "properties": { + "documentsMetadata": { + "description": "The metadata of the Documents.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata" + }, + "type": "array" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BigQuerySource": { - "description": "BigQuery source import data from.", - "id": "GoogleCloudDiscoveryengineV1BigQuerySource", + "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata": { + "description": "The metadata of a Document.", + "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata", "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 to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", - "type": "string" - }, - "datasetId": { - "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", + "lastRefreshedTime": { + "description": "The timestamp of the last time the Document was last indexed.", + "format": "google-datetime", "type": "string" }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", - "type": "string" + "matcherValue": { + "$ref": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "description": "The value of the matcher that was used to match the Document." }, - "partitionDate": { + "status": { + "description": "The status of the document.", + "enum": [ + "STATUS_UNSPECIFIED", + "STATUS_INDEXED", + "STATUS_NOT_IN_TARGET_SITE", + "STATUS_NOT_IN_INDEX" + ], + "enumDescriptions": [ + "Should never be set.", + "The Document is indexed.", + "The Document is not indexed because its URI is not in the TargetSite.", + "The Document is not indexed." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { + "description": "The value of the matcher that was used to match the Document.", + "id": "GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "properties": { + "uri": { + "description": "If match by URI, the URI of the Document.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BigQuerySource": { + "description": "BigQuery source import data from.", + "id": "GoogleCloudDiscoveryengineV1BigQuerySource", + "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 to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", + "type": "string" + }, + "datasetId": { + "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", + "type": "string" + }, + "partitionDate": { "$ref": "GoogleTypeDate", "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { - "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -6937,7 +7306,7 @@ "type": "string" }, "projectId": { - "description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -7027,6 +7396,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", "type": "boolean" }, + "score": { + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].", + "format": "double", + "type": "number" + }, "startPos": { "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", "format": "int32", @@ -7176,7 +7550,7 @@ "type": "boolean" }, "projectId": { - "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -7337,7 +7711,7 @@ "id": "GoogleCloudDiscoveryengineV1Control", "properties": { "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -7729,6 +8103,67 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1CustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1CustomTuningModel", + "properties": { + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", + "type": "string" + }, + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" + ], + "enumDescriptions": [ + "Default value.", + "The model is in a paused training state.", + "The model is currently training.", + "The model has successfully completed training.", + "The model is ready for serving.", + "The model training failed.", + "The model training finished successfully but metrics did not improve." + ], + "type": "string" + }, + "modelVersion": { + "description": "The version of the model.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "type": "string" + }, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1DataStore": { "description": "DataStore captures global settings and configs at the DataStore level.", "id": "GoogleCloudDiscoveryengineV1DataStore", @@ -7739,13 +8174,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", - "The data store is used for public website search." + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -7812,6 +8249,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1Schema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -7995,6 +8436,11 @@ "description": "The Document resource ID.", "type": "string" }, + "joined": { + "description": "Output only. Whether the referenced Document can be found in the data store.", + "readOnly": true, + "type": "boolean" + }, "name": { "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" @@ -8038,7 +8484,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -8392,6 +8838,13 @@ "gcsStagingDir": { "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.", "type": "string" + }, + "resourceTypes": { + "description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -8911,6 +9364,20 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1ListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1ListCustomModelsResponse", + "properties": { + "models": { + "description": "List of custom tuning models.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1CustomTuningModel" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1ListDataStoresResponse": { "description": "Response message for DataStoreService.ListDataStores method.", "id": "GoogleCloudDiscoveryengineV1ListDataStoresResponse", @@ -9260,6 +9727,10 @@ "description": "Request message for DocumentService.PurgeDocuments method.", "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequest", "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." + }, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" @@ -9267,6 +9738,28 @@ "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1GcsSource", + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource", + "description": "Inline source for the input content for purge." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource": { + "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource", + "properties": { + "documents": { + "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -9290,6 +9783,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1PurgeErrorConfig": { + "description": "Configuration of destination for Purge related errors.", + "id": "GoogleCloudDiscoveryengineV1PurgeErrorConfig", + "properties": { + "gcsPrefix": { + "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", @@ -9332,6 +9836,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest", + "properties": { + "filter": { + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "type": "string" + }, + "force": { + "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1Query": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1Query", @@ -9632,7 +10151,7 @@ "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -9663,6 +10182,18 @@ "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "type": "string" + }, + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, "spellCorrectionSpec": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." @@ -9728,7 +10259,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -9830,6 +10361,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -9885,7 +10420,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -10005,6 +10540,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec", + "properties": { + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1SearchRequestSessionSpec", + "properties": { + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", + "type": "string" + }, + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec": { "description": "The specification for query spell correction.", "id": "GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec", @@ -10064,6 +10636,10 @@ }, "type": "array" }, + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + }, "summary": { "$ref": "GoogleCloudDiscoveryengineV1SearchResponseSummary", "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." @@ -10153,6 +10729,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1SearchResponseSessionInfo", + "properties": { + "name": { + "description": "Name of the session. If the auto-session mode is used (when SearchRequest.session ends with \"-\"), this field holds the newly generated session name.", + "type": "string" + }, + "queryId": { + "description": "Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1SearchResponseSummary": { "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1SearchResponseSummary", @@ -10170,15 +10761,21 @@ "NON_SUMMARY_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "LLM_ADDON_NOT_ENABLED" + "LLM_ADDON_NOT_ENABLED", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled." + "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", + "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -10447,7 +11044,7 @@ "type": "string" }, "projectId": { - "description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -10599,70 +11196,167 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TransactionInfo": { - "description": "A transaction represents the entire purchase transaction.", - "id": "GoogleCloudDiscoveryengineV1TransactionInfo", + "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", "properties": { - "cost": { - "description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost", - "format": "float", - "type": "number" - }, - "currency": { - "description": "Required. Currency code. Use three-character ISO-4217 code.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "discountValue": { - "description": "The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost", - "format": "float", - "type": "number" - }, - "tax": { - "description": "All the taxes associated with the transaction.", - "format": "float", - "type": "number" - }, - "transactionId": { - "description": "The transaction ID with a length limit of 128 characters.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "value": { - "description": "Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1TrainCustomModelRequest": { + "description": "Request message for SearchTuningService.TrainCustomModel method.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "The desired location of errors incurred during the data ingestion and training." + }, + "gcsTrainingInput": { + "$ref": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput", + "description": "Cloud Storage training input." + }, + "modelId": { + "description": "If not provided, a UUID will be generated.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "modelType": { + "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput": { + "description": "Cloud Storage training data input.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "corpusDataPath": { + "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "queryDataPath": { + "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", + "type": "string" + }, + "testDataPath": { + "description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", + "type": "string" + }, + "trainDataPath": { + "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", + "type": "string" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TransactionInfo": { + "description": "A transaction represents the entire purchase transaction.", + "id": "GoogleCloudDiscoveryengineV1TransactionInfo", + "properties": { + "cost": { + "description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost", + "format": "float", + "type": "number" + }, + "currency": { + "description": "Required. Currency code. Use three-character ISO-4217 code.", + "type": "string" + }, + "discountValue": { + "description": "The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost", + "format": "float", + "type": "number" + }, + "tax": { + "description": "All the taxes associated with the transaction.", + "format": "float", + "type": "number" + }, + "transactionId": { + "description": "The transaction ID with a length limit of 128 characters.", + "type": "string" + }, + "value": { + "description": "Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, @@ -10783,6 +11477,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1WorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", + "properties": { + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAclConfig": { "description": "Access Control Configuration.", "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", @@ -10811,7 +11536,9 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -10819,7 +11546,9 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -10958,12 +11687,14 @@ "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type." + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." ], "type": "string" } @@ -10978,6 +11709,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -11002,7 +11737,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -11040,6 +11775,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", @@ -11085,6 +11839,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -11177,6 +11936,14 @@ }, "type": "array" }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "type": "object" + }, "title": { "description": "Title.", "type": "string" @@ -11201,7 +11968,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -11323,7 +12090,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -11493,6 +12260,12 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11527,11 +12300,23 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "properties": { + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { "description": "Metadata that describes a custom tuned model.", "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "properties": { "createTime": { + "deprecated": true, "description": "Timestamp the Model was created at.", "format": "google-datetime", "type": "string" @@ -11540,6 +12325,14 @@ "description": "The display name of the model.", "type": "string" }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, "modelState": { "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ @@ -11548,7 +12341,8 @@ "TRAINING", "TRAINING_COMPLETE", "READY_FOR_SERVING", - "TRAINING_FAILED" + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "enumDescriptions": [ "Default value.", @@ -11556,7 +12350,8 @@ "The model is currently training.", "The model has successfully completed training.", "The model is ready for serving.", - "The model training failed." + "The model training failed.", + "The model training finished successfully but metrics did not improve." ], "type": "string" }, @@ -11591,13 +12386,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", - "The data store is used for public website search." + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -11673,6 +12470,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -11788,7 +12589,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -12222,6 +13023,96 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." + }, + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "properties": { + "sampleQuerySet": { + "description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -12233,12 +13124,14 @@ "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", "METATAGS", "PAGEMAP", + "URI_PATTERN_MAPPING", "SCHEMA_ORG" ], "enumDescriptions": [ "Value used when unset.", "Retrieve value from meta tag.", "Retrieve value from page map.", + "Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API.", "Retrieve value from schema.org data." ], "type": "string" @@ -12373,6 +13266,24 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", + "properties": { + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "description": "Identity Provider Config.", "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", @@ -12515,37 +13426,87 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { "createTime": { - "description": "Operation create time.", + "description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { + "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, "errorSamples": { "description": "A sample of errors encountered while processing the request.", "items": { "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", "type": "string" }, "importedEntriesCount": { @@ -12611,6 +13572,33 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", + "properties": { + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" + }, + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", @@ -12891,6 +13879,60 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13045,457 +14087,543 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSession": { - "description": "External session proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaSession", + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { - "endTime": { - "description": "Output only. The time the session finished.", - "format": "google-datetime", - "readOnly": true, + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + }, + "branch": { + "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, - "startTime": { - "description": "Output only. The time the session started.", - "format": "google-datetime", - "readOnly": true, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "dataStoreSpecs": { + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." + }, + "facetSpecs": { + "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + }, + "type": "array" + }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" }, - "state": { - "description": "The state of the session.", + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "description": "Raw image query." + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", + "type": "string" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "offset": { + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", + "type": "object" + }, + "query": { + "description": "Raw search query.", + "type": "string" + }, + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "rankingExpression": { + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", + "type": "string" + }, + "regionCode": { + "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", + "type": "string" + }, + "relevanceThreshold": { + "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS" + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" ], "enumDescriptions": [ - "State is unspecified.", - "The session is currently open." + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." ], "type": "string" }, - "turns": { - "description": "Turns.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "type": "string" + }, + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "type": "string" + }, + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" }, "userPseudoId": { - "description": "A unique identifier for tracking users.", + "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSessionTurn": { - "description": "Represents a turn, including a query from the user and a answer from service.", - "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { - "answer": { - "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", - "type": "string" + "conditionBoostSpecs": { + "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", + "properties": { + "boost": { + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", + "format": "float", + "type": "number" }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "The user query." + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "condition": { + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { + "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", + "attributeType": { + "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" ], "enumDescriptions": [ - "Defaults to VERIFIED.", - "Site ownership verified.", - "Site ownership pending verification or verification failed.", - "Site exempt from verification, e.g., a public website that opens to all." + "Unspecified AttributeType.", + "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", - "properties": { - "exactMatch": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true - }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, + "controlPoints": { + "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, - "indexingStatus": { - "description": "Output only. Indexing status.", + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" ], "enumDescriptions": [ - "Defaults to SUCCEEDED.", - "The target site is in the update queue and will be picked up by indexing pipeline.", - "The target site fails to be indexed.", - "The target site has been indexed.", - "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." ], - "readOnly": true, "type": "string" - }, - "name": { - "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", - "readOnly": true, - "type": "string" - }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { + "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, - "type": "string" + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "properties": { + "chunkSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, - "updateTime": { - "description": "Output only. The target site's last updated time.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "numNextChunks": { + "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", + "format": "int32", + "type": "integer" + }, + "numPreviousChunks": { + "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", - "type": "string" + "maxExtractiveAnswerCount": { + "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", + "format": "int32", + "type": "integer" + }, + "maxExtractiveSegmentCount": { + "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { - "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "maxSnippetCount": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "type": "boolean" + }, + "returnSnippet": { + "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { - "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", + "type": "boolean" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the data.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" }, - "metrics": { - "additionalProperties": { - "format": "double", - "type": "number" - }, - "description": "The metrics of the trained model.", - "type": "object" + "ignoreNonSummarySeekingQuery": { + "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", + "type": "boolean" }, - "modelName": { - "description": "Fully qualified name of the CustomTuningModel.", - "type": "string" + "includeCitations": { + "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", + "type": "boolean" }, - "modelStatus": { - "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", + "languageCode": { + "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "summaryResultCount": { + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", + "format": "int32", + "type": "integer" + }, + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { - "description": "Metadata associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { - "description": "Response associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "version": { + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { - "targetSites": { - "description": "TargetSites created.", + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1betaCondition", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" - }, - "type": "array" + "fieldPath": { + "description": "Embedding field path in schema.", + "type": "string" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "vector": { + "description": "Query embedding vector.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" + "format": "float", + "type": "number" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", + "enableDynamicPosition": { + "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" }, - "value": { - "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", - "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", - "type": "string" + "excludedFilterKeys": { + "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "type": "string" + }, + "type": "array" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." + }, + "limit": { + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControl": { - "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", - "id": "GoogleCloudDiscoveryengineV1betaControl", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" + }, + "contains": { + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, - "readOnly": true, "type": "array" }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", - "description": "Defines a boost-type control" - }, - "conditions": { - "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "intervals": { + "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCondition" + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "type": "array" }, - "displayName": { - "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" - }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "key": { + "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", - "description": "Defines a redirect-type control." - }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], + "orderBy": { + "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "prefixes": { + "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" }, - "useCases": { - "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", + "restrictedValues": { + "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "enumDescriptions": [ - "Value used when unset. Will not occur in CSS.", - "Search use case. Expects the traffic has a non-empty query.", - "Browse use case. Expects the traffic has an empty query." - ], "type": "string" }, "type": "array" @@ -13503,120 +14631,192 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" - }, - "dataStore": { - "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", - "type": "string" - }, - "filter": { - "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "dataStore": { - "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "filter": { - "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { - "redirectUri": { - "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", + "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", + "Automatic query expansion built by the Search API." + ], "type": "string" + }, + "pinUnexpandedResults": { + "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { - "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", - "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "properties": { - "synonyms": { - "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", - "items": { - "type": "string" - }, - "type": "array" + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", + "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaSession": { + "description": "External session proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaSession", "properties": { - "createTime": { - "description": "Operation create time.", + "endTime": { + "description": "Output only. The time the session finished.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the session started.", "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the session.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS" + ], + "enumDescriptions": [ + "State is unspecified.", + "The session is currently open." + ], + "type": "string" + }, + "turns": { + "description": "Turns.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + }, + "type": "array" + }, + "userPseudoId": { + "description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaSessionTurn": { + "description": "Represents a turn, including a query from the user and a answer from service.", + "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", + "properties": { + "answer": { + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", + "type": "string" + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "The user query." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13631,167 +14831,145 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the model.", - "type": "string" - }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" ], "enumDescriptions": [ - "Default value.", - "The model is in a paused training state.", - "The model is currently training.", - "The model has successfully completed training.", - "The model is ready for serving.", - "The model training failed." + "Defaults to VERIFIED.", + "Site ownership verified.", + "Site ownership pending verification or verification failed.", + "Site exempt from verification, e.g., a public website that opens to all." ], "type": "string" }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", - "type": "string" - }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", + "verifyTime": { + "description": "Latest site verification time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1betaDataStore", + "GoogleCloudDiscoveryengineV1alphaTargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "exactMatch": { + "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" + }, + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true + }, + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "indexingStatus": { + "description": "Output only. Indexing status.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" ], "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search." + "Defaults to SUCCEEDED.", + "The target site is in the update queue and will be picked up by indexing pipeline.", + "The target site fails to be indexed.", + "The target site has been indexed.", + "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], + "readOnly": true, "type": "string" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", + "name": { + "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", "readOnly": true, "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" ], "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." ], "type": "string" }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", - "description": "Language info for DataStore." - }, - "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", - "type": "string" - }, - "solutionTypes": { - "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1betaSchema", - "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "description": "Output only. The target site's last updated time.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "properties": { + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "properties": { + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13806,26 +14984,60 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { + "description": "Metadata associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", + "properties": { + "engine": { + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { + "description": "Response associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13840,9 +15052,9 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13857,198 +15069,177 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", - "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." - }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "userAgent": { + "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" }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" - }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" + "userId": { + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "includeAncestorHeadings": { - "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", - "type": "boolean" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." - }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1betaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, "type": "array" }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", "type": "boolean" + }, + "value": { + "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { - "createTime": { - "description": "Operation create time.", + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "startTime": { + "description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngine", + "GoogleCloudDiscoveryengineV1betaControl": { + "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", + "id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, "readOnly": true, - "type": "string" + "type": "array" }, - "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "description": "Defines a boost-type control" + }, + "conditions": { + "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, - "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], - "type": "string" + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" }, "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "description": "Defines a redirect-type control." }, "solutionType": { - "description": "Required. The solutions of the engine.", + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14065,130 +15256,99 @@ ], "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." }, - "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", - "type": "string" + "useCases": { + "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "Value used when unset. Will not occur in CSS.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1betaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", - "type": "string" - }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", - "type": "string" + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" }, - "location": { - "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "dataStore": { + "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "filter": { + "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1betaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "dataStore": { + "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" + }, + "filter": { + "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", "properties": { - "companyName": { - "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "redirectUri": { + "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { + "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", + "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "synonyms": { + "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], "type": "string" }, "type": "array" - }, - "searchTier": { - "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" - }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -14197,46 +15357,53 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { - "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, "updateTime": { @@ -14247,38 +15414,167 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { - "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" + "displayName": { + "description": "The display name of the model.", + "type": "string" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" }, - "type": "array" + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" + ], + "enumDescriptions": [ + "Default value.", + "The model is in a paused training state.", + "The model is currently training.", + "The model has successfully completed training.", + "The model is ready for serving.", + "The model training failed.", + "The model training finished successfully but metrics did not improve." + ], + "type": "string" + }, + "modelVersion": { + "description": "The version of the model.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "type": "string" + }, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "GoogleCloudDiscoveryengineV1betaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { - "gcsPrefix": { - "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.", + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "description": "Language info for DataStore." + }, + "name": { + "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" + }, + "solutionTypes": { + "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1betaSchema", + "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14293,49 +15589,32 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" - }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -14344,196 +15623,1576 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", "properties": { - "language": { - "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", - "readOnly": true, - "type": "string" - }, - "languageCode": { - "description": "The language code for the DataStore.", - "type": "string" - }, - "normalizedLanguageCode": { - "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", - "readOnly": true, + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "region": { - "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", - "readOnly": true, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", - "properties": { - "models": { - "description": "List of custom tuning models.", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" + }, + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + "type": "string" }, "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1betaProject", + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", "properties": { "createTime": { - "description": "Output only. The timestamp when this project is created.", + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, + "dataStoreIds": { + "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" + }, + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, + "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, - "provisionCompletionTime": { - "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + "dialogflowAgentToLink": { + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "properties": { + "business": { + "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "type": "string" + }, + "defaultLanguageCode": { + "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" + }, + "location": { + "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "type": "string" + }, + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "properties": { + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" + }, + "type": "array" + }, + "searchTier": { + "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluation", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." + }, + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "properties": { + "sampleQuerySet": { + "description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { + "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { + "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "properties": { + "gcsPrefix": { + "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" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", + "properties": { + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { + "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1betaInterval", + "properties": { + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" + }, + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "properties": { + "language": { + "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", + "readOnly": true, + "type": "string" + }, + "languageCode": { + "description": "The language code for the DataStore.", + "type": "string" + }, + "normalizedLanguageCode": { + "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", + "readOnly": true, + "type": "string" + }, + "region": { + "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", + "properties": { + "models": { + "description": "List of custom tuning models.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1betaProject", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "readOnly": true, + "type": "string" + }, + "provisionCompletionTime": { + "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", + "properties": { + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", + "type": "string" + }, + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", + "type": "string" + }, + "id": { + "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", + "type": "string" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "enumDescriptions": [ + "The default value of the enum. This value is not actually used.", + "The project has given consent to the terms of service.", + "The project is pending to review and accept the terms of service.", + "The project has declined or revoked the agreement to terms of service." + ], + "type": "string" + }, + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { + "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", + "properties": { + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "purgeSample": { + "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1betaSchema", + "properties": { + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "properties": { + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + }, + "branch": { + "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", + "type": "string" + }, + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", + "type": "string" + }, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "dataStoreSpecs": { + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", + "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." + }, + "facetSpecs": { + "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" + }, + "type": "array" + }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "description": "Raw image query." + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", + "type": "string" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "offset": { + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + }, + "params": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", + "type": "object" + }, + "query": { + "description": "Raw search query.", + "type": "string" + }, + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "rankingExpression": { + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", + "type": "string" + }, + "regionCode": { + "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", + "type": "string" + }, + "relevanceThreshold": { + "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "type": "string" + }, + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "type": "string" + }, + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "userPseudoId": { + "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", + "properties": { + "conditionBoostSpecs": { + "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", + "properties": { + "boost": { + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", + "format": "float", + "type": "number" + }, + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "condition": { + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { + "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "properties": { + "attributeType": { + "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "enumDescriptions": [ + "Unspecified AttributeType.", + "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." + ], + "type": "string" + }, + "controlPoints": { + "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { + "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", + "properties": { + "attributeValue": { + "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" + }, + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "properties": { + "chunkSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" + }, + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + }, + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "enumDescriptions": [ + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." + ], + "type": "string" + }, + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", + "properties": { + "numNextChunks": { + "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", + "format": "int32", + "type": "integer" + }, + "numPreviousChunks": { + "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", + "properties": { + "maxExtractiveAnswerCount": { + "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", + "format": "int32", + "type": "integer" + }, + "maxExtractiveSegmentCount": { + "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", + "properties": { + "maxSnippetCount": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", + "format": "int32", + "type": "integer" + }, + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "type": "boolean" + }, + "returnSnippet": { + "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", + "properties": { + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", + "type": "boolean" + }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, + "ignoreNonSummarySeekingQuery": { + "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", + "type": "boolean" + }, + "includeCitations": { + "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", + "type": "boolean" + }, + "languageCode": { + "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", + "type": "string" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "summaryResultCount": { + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", + "format": "int32", + "type": "integer" + }, + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "properties": { + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", + "properties": { + "version": { + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", + "properties": { + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", + "properties": { + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", + "properties": { + "enableDynamicPosition": { + "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", + "type": "boolean" }, - "id": { - "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", - "type": "string" + "excludedFilterKeys": { + "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "type": "string" + }, + "type": "array" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "enumDescriptions": [ - "The default value of the enum. This value is not actually used.", - "The project has given consent to the terms of service.", - "The project is pending to review and accept the terms of service.", - "The project has declined or revoked the agreement to terms of service." - ], - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "limit": { + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "contains": { + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", + "intervals": { + "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaInterval" + }, + "type": "array" + }, + "key": { + "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "orderBy": { + "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "prefixes": { + "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + }, + "restrictedValues": { + "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "properties": { + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { - "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "purgeSample": { - "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14542,61 +17201,85 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", + "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", + "Automatic query expansion built by the Search API." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "pinUnexpandedResults": { + "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1betaSchema", + "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, - "name": { - "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", + "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." + ], "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" @@ -14833,6 +17516,52 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1betaUserInfo", + "properties": { + "userAgent": { + "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": { + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", + "properties": { + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index ca7b3a84cb..3b80a035f4 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -246,7 +246,7 @@ ] }, "updateAclConfig": { - "description": "Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", + "description": "Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/aclConfig", "httpMethod": "PATCH", "id": "discoveryengine.projects.locations.updateAclConfig", @@ -423,6 +423,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" + }, + "skipDefaultSchemaCreation": { + "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+parent}/dataStores", @@ -676,6 +681,39 @@ }, "resources": { "branches": { + "methods": { + "batchGetDocumentsMetadata": { + "description": "Gets index freshness metadata for Documents. Supported for website search only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The exact URIs to match by.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/batchGetDocumentsMetadata", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "documents": { "methods": { @@ -2428,6 +2466,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getUriPatternDocumentData": { + "description": "Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "recrawlUris": { "description": "Request on-demand recrawl for a list of URIs.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", @@ -2455,6 +2518,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setUriPatternDocumentData": { + "description": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -4162,6 +4253,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "skipDefaultSchemaCreation": { + "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+parent}/dataStores", @@ -4387,6 +4483,39 @@ }, "resources": { "branches": { + "methods": { + "batchGetDocumentsMetadata": { + "description": "Gets index freshness metadata for Documents. Supported for website search only.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The exact URIs to match by.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/batchGetDocumentsMetadata", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "documents": { "methods": { @@ -6377,6 +6506,133 @@ } }, "evaluations": { + "methods": { + "create": { + "description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.evaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/evaluations", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Evaluation.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of Evaluations.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/evaluations", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listResults": { + "description": "Gets a list of results for a given a Evaluation.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.listResults", + "parameterOrder": [ + "evaluation" + ], + "parameters": { + "evaluation": { + "description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+evaluation}:listResults", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -6441,6 +6697,80 @@ } } }, + "identity_mapping_stores": { + "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.identity_mapping_stores.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/[^/]+/identity_mapping_stores/[^/]+$", + "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": "v1alpha/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "operations": { "methods": { "get": { @@ -6576,754 +6906,3321 @@ } }, "sampleQuerySets": { - "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "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 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}/userEvents:collect", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.userEvents.collect", + "create": { + "description": "Creates a SampleQuerySet", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ "parent" ], "parameters": { - "ets": { - "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", - "format": "int64", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "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 third-party requests.", + "sampleQuerySetId": { + "description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" - }, - "userEvent": { - "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", - "location": "query", + } + }, + "path": "v1alpha/{+parent}/sampleQuerySets", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuerySet.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userEvents:collect", + "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "write": { - "description": "Writes a single user event.", - "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.userEvents.write", + "get": { + "description": "Gets a SampleQuerySet.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerySets.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, "parent": { - "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQuerySets", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuerySet.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" }, - "writeAsync": { - "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "updateMask": { + "description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "v1alpha/{+parent}/userEvents:write", + "path": "v1alpha/{+name}", "request": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "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": "v1alpha/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1alpha/projects/{projectsId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.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/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - }, - "revision": "20240621", - "rootUrl": "https://discoveryengine.googleapis.com/", - "schemas": { - "GoogleApiDistribution": { - "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", - "id": "GoogleApiDistribution", - "properties": { - "bucketCounts": { - "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", - "items": { - "format": "int64", - "type": "string" - }, - "type": "array" - }, - "bucketOptions": { - "$ref": "GoogleApiDistributionBucketOptions", + "sampleQueries": { + "methods": { + "create": { + "description": "Creates a SampleQuery", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + }, + "sampleQueryId": { + "description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQueries", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SampleQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQueries:import", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerys.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}/sampleQueries", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuery.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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 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}/userEvents:collect", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userEvents.collect", + "parameterOrder": [ + "parent" + ], + "parameters": { + "ets": { + "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "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 third-party requests.", + "location": "query", + "type": "string" + }, + "userEvent": { + "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/userEvents:collect", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Writes a single user event.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userEvents.write", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "writeAsync": { + "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1alpha/{+parent}/userEvents:write", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "userStores": { + "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": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/userStores/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userStores/{userStoresId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userStores.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/[^/]+/userStores/[^/]+$", + "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": "v1alpha/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "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": "v1alpha/projects/{projectsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1alpha/projects/{projectsId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.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/[^/]+$", + "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": "v1alpha/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20240813", + "rootUrl": "https://discoveryengine.googleapis.com/", + "schemas": { + "GoogleApiDistribution": { + "description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", + "id": "GoogleApiDistribution", + "properties": { + "bucketCounts": { + "description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "bucketOptions": { + "$ref": "GoogleApiDistributionBucketOptions", "description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." }, - "count": { - "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", - "format": "int64", + "count": { + "description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", + "format": "int64", + "type": "string" + }, + "exemplars": { + "description": "Must be in increasing order of `value` field.", + "items": { + "$ref": "GoogleApiDistributionExemplar" + }, + "type": "array" + }, + "mean": { + "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", + "format": "double", + "type": "number" + }, + "range": { + "$ref": "GoogleApiDistributionRange", + "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero." + }, + "sumOfSquaredDeviation": { + "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiDistributionBucketOptions": { + "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", + "id": "GoogleApiDistributionBucketOptions", + "properties": { + "explicitBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsExplicit", + "description": "The explicit buckets." + }, + "exponentialBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsExponential", + "description": "The exponential buckets." + }, + "linearBuckets": { + "$ref": "GoogleApiDistributionBucketOptionsLinear", + "description": "The linear bucket." + } + }, + "type": "object" + }, + "GoogleApiDistributionBucketOptionsExplicit": { + "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.", + "id": "GoogleApiDistributionBucketOptionsExplicit", + "properties": { + "bounds": { + "description": "The values must be monotonically increasing.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleApiDistributionBucketOptionsExponential": { + "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).", + "id": "GoogleApiDistributionBucketOptionsExponential", + "properties": { + "growthFactor": { + "description": "Must be greater than 1.", + "format": "double", + "type": "number" + }, + "numFiniteBuckets": { + "description": "Must be greater than 0.", + "format": "int32", + "type": "integer" + }, + "scale": { + "description": "Must be greater than 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiDistributionBucketOptionsLinear": { + "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).", + "id": "GoogleApiDistributionBucketOptionsLinear", + "properties": { + "numFiniteBuckets": { + "description": "Must be greater than 0.", + "format": "int32", + "type": "integer" + }, + "offset": { + "description": "Lower bound of the first bucket.", + "format": "double", + "type": "number" + }, + "width": { + "description": "Must be greater than 0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiDistributionExemplar": { + "description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.", + "id": "GoogleApiDistributionExemplar", + "properties": { + "attachments": { + "description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "timestamp": { + "description": "The observation (sampling) time of the above value.", + "format": "google-datetime", + "type": "string" + }, + "value": { + "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiDistributionRange": { + "description": "The range of the population values.", + "id": "GoogleApiDistributionRange", + "properties": { + "max": { + "description": "The maximum of the population values.", + "format": "double", + "type": "number" + }, + "min": { + "description": "The minimum of the population values.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleApiHttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "GoogleApiHttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleApiMonitoredResource": { + "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"project_id\"`, `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }}", + "id": "GoogleApiMonitoredResource", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `\"project_id\"`, `\"instance_id\"`, and `\"zone\"`.", + "type": "object" + }, + "type": { + "description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorContext": { + "description": "A description of the context in which an error occurred.", + "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "properties": { + "httpRequest": { + "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "description": "The HTTP request which was processed when the error was triggered." + }, + "reportLocation": { + "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorLog": { + "description": "An error log which is reported to the Error Reporting system.", + "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "properties": { + "context": { + "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", + "description": "A description of the context in which the error occurred." + }, + "importPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", + "type": "string" + }, + "requestPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", + "type": "object" + }, + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", + "type": "object" + }, + "serviceContext": { + "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", + "description": "The service context in which this error has occurred." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "properties": { + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingImportErrorContext": { + "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", + "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "properties": { + "document": { + "description": "The detailed content which caused the error on importing a document.", + "type": "string" + }, + "gcsPath": { + "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", + "type": "string" + }, + "lineNumber": { + "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "type": "string" + }, + "operation": { + "description": "The operation resource name of the LRO.", + "type": "string" + }, + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "properties": { + "service": { + "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "properties": { + "functionName": { + "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "properties": { + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSite" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Condition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1Condition", + "properties": { + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + }, + "type": "array" + }, + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" + }, + "value": { + "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "properties": { + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Control": { + "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", + "id": "GoogleCloudDiscoveryengineV1Control", + "properties": { + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "description": "Defines a boost-type control" + }, + "conditions": { + "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Condition" + }, + "type": "array" + }, + "displayName": { + "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + }, + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "type": "string" + }, + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "useCases": { + "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "Value used when unset. Will not occur in CSS.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "properties": { + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "dataStore": { + "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" + }, + "filter": { + "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "properties": { + "dataStore": { + "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" + }, + "filter": { + "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "properties": { + "redirectUri": { + "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlSynonymsAction": { + "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", + "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "properties": { + "synonyms": { + "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", + "properties": { + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "solutionTypes": { + "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + }, + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Engine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1Engine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataStoreIds": { + "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" + }, + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "name": { + "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." + }, + "dialogflowAgentToLink": { + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "properties": { + "business": { + "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "type": "string" + }, + "defaultLanguageCode": { + "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" + }, + "location": { + "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "type": "string" + }, + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "properties": { + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" + }, + "type": "array" + }, + "searchTier": { + "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { + "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { + "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "properties": { + "gcsPrefix": { + "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" + }, + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", + "type": "string" + }, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Project": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1Project", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "readOnly": true, + "type": "string" + }, + "provisionCompletionTime": { + "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", + "properties": { + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", + "type": "string" + }, + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", + "type": "string" + }, + "id": { + "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", + "type": "string" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "enumDescriptions": [ + "The default value of the enum. This value is not actually used.", + "The project has given consent to the terms of service.", + "The project is pending to review and accept the terms of service.", + "The project has declined or revoked the agreement to terms of service." + ], + "type": "string" + }, + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { + "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", + "properties": { + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "purgeSample": { + "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Schema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1Schema", + "properties": { + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "properties": { + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", + "enum": [ + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" + ], + "enumDescriptions": [ + "Defaults to VERIFIED.", + "Site ownership verified.", + "Site ownership pending verification or verification failed.", + "Site exempt from verification, e.g., a public website that opens to all." + ], + "type": "string" + }, + "verifyTime": { + "description": "Latest site verification time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1TargetSite", + "properties": { + "exactMatch": { + "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" + }, + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true + }, + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "indexingStatus": { + "description": "Output only. Indexing status.", + "enum": [ + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" + ], + "enumDescriptions": [ + "Defaults to SUCCEEDED.", + "The target site is in the update queue and will be picked up by indexing pipeline.", + "The target site fails to be indexed.", + "The target site has been indexed.", + "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", + "readOnly": true, + "type": "string" + }, + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "type": "string" + }, + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true + }, + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" + ], + "enumDescriptions": [ + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "properties": { + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "properties": { + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", + "type": "string" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1WorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", + "properties": { + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "properties": { + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { + "description": "AlloyDB source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "properties": { + "clusterId": { + "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "databaseId": { + "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + "type": "string" + }, + "locationId": { + "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", + "type": "string" + }, + "projectId": { + "description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswer": { + "description": "Defines an answer.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswer", + "properties": { + "answerSkippedReasons": { + "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "items": { + "enum": [ + "ANSWER_SKIPPED_REASON_UNSPECIFIED", + "ADVERSARIAL_QUERY_IGNORED", + "NON_ANSWER_SEEKING_QUERY_IGNORED", + "OUT_OF_DOMAIN_QUERY_IGNORED", + "POTENTIAL_POLICY_VIOLATION", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" + ], + "enumDescriptions": [ + "Default value. The answer skipped reason is not specified.", + "The adversarial query ignored case.", + "The non-answer seeking query ignored case.", + "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", + "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + ], + "type": "string" + }, + "type": "array" + }, + "answerText": { + "description": "The textual answer.", + "type": "string" + }, + "citations": { + "description": "Citations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" + }, + "type": "array" + }, + "completeTime": { + "description": "Output only. Answer completed timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Answer creation timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", + "type": "string" + }, + "queryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "description": "Query understanding information." + }, + "references": { + "description": "References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" + }, + "type": "array" + }, + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "state": { + "description": "The state of the answer generation.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Answer generation is currently in progress.", + "Answer generation currently failed.", + "Answer generation has succeeded." + ], + "type": "string" + }, + "steps": { + "description": "Answer generation steps.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", + "properties": { + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", + "type": "string" + }, + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" + }, + "type": "array" + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", + "properties": { + "referenceId": { + "description": "ID of the citation source.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { + "description": "Request message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", + "properties": { + "answerGenerationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "description": "Answer generation specification." + }, + "asynchronousMode": { + "description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", + "type": "boolean" + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "Required. Current user query." + }, + "queryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", + "description": "Query understanding specification." + }, + "relatedQuestionsSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", + "description": "Related questions specification." + }, + "safetySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", + "description": "Model specification." + }, + "searchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", + "description": "Search specification." + }, + "session": { + "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", "type": "string" }, - "exemplars": { - "description": "Must be in increasing order of `value` field.", - "items": { - "$ref": "GoogleApiDistributionExemplar" + "userLabels": { + "additionalProperties": { + "type": "string" }, - "type": "array" + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" }, - "mean": { - "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", - "format": "double", - "type": "number" + "userPseudoId": { + "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { + "description": "Answer generation specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "properties": { + "answerLanguageCode": { + "description": "Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", + "type": "string" }, - "range": { - "$ref": "GoogleApiDistributionRange", - "description": "If specified, contains the range of the population values. The field must not be present if the `count` is zero." + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", + "type": "boolean" }, - "sumOfSquaredDeviation": { - "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, \"The Art of Computer Programming\", Vol. 2, page 232, 3rd edition describes Welford's method for accumulating this sum in one pass. If `count` is zero then this field must be zero.", - "format": "double", - "type": "number" + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.", + "type": "boolean" + }, + "ignoreNonAnswerSeekingQuery": { + "description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.", + "type": "boolean" + }, + "includeCitations": { + "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", + "type": "boolean" + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", + "description": "Answer generation model specification." + }, + "promptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "description": "Answer generation prompt specification." } }, "type": "object" }, - "GoogleApiDistributionBucketOptions": { - "description": "`BucketOptions` describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. `BucketOptions` does not include the number of values in each bucket. A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", - "id": "GoogleApiDistributionBucketOptions", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { + "description": "Answer Generation Model specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", "properties": { - "explicitBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsExplicit", - "description": "The explicit buckets." - }, - "exponentialBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsExponential", - "description": "The exponential buckets." + "modelVersion": { + "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { + "description": "Answer generation prompt specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", + "properties": { + "preamble": { + "description": "Customized preamble.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { + "description": "Query understanding specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", + "properties": { + "queryClassificationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "description": "Query classification specification." }, - "linearBuckets": { - "$ref": "GoogleApiDistributionBucketOptionsLinear", - "description": "The linear bucket." + "queryRephraserSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "description": "Query rephraser specification." } }, "type": "object" }, - "GoogleApiDistributionBucketOptionsExplicit": { - "description": "Specifies a set of buckets with arbitrary widths. There are `size(bounds) + 1` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): bounds[i] Lower bound (1 <= i < N); bounds[i - 1] The `bounds` field must contain at least one element. If `bounds` has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.", - "id": "GoogleApiDistributionBucketOptionsExplicit", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { + "description": "Query classification specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", "properties": { - "bounds": { - "description": "The values must be monotonically increasing.", + "types": { + "description": "Enabled query classification types.", "items": { - "format": "double", - "type": "number" + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." + ], + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleApiDistributionBucketOptionsExponential": { - "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).", - "id": "GoogleApiDistributionBucketOptionsExponential", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { + "description": "Query rephraser specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", "properties": { - "growthFactor": { - "description": "Must be greater than 1.", - "format": "double", - "type": "number" + "disable": { + "description": "Disable query rephraser.", + "type": "boolean" }, - "numFiniteBuckets": { - "description": "Must be greater than 0.", + "maxRephraseSteps": { + "description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.", "format": "int32", "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { + "description": "Related questions specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", + "properties": { + "enable": { + "description": "Enable related questions feature if true.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { + "description": "Safety specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", + "properties": { + "enable": { + "description": "Enable the safety filtering on the answer response. It is false by default.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { + "description": "Search specification.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", + "properties": { + "searchParams": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", + "description": "Search parameters." }, - "scale": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" + "searchResultList": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", + "description": "Search result list." } }, "type": "object" }, - "GoogleApiDistributionBucketOptionsLinear": { - "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket. There are `num_finite_buckets + 2` (= N) buckets. Bucket `i` has the following boundaries: Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).", - "id": "GoogleApiDistributionBucketOptionsLinear", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { + "description": "Search parameters.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", "properties": { - "numFiniteBuckets": { - "description": "Must be greater than 0.", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs." + }, + "dataStoreSpecs": { + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, + "maxReturnResults": { + "description": "Number of search results to return. The default value is 10.", "format": "int32", "type": "integer" }, - "offset": { - "description": "Lower bound of the first bucket.", - "format": "double", - "type": "number" + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" }, - "width": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "enumDescriptions": [ + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." + ], + "type": "string" } }, "type": "object" }, - "GoogleApiDistributionExemplar": { - "description": "Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.", - "id": "GoogleApiDistributionExemplar", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { + "description": "Search result list.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", "properties": { - "attachments": { - "description": "Contextual information about the example value. Examples are: Trace: type.googleapis.com/google.monitoring.v3.SpanContext Literal string: type.googleapis.com/google.protobuf.StringValue Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.", + "searchResults": { + "description": "Search results.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" }, "type": "array" - }, - "timestamp": { - "description": "The observation (sampling) time of the above value.", - "format": "google-datetime", - "type": "string" - }, - "value": { - "description": "Value of the exemplar point. This value determines to which bucket the exemplar belongs.", - "format": "double", - "type": "number" } }, "type": "object" }, - "GoogleApiDistributionRange": { - "description": "The range of the population values.", - "id": "GoogleApiDistributionRange", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { + "description": "Search result.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", "properties": { - "max": { - "description": "The maximum of the population values.", - "format": "double", - "type": "number" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "description": "Chunk information." }, - "min": { - "description": "The minimum of the population values.", - "format": "double", - "type": "number" + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "GoogleApiHttpBody": { - "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", - "id": "GoogleApiHttpBody", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", "properties": { - "contentType": { - "description": "The HTTP Content-Type header value specifying the content type of the body.", + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "data": { - "description": "The HTTP request/response body as raw binary.", - "format": "byte", + "content": { + "description": "Chunk textual content.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", "type": "string" }, - "extensions": { - "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "documentContexts": { + "description": "List of document contexts.", "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" + }, + "type": "array" + }, + "extractiveAnswers": { + "description": "List of extractive answers.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" + }, + "type": "array" + }, + "extractiveSegments": { + "description": "List of extractive segments.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" }, "type": "array" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" } }, "type": "object" }, - "GoogleApiMonitoredResource": { - "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The `type` field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the `labels` field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for `\"gce_instance\"` has labels `\"project_id\"`, `\"instance_id\"` and `\"zone\"`: { \"type\": \"gce_instance\", \"labels\": { \"project_id\": \"my-project\", \"instance_id\": \"12345678901234\", \"zone\": \"us-central1-a\" }}", - "id": "GoogleApiMonitoredResource", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { + "description": "Document context.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels `\"project_id\"`, `\"instance_id\"`, and `\"zone\"`.", - "type": "object" + "content": { + "description": "Document content.", + "type": "string" }, - "type": { - "description": "Required. The monitored resource type. This field must match the `type` field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is `gce_instance`. Some descriptors include the service name in the type; for example, the type of a Datastream stream is `datastream.googleapis.com/Stream`.", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorContext": { - "description": "A description of the context in which an error occurred.", - "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { + "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", "properties": { - "httpRequest": { - "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "description": "The HTTP request which was processed when the error was triggered." + "content": { + "description": "Extractive answer content.", + "type": "string" }, - "reportLocation": { - "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", - "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorLog": { - "description": "An error log which is reported to the Error Reporting system.", - "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { + "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", - "description": "A description of the context in which the error occurred." - }, - "importPayload": { - "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", - "description": "The error payload that is populated on LRO import APIs." - }, - "message": { - "description": "A message describing the error.", + "content": { + "description": "Extractive segment content.", "type": "string" }, - "requestPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", - "type": "object" - }, - "responsePayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", - "type": "object" + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": { + "description": "Response message for ConversationalSearchService.AnswerQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse", + "properties": { + "answer": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", + "description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, - "serviceContext": { - "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", - "description": "The service context in which this error has occurred." + "answerQueryToken": { + "description": "A global unique ID used for logging.", + "type": "string" }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The RPC status associated with the error log." + "session": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSession", + "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { - "description": "HTTP request data that is related to a reported error.", - "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { + "description": "Query understanding information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "properties": { - "responseStatusCode": { - "description": "The HTTP response status code for the request.", - "format": "int32", - "type": "integer" + "queryClassificationInfo": { + "description": "Query classification information.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingImportErrorContext": { - "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", - "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { + "description": "Query classification information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "properties": { - "document": { - "description": "The detailed content which caused the error on importing a document.", - "type": "string" - }, - "gcsPath": { - "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", - "type": "string" - }, - "lineNumber": { - "description": "Line number of the content in file. Should be empty for permission or batch operation error.", - "type": "string" - }, - "operation": { - "description": "The operation resource name of the LRO.", - "type": "string" + "positive": { + "description": "Classification output.", + "type": "boolean" }, - "userEvent": { - "description": "The detailed content which caused the error on importing a user event.", + "type": { + "description": "Query classification type.", + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingServiceContext": { - "description": "Describes a running service that sends errors.", - "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "GoogleCloudDiscoveryengineV1alphaAnswerReference": { + "description": "Reference.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", "properties": { - "service": { - "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", - "type": "string" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "description": "Chunk information." + }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingSourceLocation": { - "description": "Indicates a location in the source code of the service for which errors are reported.", - "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { - "functionName": { - "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "chunk": { + "description": "Chunk resource name.", + "type": "string" + }, + "content": { + "description": "Chunk textual content.", "type": "string" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "description": "Document metadata." + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { + "description": "Document metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "document": { + "description": "Document resource name.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "pageIdentifier": { + "description": "Page identifier.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSite" + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "description": "Structured search data.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Condition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1Condition", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", - "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" }, - "value": { - "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", + "content": { + "description": "Chunk textual content.", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Control": { - "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", - "id": "GoogleCloudDiscoveryengineV1Control", + "GoogleCloudDiscoveryengineV1alphaAnswerStep": { + "description": "Step information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", - "description": "Defines a boost-type control" - }, - "conditions": { - "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "actions": { + "description": "Actions.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1Condition" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, - "displayName": { - "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" - }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "description": { + "description": "The description of the step.", "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", - "description": "Defines a redirect-type control." - }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "state": { + "description": "The state of the step.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" ], "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + "Unknown.", + "Step is currently in progress.", + "Step currently failed.", + "Step has succeeded." ], "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "thought": { + "description": "The thought of the step.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { + "description": "Action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", + "properties": { + "observation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "description": "Observation." }, - "useCases": { - "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "enumDescriptions": [ - "Value used when unset. Will not occur in CSS.", - "Search use case. Expects the traffic has a non-empty query.", - "Browse use case. Expects the traffic has an empty query." - ], - "type": "string" + "searchAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "description": "Search action." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { + "description": "Observation.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "properties": { + "searchResults": { + "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "chunkInfo": { + "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" + }, + "type": "array" }, - "dataStore": { - "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "document": { + "description": "Document resource name.", "type": "string" }, - "filter": { - "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "snippetInfo": { + "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" + }, + "type": "array" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "type": "object" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { - "dataStore": { - "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "filter": { - "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "content": { + "description": "Chunk textual content.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { + "description": "Snippet information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { - "redirectUri": { - "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "snippet": { + "description": "Snippet content.", + "type": "string" + }, + "snippetStatus": { + "description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlSynonymsAction": { - "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", - "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { + "description": "Search action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "properties": { - "synonyms": { - "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", - "items": { - "type": "string" - }, - "type": "array" + "query": { + "description": "The query to search.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7338,901 +10235,891 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "requests": { + "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse": { + "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "documentsMetadata": { + "description": "The metadata of the Documents.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", + "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata": { + "description": "The metadata of a Document.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search." - ], - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", + "lastRefreshedTime": { + "description": "The timestamp of the last time the Document was last indexed.", "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." + "matcherValue": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "description": "The value of the matcher that was used to match the Document." }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "status": { + "description": "The status of the document.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "STATUS_UNSPECIFIED", + "STATUS_INDEXED", + "STATUS_NOT_IN_TARGET_SITE", + "STATUS_NOT_IN_INDEX" ], "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." + "Should never be set.", + "The Document is indexed.", + "The Document is not indexed because its URI is not in the TargetSite.", + "The Document is not indexed." ], "type": "string" - }, - "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { + "description": "The value of the matcher that was used to match the Document.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "properties": { + "uri": { + "description": "If match by URI, the URI of the Document.", "type": "string" - }, - "solutionTypes": { - "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1Schema", - "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { + "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { + "description": "BigQuery source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "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 to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", + "type": "string" + }, + "datasetId": { + "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", + "type": "string" + }, + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "partitionDate": { + "$ref": "GoogleTypeDate", + "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." + }, + "projectId": { + "description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { + "description": "The Bigtable Options object that contains information to support the import.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "families": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" + }, + "description": "The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.", + "type": "object" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "keyFieldName": { + "description": "The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { + "description": "The column of the Bigtable.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "encoding": { + "description": "The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.", + "enum": [ + "ENCODING_UNSPECIFIED", + "TEXT", + "BINARY" + ], + "enumDescriptions": [ + "The encoding is unspecified.", + "Text encoding.", + "Binary encoding." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "fieldName": { + "description": "The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.", + "type": "string" + }, + "qualifier": { + "description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.", + "format": "byte", + "type": "string" + }, + "type": { + "description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.", + "enum": [ + "TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "INTEGER", + "VAR_INTEGER", + "BIG_NUMERIC", + "BOOLEAN", + "JSON" + ], + "enumDescriptions": [ + "The type is unspecified.", + "String type.", + "Numerical type.", + "Integer type.", + "Variable length integer type.", + "BigDecimal type.", + "Boolean type.", + "JSON type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { + "description": "The column family of the Bigtable.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "columns": { + "description": "The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" + }, + "type": "array" + }, + "encoding": { + "description": "The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.", + "enum": [ + "ENCODING_UNSPECIFIED", + "TEXT", + "BINARY" + ], + "enumDescriptions": [ + "The encoding is unspecified.", + "Text encoding.", + "Binary encoding." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "fieldName": { + "description": "The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.", + "type": "string" + }, + "type": { + "description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.", + "enum": [ + "TYPE_UNSPECIFIED", + "STRING", + "NUMBER", + "INTEGER", + "VAR_INTEGER", + "BIG_NUMERIC", + "BOOLEAN", + "JSON" + ], + "enumDescriptions": [ + "The type is unspecified.", + "String type.", + "Numerical type.", + "Integer type.", + "Variable length integer type.", + "BigDecimal type.", + "Boolean type.", + "JSON type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaBigtableSource": { + "description": "The Cloud Bigtable source for importing data.", + "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "bigtableOptions": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", + "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations." + }, + "instanceId": { + "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "projectId": { + "description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { + "description": "Request message for GroundedGenerationService.CheckGrounding method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." + "answerCandidate": { + "description": "Answer candidate to check. Can have a maximum length of 1024 characters.", + "type": "string" }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", - "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + "facts": { + "description": "List of facts for the grounding check. We support up to 200 facts.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" + }, + "type": "array" }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "groundingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", + "description": "Configuration of the grounding check." }, - "parsingConfigOverrides": { + "userLabels": { "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + "type": "string" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { + "description": "Response message for the GroundedGenerationService.CheckGrounding method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "citedChunks": { + "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" + }, + "type": "array" + }, + "claims": { + "description": "Claim texts and citation info across all claims in the answer candidate.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim" + }, + "type": "array" + }, + "supportScore": { + "description": "The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { + "description": "Text and citation info for a claim in the answer candidate.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "citationIndices": { + "description": "A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "claimText": { + "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", + "type": "string" + }, + "endPos": { + "description": "Position indicating the end of the claim in the answer candidate, exclusive.", "format": "int32", "type": "integer" }, - "includeAncestorHeadings": { - "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "groundingCheckRequired": { + "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", - "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "score": { + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].", + "format": "double", + "type": "number" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "startPos": { + "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { + "description": "Specification for the grounding check.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" + "citationThreshold": { + "description": "The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { + "description": "Request for CheckRequirement method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "requirementType": { + "description": "The type specifying the requirement to check. The supported types are: * `discoveryengine.googleapis.com/media_recs/general/all/warning` * `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` * `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` * `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` * `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning`", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "resources": { + "description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id`", + "items": { + "$ref": "GoogleApiMonitoredResource" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1Engine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1Engine", + "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { + "description": "Response for the CheckRequirement method.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "metricResults": { + "description": "Metric results.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" }, "type": "array" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", - "type": "string" - }, - "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], + "oldestMetricTimestamp": { + "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.", + "format": "google-datetime", "type": "string" }, - "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", - "type": "string" + "requirement": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", + "description": "Requirement definition." }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "requirementCondition": { + "$ref": "GoogleTypeExpr", + "description": "The condition for evaluating the requirement result." }, - "solutionType": { - "description": "Required. The solutions of the engine.", + "requirementResult": { + "description": "Requirement result, e.g. pass or fail.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "UNKNOWN", + "SUCCESS", + "FAILURE", + "WARNING" ], "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + "The requirement is unknown.", + "The requirement check is passed.", + "The requirement check fails to meet at least one blocking threshold.", + "The requirement check fails at least one warning threshold, but passes all blocking thresholds." ], "type": "string" - }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." - }, - "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { + "description": "Metric result. The metric are in the requirement_condition.", + "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", "properties": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "metricType": { + "description": "Type identifier of the metric corresponding to this query result.", "type": "string" }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "name": { + "description": "This metric query name is mapping to variables in the requirement_condition.", "type": "string" }, - "location": { - "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "timestamp": { + "description": "Time corresponding to when this metric value was calculated.", + "format": "google-datetime", "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "unit": { + "description": "The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.", "type": "string" + }, + "value": { + "$ref": "GoogleMonitoringV3TypedValue", + "description": "Value of the metric query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaChunk": { + "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", + "id": "GoogleCloudDiscoveryengineV1alphaChunk", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "chunkMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", + "description": "Output only. Metadata of the current chunk.", + "readOnly": true + }, + "content": { + "description": "Content is a string from a document (parsed content).", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", - "properties": { - "companyName": { - "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + }, + "derivedStructData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", + "readOnly": true, + "type": "object" + }, + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "description": "Metadata of the document from the current chunk." + }, + "id": { + "description": "Unique chunk ID of the current chunk.", "type": "string" + }, + "name": { + "description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "pageSpan": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", + "description": "Page span of the chunk." + }, + "relevanceScore": { + "description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.", + "format": "double", + "readOnly": true, + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { + "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "nextChunks": { + "description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" }, "type": "array" }, - "searchTier": { - "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], - "type": "string" + "previousChunks": { + "description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { + "description": "Document metadata contains the information of the document of the current chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", + "type": "object" }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", + "title": { + "description": "Title of the document.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "uri": { + "description": "Uri of the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { - "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { + "description": "Page span of the chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "pageEnd": { + "description": "The end page of the chunk.", + "format": "int32", + "type": "integer" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "pageStart": { + "description": "The start page of the chunk.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { + "description": "Cloud SQL source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "databaseId": { + "description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "instanceId": { + "description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.", "type": "string" }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + "offload": { + "description": "Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).", + "type": "boolean" + }, + "projectId": { + "description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "tableId": { + "description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { - "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { + "description": "Response message for CompletionService.CompleteQuery method.", + "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "querySuggestions": { + "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion" }, "type": "array" + }, + "tailMatchTriggered": { + "description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { + "description": "Suggestions as search queries.", + "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", "properties": { - "gcsPrefix": { - "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.", + "completableFieldPaths": { + "description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.", + "items": { + "type": "string" + }, + "type": "array" + }, + "suggestion": { + "description": "The suggestion for the query.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { + "description": "Detailed completion information including completion attribution token and clicked completion info.", + "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "selectedPosition": { + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "selectedSuggestion": { + "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { + "description": "Autocomplete suggestions that are imported from Customer.", + "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "alternativePhrases": { + "description": "Alternative matching phrases for this suggestion.", "items": { - "$ref": "GoogleRpcStatus" + "type": "string" }, "type": "array" }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", + "frequency": { + "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", "format": "int64", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "globalScore": { + "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", + "format": "double", + "type": "number" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "groupId": { + "description": "If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.", "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "groupScore": { + "description": "The score of this suggestion within its group.", + "format": "double", + "type": "number" + }, + "languageCode": { + "description": "BCP-47 language code of this suggestion.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "suggestion": { + "description": "Required. The suggestion text.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1alphaCondition", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" }, "type": "array" }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "value": { + "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Project": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1Project", + "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, "type": "string" }, - "provisionCompletionTime": { - "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "startTime": { + "description": "Start of time range. Range is inclusive.", "format": "google-datetime", - "readOnly": true, "type": "string" - }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaControl": { + "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", + "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "description": "Defines a boost-type control" + }, + "conditions": { + "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" + }, + "type": "array" + }, + "displayName": { + "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, - "id": { - "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "enumDescriptions": [ - "The default value of the enum. This value is not actually used.", - "The project has given consent to the terms of service.", - "The project is pending to review and accept the terms of service.", - "The project has declined or revoked the agreement to terms of service." + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." ], "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "useCases": { + "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "Value used when unset. Will not occur in CSS.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "dataStore": { + "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "filter": { + "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "dataStore": { + "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", - "type": "boolean" + "filter": { + "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "redirectUri": { + "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { - "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", - "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", - "type": "string" - }, - "purgeSample": { - "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { + "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", + "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "properties": { + "synonyms": { + "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", "items": { "type": "string" }, @@ -8241,198 +11128,184 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaConversation": { + "description": "External conversation proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaConversation", "properties": { - "createTime": { - "description": "Operation create time.", + "endTime": { + "description": "Output only. The time the conversation finished.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", - "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "messages": { + "description": "Conversation messages.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" }, "type": "array" }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", + "type": "string" + }, + "startTime": { + "description": "Output only. The time the conversation started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "The state of the Conversation.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "COMPLETED" + ], + "enumDescriptions": [ + "Unknown.", + "Conversation is currently open.", + "Conversation has been completed." + ], + "type": "string" + }, + "userPseudoId": { + "description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Schema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1Schema", + "GoogleCloudDiscoveryengineV1alphaConversationContext": { + "description": "Defines context of the conversation", + "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", - "type": "string" - }, - "name": { - "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "activeDocument": { + "description": "The current active document the user opened. It contains the document resource reference.", "type": "string" }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "contextDocuments": { + "description": "The current list of documents the user is seeing. It contains the document resource references.", + "items": { + "type": "string" }, - "description": "The structured representation of the schema.", - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "GoogleCloudDiscoveryengineV1alphaConversationMessage": { + "description": "Defines a conversation message.", + "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", - "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" - ], - "enumDescriptions": [ - "Defaults to VERIFIED.", - "Site ownership verified.", - "Site ownership pending verification or verification failed.", - "Site exempt from verification, e.g., a public website that opens to all." - ], - "type": "string" - }, - "verifyTime": { - "description": "Latest site verification time.", + "createTime": { + "description": "Output only. Message creation timestamp.", "format": "google-datetime", + "readOnly": true, "type": "string" + }, + "reply": { + "$ref": "GoogleCloudDiscoveryengineV1alphaReply", + "description": "Search reply." + }, + "userInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", + "description": "User text input." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1TargetSite", + "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { + "description": "Request message for ConversationalSearchService.ConverseConversation method.", + "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", "properties": { - "exactMatch": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, - "type": "string" + "conversation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", + "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." }, - "indexingStatus": { - "description": "Output only. Indexing status.", - "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" - ], - "enumDescriptions": [ - "Defaults to SUCCEEDED.", - "The target site is in the update queue and will be picked up by indexing pipeline.", - "The target site fails to be indexed.", - "The target site has been indexed.", - "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." - ], - "readOnly": true, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" }, - "name": { - "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", - "readOnly": true, - "type": "string" + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", + "description": "Required. Current user input." }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", - "type": "string" + "safeSearch": { + "description": "Whether to turn on safe search.", + "type": "boolean" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + "servingConfig": { + "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", "type": "string" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true - }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", - "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" - ], - "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." - ], - "type": "string" + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "A specification for configuring the summary returned in the response." }, - "updateTime": { - "description": "Output only. The target site's last updated time.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { + "description": "Response message for ConversationalSearchService.ConverseConversation method.", + "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "conversation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", + "description": "Updated conversation including the answer." + }, + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" + }, + "reply": { + "$ref": "GoogleCloudDiscoveryengineV1alphaReply", + "description": "Answer to the current query." + }, + "searchResults": { + "description": "Search Results.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8447,9 +11320,15 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8464,1893 +11343,1799 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAclConfig": { - "description": "Access Control Configuration.", - "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Identity provider config." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "name": { - "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAlloyDbSource": { - "description": "AlloyDB source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { + "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", "properties": { - "clusterId": { - "description": "Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters.", - "type": "string" - }, - "databaseId": { - "description": "Required. The AlloyDB database to copy the data from with a length limit of 256 characters.", - "type": "string" - }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", - "type": "string" - }, - "locationId": { - "description": "Required. The AlloyDB location to copy the data from with a length limit of 256 characters.", - "type": "string" - }, - "projectId": { - "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "parent": { + "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", "type": "string" }, - "tableId": { - "description": "Required. The AlloyDB table to copy the data from with a length limit of 256 characters.", - "type": "string" + "targetSite": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite", + "description": "Required. The TargetSite to create." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswer": { - "description": "Defines an answer.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswer", + "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { + "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", "properties": { - "answerSkippedReasons": { - "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", - "items": { - "enum": [ - "ANSWER_SKIPPED_REASON_UNSPECIFIED", - "ADVERSARIAL_QUERY_IGNORED", - "NON_ANSWER_SEEKING_QUERY_IGNORED", - "OUT_OF_DOMAIN_QUERY_IGNORED", - "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" - ], - "enumDescriptions": [ - "Default value. The answer skipped reason is not specified.", - "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", - "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", - "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." - ], - "type": "string" - }, - "type": "array" - }, - "answerText": { - "description": "The textual answer.", - "type": "string" - }, - "citations": { - "description": "Citations.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" - }, - "type": "array" - }, - "completeTime": { - "description": "Output only. Answer completed timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "createTime": { - "description": "Output only. Answer creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", - "type": "string" - }, - "queryUnderstandingInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", - "description": "Query understanding information." - }, - "references": { - "description": "References.", + "numbers": { + "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" + "format": "double", + "type": "number" }, "type": "array" }, - "relatedQuestions": { - "description": "Suggested related questions.", + "text": { + "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { "type": "string" }, "type": "array" - }, - "state": { - "description": "The state of the answer generation.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" - ], - "enumDescriptions": [ - "Unknown.", - "Answer generation is currently in progress.", - "Answer generation currently failed.", - "Answer generation has succeeded." - ], - "type": "string" - }, - "steps": { - "description": "Answer generation steps.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", - "type": "string" - }, - "sources": { - "description": "Citation sources for the attributed segment.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" - }, - "type": "array" - }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", - "format": "int64", - "type": "string" + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", + "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "properties": { - "referenceId": { - "description": "ID of the citation source.", + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest": { - "description": "Request message for ConversationalSearchService.AnswerQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest", - "properties": { - "answerGenerationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", - "description": "Answer generation specification." - }, - "asynchronousMode": { - "description": "Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.", - "type": "boolean" - }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "Required. Current user query." - }, - "queryUnderstandingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", - "description": "Query understanding specification." }, - "relatedQuestionsSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", - "description": "Related questions specification." + "displayName": { + "description": "The display name of the model.", + "type": "string" }, - "safetySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", - "description": "Model specification." + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" }, - "searchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", - "description": "Search specification." + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" + ], + "enumDescriptions": [ + "Default value.", + "The model is in a paused training state.", + "The model is currently training.", + "The model has successfully completed training.", + "The model is ready for serving.", + "The model training failed.", + "The model training finished successfully but metrics did not improve." + ], + "type": "string" }, - "session": { - "description": "The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned.", + "modelVersion": { + "description": "The version of the model.", + "format": "int64", "type": "string" }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", - "type": "object" + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "type": "string" }, - "userPseudoId": { - "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec": { - "description": "Answer generation specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpec", + "GoogleCloudDiscoveryengineV1alphaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { - "answerLanguageCode": { - "description": "Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", + "aclEnabled": { + "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", + "type": "boolean" + }, + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + ], "type": "string" }, - "ignoreAdversarialQuery": { - "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead.", - "type": "boolean" + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "ignoreLowRelevantContent": { - "description": "Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service.", - "type": "boolean" + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "type": "string" }, - "ignoreNonAnswerSeekingQuery": { - "description": "Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead.", - "type": "boolean" + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" }, - "includeCitations": { - "description": "Specifies whether to include citation metadata in the answer. The default value is `false`.", - "type": "boolean" + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", - "description": "Answer generation model specification." + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Output only. Data store level identity provider config.", + "readOnly": true }, - "promptSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", - "description": "Answer generation prompt specification." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec": { - "description": "Answer Generation Model specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecModelSpec", - "properties": { - "modelVersion": { - "description": "Model version. If not set, it will use the default stable model. Allowed values are: stable, preview.", + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec": { - "description": "Answer generation prompt specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestAnswerGenerationSpecPromptSpec", - "properties": { - "preamble": { - "description": "Customized preamble.", + }, + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "description": "Language info for DataStore." + }, + "name": { + "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" + }, + "solutionTypes": { + "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec": { - "description": "Query understanding specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpec", + "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { - "queryClassificationSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", - "description": "Query classification specification." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "queryRephraserSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", - "description": "Query rephraser specification." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec": { - "description": "Query classification specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec", + "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { - "types": { - "description": "Enabled query classification types.", - "items": { - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type." - ], - "type": "string" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec": { - "description": "Query rephraser specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec", + "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { - "disable": { - "description": "Disable query rephraser.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "maxRephraseSteps": { - "description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.", - "format": "int32", - "type": "integer" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec": { - "description": "Related questions specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestRelatedQuestionsSpec", + "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { - "enable": { - "description": "Enable related questions feature if true.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec": { - "description": "Safety specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSafetySpec", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", "properties": { - "enable": { - "description": "Enable the safety filtering on the answer response. It is false by default.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec": { - "description": "Search specification.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpec", - "properties": { - "searchParams": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", - "description": "Search parameters." - }, - "searchResultList": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", - "description": "Search result list." - } - }, + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest": { + "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams": { - "description": "Search parameters.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchParams", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaDocument", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "description": "Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" + "aclInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", + "description": "Access control information for the document." }, - "customFineTuningSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "description": "Custom fine tuning configs." + "content": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentContent", + "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." }, - "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + "derivedStructData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", + "readOnly": true, + "type": "object" }, - "filter": { - "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "id": { + "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" }, - "maxReturnResults": { - "description": "Number of search results to return. The default value is 10.", - "format": "int32", - "type": "integer" + "indexTime": { + "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "jsonData": { + "description": "The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", "type": "string" }, - "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", - "enum": [ - "SEARCH_RESULT_MODE_UNSPECIFIED", - "DOCUMENTS", - "CHUNKS" - ], - "enumDescriptions": [ - "Default value.", - "Returns documents in the search result.", - "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." - ], + "name": { + "description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "parentDocumentId": { + "description": "The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", "type": "string" + }, + "schemaId": { + "description": "The identifier of the schema located in the same data store.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList": { - "description": "Search result list.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultList", + "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { + "description": "ACL Information of the Document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", "properties": { - "searchResults": { - "description": "Search results.", + "readers": { + "description": "Readers of the document.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult": { - "description": "Search result.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResult", + "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction": { + "description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", - "description": "Chunk information." + "idpWide": { + "description": "All users within the Identity Provider.", + "type": "boolean" }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", - "description": "Unstructured document information." + "principals": { + "description": "List of principals.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo", + "GoogleCloudDiscoveryengineV1alphaDocumentContent": { + "description": "Unstructured data linked to this document.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", "properties": { - "chunk": { - "description": "Chunk resource name.", + "mimeType": { + "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.", "type": "string" }, - "content": { - "description": "Chunk textual content.", + "rawBytes": { + "description": "The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.", + "format": "byte", + "type": "string" + }, + "uri": { + "description": "The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { + "description": "Detailed document information associated with a user event.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", "properties": { - "document": { - "description": "Document resource name.", + "id": { + "description": "The Document resource ID.", "type": "string" }, - "documentContexts": { - "description": "List of document contexts.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext" - }, - "type": "array" + "joined": { + "description": "Output only. Whether the referenced Document can be found in the data store.", + "readOnly": true, + "type": "boolean" }, - "extractiveAnswers": { - "description": "List of extractive answers.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer" - }, - "type": "array" + "name": { + "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", + "type": "string" }, - "extractiveSegments": { - "description": "List of extractive segments.", + "promotionIds": { + "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment" + "type": "string" }, "type": "array" }, - "title": { - "description": "Title.", - "type": "string" + "quantity": { + "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", + "format": "int32", + "type": "integer" }, "uri": { - "description": "URI for the document.", + "description": "The Document URI - only allowed for website data stores.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext": { - "description": "Document context.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { - "content": { - "description": "Document content.", - "type": "string" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "pageIdentifier": { - "description": "Page identifier.", + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" + }, + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer": { - "description": "Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers)", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "properties": { - "content": { - "description": "Extractive answer content.", - "type": "string" - }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment": { - "description": "Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { - "content": { - "description": "Extractive segment content.", - "type": "string" + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse": { - "description": "Response message for ConversationalSearchService.AnswerQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { - "answer": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", - "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." }, - "answerQueryToken": { - "description": "A global unique ID used for logging.", - "type": "string" + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." }, - "session": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession", - "description": "Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request." + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { - "description": "Query understanding information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { - "queryClassificationInfo": { - "description": "Query classification information.", + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" + "type": "string" }, "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { - "description": "Query classification information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", + "GoogleCloudDiscoveryengineV1alphaDoubleList": { + "description": "Double list.", + "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", "properties": { - "positive": { - "description": "Classification output.", - "type": "boolean" - }, - "type": { - "description": "Query classification type.", - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type." - ], - "type": "string" + "values": { + "description": "Double values.", + "items": { + "format": "double", + "type": "number" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReference": { - "description": "Reference.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", + "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { + "description": "Defines embedding config, used for bring your own embeddings feature.", + "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", - "description": "Chunk information." - }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", - "description": "Unstructured document information." + "fieldPath": { + "description": "Full field path in the schema mapped as embedding field.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { - "chunk": { - "description": "Chunk resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "content": { - "description": "Chunk textual content.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", - "description": "Document metadata." - }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { - "description": "Document metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest": { + "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { - "document": { - "description": "Document resource name.", - "type": "string" + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", - "type": "object" + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." }, - "title": { - "description": "Title.", + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "uri": { - "description": "URI for the document.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", - "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", + "dataStoreIds": { + "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" + "type": "string" }, "type": "array" }, - "document": { - "description": "Document resource name.", + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", - "type": "object" + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" }, - "title": { - "description": "Title.", + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." + }, + "name": { + "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, - "uri": { - "description": "URI for the document.", + "recommendationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", + "readOnly": true + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "similarDocumentsConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "description": "Additional config specs for a `similar-items` engine." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", + }, + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "properties": { - "content": { - "description": "Chunk textual content.", - "type": "string" + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, - "pageIdentifier": { - "description": "Page identifier.", + "dialogflowAgentToLink": { + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStep": { - "description": "Step information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { - "actions": { - "description": "Actions.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" - }, - "type": "array" + "business": { + "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "type": "string" }, - "description": { - "description": "The description of the step.", + "defaultLanguageCode": { + "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" }, - "state": { - "description": "The state of the step.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" - ], - "enumDescriptions": [ - "Unknown.", - "Step is currently in progress.", - "Step currently failed.", - "Step has succeeded." - ], + "location": { + "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", "type": "string" }, - "thought": { - "description": "The thought of the step.", + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { - "description": "Action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { - "observation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "description": "Observation." - }, - "searchAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", - "description": "Search action." + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { - "description": "Observation.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "properties": { - "searchResults": { - "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" - }, - "type": "array" + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { - "chunkInfo": { - "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" - }, - "type": "array" - }, - "document": { - "description": "Document resource name.", + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", "type": "string" }, - "snippetInfo": { - "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" - }, - "type": "array" + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." }, - "title": { - "description": "Title.", + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], "type": "string" }, - "uri": { - "description": "URI for the document.", + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { - "chunk": { - "description": "Chunk resource name.", - "type": "string" - }, - "content": { - "description": "Chunk textual content.", + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, - "relevanceScore": { - "description": "Relevance score.", + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", "format": "float", "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { - "description": "Snippet information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", + "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { + "description": "Additional information of a recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { - "snippet": { - "description": "Snippet content.", + "dataState": { + "description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", + "enum": [ + "DATA_STATE_UNSPECIFIED", + "DATA_OK", + "DATA_ERROR" + ], + "enumDescriptions": [ + "Unspecified default value, should never be explicitly set.", + "The engine has sufficient training data.", + "The engine does not have sufficient training data. Error messages can be queried via Stackdriver." + ], + "readOnly": true, "type": "string" }, - "snippetStatus": { - "description": "Status of the snippet defined by the search team.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { - "description": "Search action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", - "properties": { - "query": { - "description": "The query to search.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", + "lastTuneTime": { + "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "servingState": { + "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", + "enum": [ + "SERVING_STATE_UNSPECIFIED", + "INACTIVE", + "ACTIVE", + "TUNED" + ], + "enumDescriptions": [ + "Unspecified serving state.", + "The engine is not serving.", + "The engine is serving and can be queried.", + "The engine is trained on tuned hyperparameters and can be queried." + ], + "readOnly": true, + "type": "string" + }, + "tuningOperation": { + "description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest", - "properties": { - "requests": { - "description": "Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { - "targetSites": { - "description": "TargetSites created.", + "searchAddOns": { + "description": "The add-on that this search engine enables.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" }, "type": "array" + }, + "searchTier": { + "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest": { - "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest", + "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { + "description": "Additional config specs for a `similar-items` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigQuerySource": { - "description": "BigQuery source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { + "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", "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 to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.", - "type": "string" - }, - "datasetId": { - "description": "Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.", - "type": "string" - }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.", - "type": "string" - }, - "partitionDate": { - "$ref": "GoogleTypeDate", - "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." - }, - "projectId": { - "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", - "type": "string" - }, - "tableId": { - "description": "Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptions": { - "description": "The Bigtable Options object that contains information to support the import.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { + "description": "Request message for EstimateBillingService.EstimateDataSize method", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", "properties": { - "families": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily" - }, - "description": "The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.", - "type": "object" + "fileDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", + "description": "Structured or unstructured data." }, - "keyFieldName": { - "description": "The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`.", - "type": "string" + "websiteDataSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", + "description": "Website data." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn": { - "description": "The column of the Bigtable.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { + "description": "Data source contains files either in Cloud Storage or BigQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", "properties": { - "encoding": { - "description": "The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.", - "enum": [ - "ENCODING_UNSPECIFIED", - "TEXT", - "BINARY" - ], - "enumDescriptions": [ - "The encoding is unspecified.", - "Text encoding.", - "Binary encoding." - ], - "type": "string" - }, - "fieldName": { - "description": "The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.", - "type": "string" - }, - "qualifier": { - "description": "Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.", - "format": "byte", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "type": { - "description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.", - "enum": [ - "TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "INTEGER", - "VAR_INTEGER", - "BIG_NUMERIC", - "BOOLEAN", - "JSON" - ], - "enumDescriptions": [ - "The type is unspecified.", - "String type.", - "Numerical type.", - "Integer type.", - "Variable length integer type.", - "BigDecimal type.", - "Boolean type.", - "JSON type." - ], - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily": { - "description": "The column family of the Bigtable.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumnFamily", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { + "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", "properties": { - "columns": { - "description": "The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.", + "estimatorUriPatterns": { + "description": "Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptionsBigtableColumn" + "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { + "description": "URI patterns that we use to crawl.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", + "properties": { + "exactMatch": { + "description": "Whether we infer the generated URI or use the exact provided one.", + "type": "boolean" }, - "encoding": { - "description": "The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.", - "enum": [ - "ENCODING_UNSPECIFIED", - "TEXT", - "BINARY" - ], - "enumDescriptions": [ - "The encoding is unspecified.", - "Text encoding.", - "Binary encoding." - ], - "type": "string" - }, - "fieldName": { - "description": "The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.", - "type": "string" + "exclusive": { + "description": "Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.", + "type": "boolean" }, - "type": { - "description": "The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.", - "enum": [ - "TYPE_UNSPECIFIED", - "STRING", - "NUMBER", - "INTEGER", - "VAR_INTEGER", - "BIG_NUMERIC", - "BOOLEAN", - "JSON" - ], - "enumDescriptions": [ - "The type is unspecified.", - "String type.", - "Numerical type.", - "Integer type.", - "Variable length integer type.", - "BigDecimal type.", - "Boolean type.", - "JSON type." - ], + "providedUriPattern": { + "description": "User provided URI pattern. For example, `foo.com/bar/*`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBigtableSource": { - "description": "The Cloud Bigtable source for importing data.", - "id": "GoogleCloudDiscoveryengineV1alphaBigtableSource", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { + "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { - "bigtableOptions": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableOptions", - "description": "Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations." - }, - "instanceId": { - "description": "Required. The instance ID of the Cloud Bigtable that needs to be imported.", - "type": "string" - }, - "projectId": { - "description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "dataSizeBytes": { + "description": "Data size in terms of bytes.", + "format": "int64", "type": "string" }, - "tableId": { - "description": "Required. The table ID of the Cloud Bigtable that needs to be imported.", + "documentCount": { + "description": "Total number of documents.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest": { - "description": "Request message for GroundedGenerationService.CheckGrounding method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest", + "GoogleCloudDiscoveryengineV1alphaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "properties": { - "answerCandidate": { - "description": "Answer candidate to check. Can have a maximum length of 1024 characters.", + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "facts": { - "description": "List of facts for the grounding check. We support up to 200 facts.", + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGroundingFact" + "$ref": "GoogleRpcStatus" }, + "readOnly": true, "type": "array" }, - "groundingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", - "description": "Configuration of the grounding check." + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", - "type": "object" + "name": { + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." + ], + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse": { - "description": "Response message for the GroundedGenerationService.CheckGrounding method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { - "citedChunks": { - "description": "List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFactChunk" - }, - "type": "array" - }, - "claims": { - "description": "Claim texts and citation info across all claims in the answer candidate.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim" - }, - "type": "array" + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "supportScore": { - "description": "The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.", - "format": "float", - "type": "number" + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim": { - "description": "Text and citation info for a claim in the answer candidate.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingResponseClaim", + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "properties": { - "citationIndices": { - "description": "A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.", - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "claimText": { - "description": "Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.", + "sampleQuerySet": { + "description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaFactChunk": { + "description": "Fact Chunk.", + "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", + "properties": { + "chunkText": { + "description": "Text content of the fact chunk. Can be at most 10K characters long.", "type": "string" }, - "endPos": { - "description": "Position indicating the end of the claim in the answer candidate, exclusive.", + "index": { + "description": "The index of this chunk. Currently, only used for the streaming mode.", "format": "int32", "type": "integer" }, - "groundingCheckRequired": { - "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", - "type": "boolean" + "source": { + "description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.", + "type": "string" }, - "startPos": { - "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", - "format": "int32", - "type": "integer" + "sourceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "More fine-grained information for the source reference.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec": { - "description": "Specification for the grounding check.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec", + "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { + "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", + "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", "properties": { - "citationThreshold": { - "description": "The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.", - "format": "double", - "type": "number" + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "targetSites": { + "description": "List of TargetSites containing the site verification status.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + }, + "type": "array" + }, + "totalSize": { + "description": "The total number of items matching the request. This will always be populated in the response.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest": { - "description": "Request for CheckRequirement method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest", + "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { + "description": "Cloud FhirStore source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", "properties": { - "requirementType": { - "description": "The type specifying the requirement to check. The supported types are: * `discoveryengine.googleapis.com/media_recs/general/all/warning` * `discoveryengine.googleapis.com/media_recs/oyml/cvr/warning` * `discoveryengine.googleapis.com/media_recs/rfy/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mlt/cvr/warning` * `discoveryengine.googleapis.com/media_recs/mp/cvr/warning` * `discoveryengine.googleapis.com/media_recs/oyml/wdps/warning` * `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning`", + "fhirStore": { + "description": "Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.", "type": "string" }, - "resources": { - "description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`", + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.", + "type": "string" + }, + "resourceTypes": { + "description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.", "items": { - "$ref": "GoogleApiMonitoredResource" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse": { - "description": "Response for the CheckRequirement method.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse", + "GoogleCloudDiscoveryengineV1alphaFieldConfig": { + "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", + "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "properties": { - "metricResults": { - "description": "Metric results.", + "advancedSiteSearchDataSources": { + "description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult" + "enum": [ + "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", + "METATAGS", + "PAGEMAP", + "URI_PATTERN_MAPPING", + "SCHEMA_ORG" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrieve value from meta tag.", + "Retrieve value from page map.", + "Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API.", + "Retrieve value from schema.org data." + ], + "type": "string" }, "type": "array" }, - "oldestMetricTimestamp": { - "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.", - "format": "google-datetime", + "completableOption": { + "description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "COMPLETABLE_OPTION_UNSPECIFIED", + "COMPLETABLE_ENABLED", + "COMPLETABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Completable option enabled for a schema field.", + "Completable option disabled for a schema field." + ], "type": "string" }, - "requirement": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirement", - "description": "Requirement definition." + "dynamicFacetableOption": { + "description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", + "DYNAMIC_FACETABLE_ENABLED", + "DYNAMIC_FACETABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Dynamic facetable option enabled for a schema field.", + "Dynamic facetable option disabled for a schema field." + ], + "type": "string" }, - "requirementCondition": { - "$ref": "GoogleTypeExpr", - "description": "The condition for evaluating the requirement result." + "fieldPath": { + "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", + "type": "string" }, - "requirementResult": { - "description": "Requirement result, e.g. pass or fail.", + "fieldType": { + "description": "Output only. Raw type of the field.", "enum": [ - "UNKNOWN", - "SUCCESS", - "FAILURE", - "WARNING" + "FIELD_TYPE_UNSPECIFIED", + "OBJECT", + "STRING", + "NUMBER", + "INTEGER", + "BOOLEAN", + "GEOLOCATION", + "DATETIME" + ], + "enumDescriptions": [ + "Field type is unspecified.", + "Field value type is Object.", + "Field value type is String.", + "Field value type is Number.", + "Field value type is Integer.", + "Field value type is Boolean.", + "Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", + "Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" + ], + "readOnly": true, + "type": "string" + }, + "indexableOption": { + "description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "INDEXABLE_OPTION_UNSPECIFIED", + "INDEXABLE_ENABLED", + "INDEXABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Indexable option enabled for a schema field.", + "Indexable option disabled for a schema field." + ], + "type": "string" + }, + "keyPropertyType": { + "description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", + "readOnly": true, + "type": "string" + }, + "recsFilterableOption": { + "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", + "enum": [ + "FILTERABLE_OPTION_UNSPECIFIED", + "FILTERABLE_ENABLED", + "FILTERABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Filterable option enabled for a schema field.", + "Filterable option disabled for a schema field." + ], + "type": "string" + }, + "retrievableOption": { + "description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "RETRIEVABLE_OPTION_UNSPECIFIED", + "RETRIEVABLE_ENABLED", + "RETRIEVABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrievable option enabled for a schema field.", + "Retrievable option disabled for a schema field." + ], + "type": "string" + }, + "schemaOrgPaths": { + "description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", + "items": { + "type": "string" + }, + "type": "array" + }, + "searchableOption": { + "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "SEARCHABLE_OPTION_UNSPECIFIED", + "SEARCHABLE_ENABLED", + "SEARCHABLE_DISABLED" ], "enumDescriptions": [ - "The requirement is unknown.", - "The requirement check is passed.", - "The requirement check fails to meet at least one blocking threshold.", - "The requirement check fails at least one warning threshold, but passes all blocking thresholds." + "Value used when unset.", + "Searchable option enabled for a schema field.", + "Searchable option disabled for a schema field." ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult": { - "description": "Metric result. The metric are in the requirement_condition.", - "id": "GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult", + "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { + "description": "Firestore source import data from.", + "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", "properties": { - "metricType": { - "description": "Type identifier of the metric corresponding to this query result.", + "collectionId": { + "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", "type": "string" }, - "name": { - "description": "This metric query name is mapping to variables in the requirement_condition.", + "databaseId": { + "description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.", "type": "string" }, - "timestamp": { - "description": "Time corresponding to when this metric value was calculated.", - "format": "google-datetime", + "gcsStagingDir": { + "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", "type": "string" }, - "unit": { - "description": "The unit in which this metric is reported. Follows [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard.", + "projectId": { + "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" - }, - "value": { - "$ref": "GoogleMonitoringV3TypedValue", - "description": "Value of the metric query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunk": { - "description": "Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.", - "id": "GoogleCloudDiscoveryengineV1alphaChunk", + "GoogleCloudDiscoveryengineV1alphaGcsSource": { + "description": "Cloud Storage location for input content.", + "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", "properties": { - "chunkMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", - "description": "Output only. Metadata of the current chunk.", - "readOnly": true - }, - "content": { - "description": "Content is a string from a document (parsed content).", - "type": "string" - }, - "derivedStructData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", - "readOnly": true, - "type": "object" - }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", - "description": "Metadata of the document from the current chunk." - }, - "id": { - "description": "Unique chunk ID of the current chunk.", - "type": "string" - }, - "name": { - "description": "The full resource name of the chunk. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "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` 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 the GENERIC Data Store vertical. * `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 the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.", "type": "string" }, - "pageSpan": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", - "description": "Page span of the chunk." - }, - "relevanceScore": { - "description": "Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse.", - "format": "double", - "readOnly": true, - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata": { - "description": "Metadata of the current chunk. This field is only populated on SearchService.Search API.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata", - "properties": { - "nextChunks": { - "description": "The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" - }, - "type": "array" - }, - "previousChunks": { - "description": "The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API.", + "inputUris": { + "description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata": { - "description": "Document metadata contains the information of the document of the current chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "properties": { - "structData": { + "documentDataMap": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, - "description": "Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", + "description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", "type": "object" - }, - "title": { - "description": "Title of the document.", - "type": "string" - }, - "uri": { - "description": "Uri of the document.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaChunkPageSpan": { - "description": "Page span of the chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaChunkPageSpan", - "properties": { - "pageEnd": { - "description": "The end page of the chunk.", - "format": "int32", - "type": "integer" - }, - "pageStart": { - "description": "The start page of the chunk.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCloudSqlSource": { - "description": "Cloud SQL source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", + "GoogleCloudDiscoveryengineV1alphaGroundingFact": { + "description": "Grounding Fact.", + "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", "properties": { - "databaseId": { - "description": "Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.", - "type": "string" - }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", - "type": "string" - }, - "instanceId": { - "description": "Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.", - "type": "string" - }, - "offload": { - "description": "Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless).", - "type": "boolean" - }, - "projectId": { - "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", - "type": "string" + "attributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.", + "type": "object" }, - "tableId": { - "description": "Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.", + "factText": { + "description": "Text content of the fact. Can be at most 10K characters long.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse": { - "description": "Response message for CompletionService.CompleteQuery method.", - "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse", + "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { + "description": "Defines guided search spec.", + "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", "properties": { - "querySuggestions": { - "description": "Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion" - }, - "type": "array" + "enableRefinementAttributes": { + "description": "Whether or not to enable and include refinement attributes in gudied search result.", + "type": "boolean" }, - "tailMatchTriggered": { - "description": "True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.", + "enableRelatedQuestions": { + "description": "Whether or not to enable and include related questions in search response.", "type": "boolean" + }, + "maxRelatedQuestions": { + "description": "Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion": { - "description": "Suggestions as search queries.", - "id": "GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion", + "GoogleCloudDiscoveryengineV1alphaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "properties": { - "completableFieldPaths": { - "description": "The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model.", - "items": { - "type": "string" - }, - "type": "array" + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." }, - "suggestion": { - "description": "The suggestion for the query.", + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompletionInfo": { - "description": "Detailed completion information including completion attribution token and clicked completion info.", - "id": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", + "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "properties": { - "selectedPosition": { - "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.", - "format": "int32", - "type": "integer" - }, - "selectedSuggestion": { - "description": "End user selected CompleteQueryResponse.QuerySuggestion.suggestion.", + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion": { - "description": "Autocomplete suggestions that are imported from Customer.", - "id": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { - "alternativePhrases": { - "description": "Alternative matching phrases for this suggestion.", - "items": { - "type": "string" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "frequency": { - "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.", + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", "format": "int64", "type": "string" }, - "globalScore": { - "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked.", - "format": "double", - "type": "number" + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" }, - "groupId": { - "description": "If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { + "description": "Request message for CompletionService.ImportCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "groupScore": { - "description": "The score of this suggestion within its group.", - "format": "double", - "type": "number" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "languageCode": { - "description": "BCP-47 language code of this suggestion.", - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." }, - "suggestion": { - "description": "Required. The suggestion text.", - "type": "string" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", + "description": "The Inline source for suggestion entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1alphaCondition", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { + "description": "The inline source for CompletionSuggestions.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" - }, - "type": "array" - }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "suggestions": { + "description": "Required. A list of all denylist entries to import. Max of 1000 items.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { + "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "value": { - "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControl": { - "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", - "id": "GoogleCloudDiscoveryengineV1alphaControl", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { + "description": "Request message for Import methods.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", - "description": "Defines a boost-type control" + "alloyDbSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", + "description": "AlloyDB input source." }, - "conditions": { - "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" - }, - "type": "array" + "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, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", + "type": "boolean" }, - "displayName": { - "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "bigtableSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource", + "description": "Cloud Bigtable input source." }, - "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", - "type": "string" + "cloudSqlSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", + "description": "Cloud SQL input source." }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", - "description": "Defines a redirect-type control." + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" + "fhirStoreSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", + "description": "FhirStore input source." }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "firestoreSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", + "description": "Firestore input source." }, - "useCases": { - "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "enumDescriptions": [ - "Value used when unset. Will not occur in CSS.", - "Search use case. Expects the traffic has a non-empty query.", - "Browse use case. Expects the traffic has an empty query." - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", - "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." }, - "dataStore": { - "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "idField": { + "description": "The field indicates the ID field or column to be used as 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 others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table 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 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. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", "type": "string" }, - "filter": { - "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", - "properties": { - "dataStore": { - "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", + "description": "The Inline source for the input content for documents." + }, + "reconciliationMode": { + "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", + "enum": [ + "RECONCILIATION_MODE_UNSPECIFIED", + "INCREMENTAL", + "FULL" + ], + "enumDescriptions": [ + "Defaults to `INCREMENTAL`.", + "Inserts new documents or updates existing documents.", + "Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location." + ], "type": "string" }, - "filter": { - "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", - "properties": { - "redirectUri": { - "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "spannerSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource", + "description": "Spanner input source." + }, + "updateMask": { + "description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.", + "format": "google-fieldmask", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { - "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", - "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { + "description": "The inline source for the input config for ImportDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", "properties": { - "synonyms": { - "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "documents": { + "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversation": { - "description": "External conversation proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaConversation", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { + "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { - "endTime": { - "description": "Output only. The time the conversation finished.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." }, - "messages": { - "description": "Conversation messages.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversationMessage" + "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.", - "type": "string" - }, - "startTime": { - "description": "Output only. The time the conversation started.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "The state of the Conversation.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "COMPLETED" - ], - "enumDescriptions": [ - "Unknown.", - "Conversation is currently open.", - "Conversation has been completed." - ], - "type": "string" - }, - "userPseudoId": { - "description": "A unique identifier for tracking users.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversationContext": { - "description": "Defines context of the conversation", - "id": "GoogleCloudDiscoveryengineV1alphaConversationContext", + "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { - "activeDocument": { - "description": "The current active document the user opened. It contains the document resource reference.", + "gcsPrefix": { + "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" - }, - "contextDocuments": { - "description": "The current list of documents the user is seeing. It contains the document resource references.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConversationMessage": { - "description": "Defines a conversation message.", - "id": "GoogleCloudDiscoveryengineV1alphaConversationMessage", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { "createTime": { - "description": "Output only. Message creation timestamp.", + "description": "ImportSampleQueries operation create time.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "reply": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReply", - "description": "Search reply." + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" }, - "userInput": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", - "description": "User text input." + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest": { - "description": "Request message for ConversationalSearchService.ConverseConversation method.", - "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationRequest", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { + "description": "Request message for SampleQueryService.ImportSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "description": "Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)" - }, - "conversation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", - "description": "The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session." - }, - "filter": { - "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", - "type": "string" - }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTextInput", - "description": "Required. Current user input." - }, - "safeSearch": { - "description": "Whether to turn on safe search.", - "type": "boolean" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "servingConfig": { - "description": "The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", - "description": "A specification for configuring the summary returned in the response." + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", - "type": "object" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", + "description": "The Inline source for sample query entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse": { - "description": "Response message for ConversationalSearchService.ConverseConversation method.", - "id": "GoogleCloudDiscoveryengineV1alphaConverseConversationResponse", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { + "description": "The inline source for SampleQuerys.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "properties": { - "conversation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation", - "description": "Updated conversation including the answer." - }, - "relatedQuestions": { - "description": "Suggested related questions.", + "sampleQueries": { + "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { + "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "reply": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReply", - "description": "Answer to the current query." - }, - "searchResults": { - "description": "Search Results.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -10365,49 +13150,78 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { + "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", + "description": "The Inline source for the input content for suggestion deny list entries." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { + "description": "The inline source for SuggestionDenyListEntry.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "entries": { + "description": "Required. A list of all denylist entries to import. Max of 1000 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -10416,4013 +13230,3776 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest": { - "description": "Request message for SiteSearchEngineService.CreateTargetSite method.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteRequest", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { + "description": "Request message for the ImportUserEvents request.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", "properties": { - "parent": { - "description": "Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.", - "type": "string" + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", + "description": "BigQuery input source." }, - "targetSite": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite", - "description": "Required. The TargetSite to create." + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports." + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", + "description": "The Inline source for the input content for UserEvents." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCustomAttribute": { - "description": "A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomAttribute", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { + "description": "The inline source for the input config for ImportUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", "properties": { - "numbers": { - "description": "The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is \"lengths_cm\". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", - "items": { - "format": "double", - "type": "number" - }, - "type": "array" - }, - "text": { - "description": "The textual values of this custom attribute. For example, `[\"yellow\", \"green\"]` when the key is \"color\". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "userEvents": { + "description": "Required. A list of user events to import. Recommended max of 10k items.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { - "description": "Defines custom fine tuning spec.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "properties": { - "enableSearchAdaptor": { - "description": "Whether or not to enable and include custom fine tuned search adaptor model.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", + "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the model.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", - "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" - ], - "enumDescriptions": [ - "Default value.", - "The model is in a paused training state.", - "The model is currently training.", - "The model has successfully completed training.", - "The model is ready for serving.", - "The model training failed." - ], - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "modelVersion": { - "description": "The version of the model.", + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", "format": "int64", "type": "string" }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", - "type": "string" - }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStore", + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { - "aclEnabled": { - "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", - "type": "boolean" - }, - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search." - ], - "type": "string" - }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, - "type": "string" - }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", - "type": "string" - }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Output only. Data store level identity provider config.", - "readOnly": true - }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], - "type": "string" - }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", - "description": "Language info for DataStore." - }, - "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", - "type": "string" + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" }, - "solutionTypes": { - "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" - }, - "type": "array" + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", - "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "language": { + "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "languageCode": { + "description": "The language code for the DataStore.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "normalizedLanguageCode": { + "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "region": { + "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { + "description": "Response message for ChunkService.ListChunks method.", + "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "chunks": { + "description": "The Chunks.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "nextPageToken": { + "description": "A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { + "description": "Response for ListControls method.", + "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "controls": { + "description": "All the Controls for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControl" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest": { - "description": "Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocument": { - "description": "Document captures all raw metadata information of items to be recommended or searched.", - "id": "GoogleCloudDiscoveryengineV1alphaDocument", + "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { + "description": "Response for ListConversations method.", + "id": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse", "properties": { - "aclInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", - "description": "Access control information for the document." - }, - "content": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentContent", - "description": "The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store." - }, - "derivedStructData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "conversations": { + "description": "All the Conversations for a given data store.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" }, - "description": "Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.", - "readOnly": true, - "type": "object" - }, - "id": { - "description": "Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", - "type": "string" - }, - "indexTime": { - "description": "Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "jsonData": { - "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": { - "description": "Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", - "type": "string" - }, - "parentDocumentId": { - "description": "The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.", - "type": "string" + "type": "array" }, - "schemaId": { - "description": "The identifier of the schema located in the same data store.", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" - }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.", - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo": { - "description": "ACL Information of the Document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfo", + "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { - "readers": { - "description": "Readers of the document.", + "models": { + "description": "List of custom tuning models.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction" + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction": { - "description": "AclRestriction to model complex inheritance restrictions. Example: Modeling a \"Both Permit\" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ] } ] } } Page_P ACL Restriction. { \"acl_info\": { \"readers\": [ { \"principals\": [ { \"group_id\": \"group_2\" }, { \"group_id\": \"group_3\" }, { \"user_id\": \"user_2\" } ], }, { \"principals\": [ { \"group_id\": \"group_1\" }, { \"user_id\": \"user_1\" } ], } ] } }", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction", + "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { + "description": "Response message for DataStoreService.ListDataStores method.", + "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", "properties": { - "principals": { - "description": "List of principals.", + "dataStores": { + "description": "All the customer's DataStores.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPrincipal" + "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentContent": { - "description": "Unstructured data linked to this document.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentContent", - "properties": { - "mimeType": { - "description": "The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.", - "type": "string" - }, - "rawBytes": { - "description": "The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.", - "format": "byte", - "type": "string" }, - "uri": { - "description": "The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.", + "nextPageToken": { + "description": "A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentInfo": { - "description": "Detailed document information associated with a user event.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { + "description": "Response message for DocumentService.ListDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", "properties": { - "id": { - "description": "The Document resource ID.", - "type": "string" - }, - "name": { - "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", - "type": "string" - }, - "promotionIds": { - "description": "The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.", + "documents": { + "description": "The Documents.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" }, "type": "array" }, - "quantity": { - "description": "Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase`", - "format": "int32", - "type": "integer" - }, - "uri": { - "description": "The Document URI - only allowed for website data stores.", + "nextPageToken": { + "description": "A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { + "description": "Response message for EngineService.ListEngines method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", - "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." - }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" - }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" + "engines": { + "description": "All the customer's Engines.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" + "type": "array" + }, + "nextPageToken": { + "description": "Not supported.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { + "description": "Response message for EvaluationService.ListEvaluationResults method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "evaluationResults": { + "description": "The EvaluationResults.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { + "description": "Represents the results of an evaluation for a single SampleQuery.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", + "readOnly": true }, - "includeAncestorHeadings": { - "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", - "type": "boolean" + "sampleQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", + "description": "Output only. The SampleQuery that was evaluated.", + "readOnly": true } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { + "description": "Response message for EvaluationService.ListEvaluations method.", + "id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "evaluations": { + "description": "The Evaluations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" + }, + "type": "array" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { + "description": "Response message for SampleQueryService.ListSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "nextPageToken": { + "description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQueries": { + "description": "The SampleQuerys.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDoubleList": { - "description": "Double list.", - "id": "GoogleCloudDiscoveryengineV1alphaDoubleList", + "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { + "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", "properties": { - "values": { - "description": "Double values.", + "nextPageToken": { + "description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQuerySets": { + "description": "The SampleQuerySets.", "items": { - "format": "double", - "type": "number" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig": { - "description": "Defines embedding config, used for bring your own embeddings feature.", - "id": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { + "description": "Response message for SchemaService.ListSchemas method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", "properties": { - "fieldPath": { - "description": "Full field path in the schema mapped as embedding field.", + "nextPageToken": { + "description": "A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" + }, + "schemas": { + "description": "The Schemas.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { + "description": "Response for ListServingConfigs method.", + "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "servingConfigs": { + "description": "All the ServingConfigs for a given dataStore.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest": { - "description": "Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngine", + "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { + "description": "Response for ListSessions method.", + "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, + "nextPageToken": { + "description": "Pagination token, if not returned indicates the last page.", "type": "string" }, - "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "sessions": { + "description": "All the Sessions for a given data store.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSession" }, "type": "array" - }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", - "type": "string" - }, - "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], - "type": "string" - }, - "mediaRecommendationEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", - "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." - }, - "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.ListTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, - "recommendationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", - "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", - "readOnly": true - }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." - }, - "similarDocumentsConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "description": "Additional config specs for a `similar-items` engine." - }, - "solutionType": { - "description": "Required. The solutions of the engine.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" + "targetSites": { + "description": "List of TargetSites.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + }, + "type": "array" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "totalSize": { + "description": "The total number of items matching the request. This will always be populated in the response.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." - }, - "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", + "GoogleCloudDiscoveryengineV1alphaMediaInfo": { + "description": "Media-specific user event information.", + "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", + "properties": { + "mediaProgressDuration": { + "description": "The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.", + "format": "google-duration", "type": "string" + }, + "mediaProgressPercentage": { + "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaPageInfo": { + "description": "Detailed page information.", + "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", "properties": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "pageCategory": { + "description": "The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, 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.", "type": "string" }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "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 `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" }, - "location": { - "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "referrerUri": { + "description": "The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty.", "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "uri": { + "description": "Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaPanelInfo": { + "description": "Detailed panel information associated with a user event.", + "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "displayName": { + "description": "The display name of the panel.", + "type": "string" + }, + "panelId": { + "description": "Required. The panel ID.", "type": "string" + }, + "panelPosition": { + "description": "The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.", + "format": "int32", + "type": "integer" + }, + "totalPanels": { + "description": "The total number of panels, including this one, shown to the user. Must be set if panel_position is set.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", - "properties": { - "companyName": { - "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", - "type": "string" - } - }, + "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { + "description": "Request for pausing training of an engine.", + "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { - "description": "Additional config specs for a Media Recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "GoogleCloudDiscoveryengineV1alphaPrincipal": { + "description": "Principal identifier of a user or a group.", + "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", "properties": { - "optimizationObjective": { - "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", - "type": "string" - }, - "optimizationObjectiveConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", - "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." - }, - "trainingState": { - "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", - "enum": [ - "TRAINING_STATE_UNSPECIFIED", - "PAUSED", - "TRAINING" - ], - "enumDescriptions": [ - "Unspecified training state.", - "The engine training is paused.", - "The engine is training." - ], + "groupId": { + "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.", "type": "string" }, - "type": { - "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "userId": { + "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { - "description": "Custom threshold for `cvr` optimization_objective.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { + "description": "Document captures all raw metadata information of items to be recommended or searched.", + "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", "properties": { - "targetField": { - "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "document": { + "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" }, - "targetFieldValueFloat": { - "description": "Required. The threshold to be applied to the target (e.g., 0.5).", - "format": "float", - "type": "number" + "jsonData": { + "description": "The JSON string representation of the processed document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { - "description": "Additional information of a recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "GoogleCloudDiscoveryengineV1alphaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { - "dataState": { - "description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", - "enum": [ - "DATA_STATE_UNSPECIFIED", - "DATA_OK", - "DATA_ERROR" - ], - "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", - "The engine has sufficient training data.", - "The engine does not have sufficient training data. Error messages can be queried via Stackdriver." - ], + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "lastTuneTime": { - "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", - "format": "google-datetime", + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", "readOnly": true, "type": "string" }, - "servingState": { - "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", - "enum": [ - "SERVING_STATE_UNSPECIFIED", - "INACTIVE", - "ACTIVE", - "TUNED" - ], - "enumDescriptions": [ - "Unspecified serving state.", - "The engine is not serving.", - "The engine is serving and can be queried.", - "The engine is trained on tuned hyperparameters and can be queried." - ], + "provisionCompletionTime": { + "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "format": "google-datetime", "readOnly": true, "type": "string" }, - "tuningOperation": { - "description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", "readOnly": true, - "type": "string" + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", - "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" - }, - "type": "array" - }, - "searchTier": { - "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { - "description": "Additional config specs for a `similar-items` engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { - "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", + }, + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest": { - "description": "Request message for EstimateBillingService.EstimateDataSize method", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest", - "properties": { - "fileDataSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", - "description": "Structured or unstructured data." }, - "websiteDataSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", - "description": "Website data." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource": { - "description": "Data source contains files either in Cloud Storage or BigQuery.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestFileDataSource", - "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." + "id": { + "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", + "type": "string" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "enumDescriptions": [ + "The default value of the enum. This value is not actually used.", + "The project has given consent to the terms of service.", + "The project is pending to review and accept the terms of service.", + "The project has declined or revoked the agreement to terms of service." + ], + "type": "string" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource": { - "description": "Data source is a set of website patterns that we crawl to get the total number of websites.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSource", - "properties": { - "estimatorUriPatterns": { - "description": "Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern" - }, - "type": "array" - } - }, + "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern": { - "description": "URI patterns that we use to crawl.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequestWebsiteDataSourceEstimatorUriPattern", + "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": { + "description": "Request for ProjectService.ProvisionProject method.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest", "properties": { - "exactMatch": { - "description": "Whether we infer the generated URI or use the exact provided one.", - "type": "boolean" - }, - "exclusive": { - "description": "Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default.", + "acceptDataUseTerms": { + "description": "Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).", "type": "boolean" }, - "providedUriPattern": { - "description": "User provided URI pattern. For example, `foo.com/bar/*`.", + "dataUseTermsVersion": { + "description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { - "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { - "dataSizeBytes": { - "description": "Data size in terms of bytes.", - "format": "int64", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "documentCount": { - "description": "Total number of documents.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFactChunk": { - "description": "Fact Chunk.", - "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", - "properties": { - "chunkText": { - "description": "Text content of the fact chunk. Can be at most 10K characters long.", - "type": "string" - }, - "index": { - "description": "The index of this chunk. Currently, only used for the streaming mode.", - "format": "int32", - "type": "integer" - }, - "source": { - "description": "Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.", - "type": "string" - }, - "sourceMetadata": { - "additionalProperties": { - "type": "string" - }, - "description": "More fine-grained information for the source reference.", - "type": "object" - } - }, + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest": { + "description": "Request message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse": { - "description": "Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.", - "id": "GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse", + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { - "nextPageToken": { - "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", - "type": "string" - }, - "targetSites": { - "description": "List of TargetSites containing the site verification status.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "totalSize": { - "description": "The total number of items matching the request. This will always be populated in the response.", - "format": "int32", - "type": "integer" + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFhirStoreSource": { - "description": "Cloud FhirStore source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { - "fhirStore": { - "description": "Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFieldConfig": { - "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", - "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { + "description": "Request message for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", "properties": { - "advancedSiteSearchDataSources": { - "description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", - "items": { - "enum": [ - "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", - "METATAGS", - "PAGEMAP", - "SCHEMA_ORG" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrieve value from meta tag.", - "Retrieve value from page map.", - "Retrieve value from schema.org data." - ], - "type": "string" - }, - "type": "array" - }, - "completableOption": { - "description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "COMPLETABLE_OPTION_UNSPECIFIED", - "COMPLETABLE_ENABLED", - "COMPLETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Completable option enabled for a schema field.", - "Completable option disabled for a schema field." - ], - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." }, - "dynamicFacetableOption": { - "description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", - "DYNAMIC_FACETABLE_ENABLED", - "DYNAMIC_FACETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Dynamic facetable option enabled for a schema field.", - "Dynamic facetable option disabled for a schema field." - ], + "filter": { + "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" }, - "fieldPath": { - "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", - "type": "string" + "force": { + "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", + "type": "boolean" }, - "fieldType": { - "description": "Output only. Raw type of the field.", - "enum": [ - "FIELD_TYPE_UNSPECIFIED", - "OBJECT", - "STRING", - "NUMBER", - "INTEGER", - "BOOLEAN", - "GEOLOCATION", - "DATETIME" - ], - "enumDescriptions": [ - "Field type is unspecified.", - "Field value type is Object.", - "Field value type is String.", - "Field value type is Number.", - "Field value type is Integer.", - "Field value type is Boolean.", - "Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", - "Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" - ], - "readOnly": true, - "type": "string" + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." }, - "indexableOption": { - "description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "INDEXABLE_OPTION_UNSPECIFIED", - "INDEXABLE_ENABLED", - "INDEXABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Indexable option enabled for a schema field.", - "Indexable option disabled for a schema field." - ], + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", + "description": "Inline source for the input content for purge." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource": { + "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource", + "properties": { + "documents": { + "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { + "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", + "properties": { + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", "type": "string" }, - "keyPropertyType": { - "description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", - "readOnly": true, + "purgeSample": { + "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig": { + "description": "Configuration of destination for Purge related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", + "properties": { + "gcsPrefix": { + "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", "type": "string" - }, - "recsFilterableOption": { - "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", - "enum": [ - "FILTERABLE_OPTION_UNSPECIFIED", - "FILTERABLE_ENABLED", - "FILTERABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Filterable option enabled for a schema field.", - "Filterable option disabled for a schema field." - ], + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "retrievableOption": { - "description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "RETRIEVABLE_OPTION_UNSPECIFIED", - "RETRIEVABLE_ENABLED", - "RETRIEVABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrievable option enabled for a schema field.", - "Retrievable option disabled for a schema field." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "schemaOrgPaths": { - "description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest": { + "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "searchableOption": { - "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "SEARCHABLE_OPTION_UNSPECIFIED", - "SEARCHABLE_ENABLED", - "SEARCHABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Searchable option enabled for a schema field.", - "Searchable option disabled for a schema field." - ], + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFirestoreSource": { - "description": "Firestore source import data from.", - "id": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { + "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { - "collectionId": { - "description": "Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "databaseId": { - "description": "Required. The Firestore database to copy the data from with a length limit of 256 characters.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" }, - "gcsStagingDir": { - "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.", + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", "type": "string" }, - "projectId": { - "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGcsSource": { - "description": "Cloud Storage location for input content.", - "id": "GoogleCloudDiscoveryengineV1alphaGcsSource", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", "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` 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 the GENERIC Data Store vertical. * `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 the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.", + "filter": { + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", "type": "string" }, - "inputUris": { - "description": "Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).", - "items": { - "type": "string" - }, - "type": "array" + "force": { + "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGroundingFact": { - "description": "Grounding Fact.", - "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on.", - "type": "object" - }, - "factText": { - "description": "Text content of the fact. Can be at most 10K characters long.", + "purgeCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec": { - "description": "Defines guided search spec.", - "id": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", "properties": { - "enableRefinementAttributes": { - "description": "Whether or not to enable and include refinement attributes in gudied search result.", - "type": "boolean" + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, - "enableRelatedQuestions": { - "description": "Whether or not to enable and include related questions in search response.", - "type": "boolean" + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" }, - "maxRelatedQuestions": { - "description": "Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.", - "format": "int32", - "type": "integer" + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfig": { - "description": "Identity Provider Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", "properties": { - "externalIdpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", - "description": "External Identity provider config." + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" }, - "idpType": { - "description": "Identity provider type configured.", - "enum": [ - "IDP_TYPE_UNSPECIFIED", - "GSUITE", - "THIRD_PARTY" - ], - "enumDescriptions": [ - "Default value. ACL search not enabled.", - "Google 1P provider.", - "Third party provider." - ], + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQuery": { + "description": "Defines a user inputed query.", + "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "properties": { + "queryId": { + "description": "Unique Id for the query.", + "type": "string" + }, + "text": { + "description": "Plain text.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRankRequest": { + "description": "Request message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", + "properties": { + "ignoreRecordDetailsInResponse": { + "description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.", + "type": "boolean" + }, + "model": { + "description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.", + "type": "string" + }, + "query": { + "description": "The query to use.", "type": "string" + }, + "records": { + "description": "Required. A list of records to rank. At most 200 records to rank.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" + }, + "type": "array" + }, + "topN": { + "description": "The number of results to return. If this is unset or no bigger than zero, returns all results.", + "format": "int32", + "type": "integer" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { - "description": "Third party IDP Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "GoogleCloudDiscoveryengineV1alphaRankResponse": { + "description": "Response message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", "properties": { - "workforcePoolName": { - "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", - "type": "string" + "records": { + "description": "A list of records sorted by descending score.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaRankingRecord": { + "description": "Record message for RankService.Rank method.", + "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "content": { + "description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", + "id": { + "description": "The unique ID to represent the record.", "type": "string" }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" + "score": { + "description": "The score of this record based on the given query and selected model.", + "format": "float", + "type": "number" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "title": { + "description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest": { - "description": "Request message for CompletionService.ImportCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest", + "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { + "description": "Request message for Recommend method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." + "filter": { + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", + "type": "string" }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "pageSize": { + "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.", + "format": "int32", + "type": "integer" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." + "params": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", + "type": "object" }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", - "description": "The Inline source for suggestion entries." + "userEvent": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent", + "description": "Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "validateOnly": { + "description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource": { - "description": "The inline source for CompletionSuggestions.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaRecommendResponse": { + "description": "Response message for Recommend method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponse", "properties": { - "suggestions": { - "description": "Required. A list of all denylist entries to import. Max of 1000 items.", + "attributionToken": { + "description": "A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.", + "type": "string" + }, + "missingIds": { + "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionSuggestion" + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { - "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", - "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "results": { + "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" }, "type": "array" + }, + "validateOnly": { + "description": "True if RecommendRequest.validate_only was set.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { + "description": "RecommendationResult represents a generic recommendation result with associated metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "Set if `returnDocument` is set to true in RecommendRequest.params." }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + "id": { + "description": "Resource ID of the recommended Document.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "metadata": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest": { - "description": "Request message for Import methods.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "properties": { - "alloyDbSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAlloyDbSource", - "description": "AlloyDB input source." - }, - "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, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", - "type": "boolean" - }, - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." - }, - "bigtableSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigtableSource", - "description": "Cloud Bigtable input source." - }, - "cloudSqlSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCloudSqlSource", - "description": "Cloud SQL input source." - }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." - }, - "fhirStoreSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFhirStoreSource", - "description": "FhirStore input source." - }, - "firestoreSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFirestoreSource", - "description": "Firestore input source." - }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." - }, - "idField": { - "description": "The field indicates the ID field or column to be used as 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 others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table 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 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. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", - "description": "The Inline source for the input content for documents." + "invalidUris": { + "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", + "items": { + "type": "string" + }, + "type": "array" }, - "reconciliationMode": { - "description": "The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.", - "enum": [ - "RECONCILIATION_MODE_UNSPECIFIED", - "INCREMENTAL", - "FULL" - ], - "enumDescriptions": [ - "Defaults to `INCREMENTAL`.", - "Inserts new documents or updates existing documents.", - "Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location." - ], - "type": "string" + "pendingCount": { + "description": "Total number of URIs that have yet to be crawled.", + "format": "int32", + "type": "integer" + }, + "quotaExceededCount": { + "description": "Total number of URIs that were rejected due to insufficient indexing resources.", + "format": "int32", + "type": "integer" }, - "spannerSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSpannerSource", - "description": "Spanner input source." + "successCount": { + "description": "Total number of URIs that have been crawled so far.", + "format": "int32", + "type": "integer" }, - "updateMask": { - "description": "Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.", - "format": "google-fieldmask", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" + }, + "validUrisCount": { + "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource": { - "description": "The inline source for the input config for ImportDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest": { + "description": "Request message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", "properties": { - "documents": { - "description": "Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.", + "uris": { + "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { - "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", + "items": { + "type": "string" + }, + "type": "array" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { + "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { - "gcsPrefix": { - "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.", + "failureReasons": { + "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + }, + "type": "array" + }, + "uri": { + "description": "URI that failed to be crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { + "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "corpusType": { + "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DESKTOP", + "MOBILE" + ], + "enumDescriptions": [ + "Default value.", + "Denotes a crawling attempt for the desktop version of a page.", + "Denotes a crawling attempt for the mobile version of a page." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "errorMessage": { + "description": "Reason why the URI was not crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { - "description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", - "properties": { - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." - }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", - "description": "The Inline source for the input content for suggestion deny list entries." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { - "description": "The inline source for SuggestionDenyListEntry.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", + "GoogleCloudDiscoveryengineV1alphaReply": { + "description": "Defines a reply message to user.", + "id": "GoogleCloudDiscoveryengineV1alphaReply", "properties": { - "entries": { - "description": "Required. A list of all denylist entries to import. Max of 1000 items.", + "references": { + "deprecated": true, + "description": "References in the reply.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" + "$ref": "GoogleCloudDiscoveryengineV1alphaReplyReference" }, "type": "array" + }, + "reply": { + "deprecated": true, + "description": "DEPRECATED: use `summary` instead. Text reply.", + "type": "string" + }, + "summary": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", + "description": "Summary based on search results." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaReplyReference": { + "deprecated": true, + "description": "Defines reference in reply.", + "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "anchorText": { + "description": "Anchor text.", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "end": { + "description": "Anchor text end index.", + "format": "int32", + "type": "integer" + }, + "start": { + "description": "Anchor text start index.", + "format": "int32", + "type": "integer" + }, + "uri": { + "description": "URI link reference.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { + "description": "Request for ReportConsentChange method.", + "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "consentChangeAction": { + "description": "Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.", + "enum": [ + "CONSENT_CHANGE_ACTION_UNSPECIFIED", + "ACCEPT" + ], + "enumDescriptions": [ + "Invalid action, user must specify accept/decline", + "User accepts service terms." + ], "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "serviceTermId": { + "description": "Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "serviceTermVersion": { + "description": "Required. The version string of the terms of service to update.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest": { - "description": "Request message for the ImportUserEvents request.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest", + "GoogleCloudDiscoveryengineV1alphaRequirement": { + "description": "A data requirement.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirement", "properties": { - "bigquerySource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", - "description": "BigQuery input source." + "condition": { + "$ref": "GoogleTypeExpr", + "description": "The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`." }, - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import. Cannot be set for inline user event imports." + "description": { + "description": "The description of the requirement.", + "type": "string" }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content." + "displayName": { + "description": "The name of the requirement.", + "type": "string" }, - "inlineSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", - "description": "The Inline source for the input content for UserEvents." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource": { - "description": "The inline source for the input config for ImportUserEvents method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsRequestInlineSource", - "properties": { - "userEvents": { - "description": "Required. A list of user events to import. Recommended max of 10k items.", + "metricBindings": { + "description": "A list of the metric bindings to be used in `condition`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" + }, + "type": "array" + }, + "thresholdBindings": { + "description": "A list of threshold bindings to be used in `condition`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" + }, + "type": "array" + }, + "type": { + "description": "The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`", + "type": "string" + }, + "violationSamplesBindings": { + "description": "A list of the metric bindings to be used in `condition`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { + "description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." + "category": { + "description": "The category of the metric's target resource. Example: \"Events\"", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "description": { + "description": "Human readable description of the corresponding metric filter.", + "type": "string" }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", + "metricFilter": { + "description": "The filter string used for metrics query. Example: \"metric.type = \\\"discoveryengine.googleapis.com/events/day_count\\\" AND \" \"metric.conditions.time_range = \\\"NINETY_DAYS\\\"\"", "type": "string" }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "resourceType": { + "description": "The resource being monitored for the metric.", + "type": "string" + }, + "variableId": { + "description": "The variable id to be referenced in `condition`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaInterval": { - "description": "A floating point interval.", - "id": "GoogleCloudDiscoveryengineV1alphaInterval", + "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { + "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", "properties": { - "exclusiveMaximum": { - "description": "Exclusive upper bound.", + "blockingThreshold": { + "description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.", "format": "double", "type": "number" }, - "exclusiveMinimum": { - "description": "Exclusive lower bound.", - "format": "double", - "type": "number" + "description": { + "description": "Human readable description of the corresponding threshold and sub-requirement.", + "type": "string" }, - "maximum": { - "description": "Inclusive upper bound.", - "format": "double", - "type": "number" + "variableId": { + "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", + "type": "string" }, - "minimum": { - "description": "Inclusive lower bound.", + "warningThreshold": { + "description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.", "format": "double", "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { + "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", + "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", "properties": { - "language": { - "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", - "readOnly": true, - "type": "string" - }, - "languageCode": { - "description": "The language code for the DataStore.", + "description": { + "description": "Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.", "type": "string" }, - "normalizedLanguageCode": { - "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", - "readOnly": true, + "sampleFilter": { + "description": "The filter string used for samples query. Example: \"sample.type = \\\"retail.googleapis.com/user_event\\\" AND \" \"sample.labels.event_type = \\\"PURCHASE\\\" \"", "type": "string" }, - "region": { - "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", - "readOnly": true, + "variableId": { + "description": "The variable id to be referenced in `condition`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListChunksResponse": { - "description": "Response message for ChunkService.ListChunks method.", - "id": "GoogleCloudDiscoveryengineV1alphaListChunksResponse", - "properties": { - "chunks": { - "description": "The Chunks.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk" - }, - "type": "array" - }, - "nextPageToken": { - "description": "A token that can be sent as ListChunksRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", - "type": "string" - } - }, + "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { + "description": "Request for resuming training of an engine.", + "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", + "properties": {}, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListControlsResponse": { - "description": "Response for ListControls method.", - "id": "GoogleCloudDiscoveryengineV1alphaListControlsResponse", + "GoogleCloudDiscoveryengineV1alphaSampleQuery": { + "description": "Sample Query captures metadata to be used for evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", "properties": { - "controls": { - "description": "All the Controls for a given data store.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControl" - }, - "type": "array" - }, - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "createTime": { + "description": "Output only. Timestamp the SampleQuery was created at.", + "format": "google-datetime", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListConversationsResponse": { - "description": "Response for ListConversations method.", - "id": "GoogleCloudDiscoveryengineV1alphaListConversationsResponse", - "properties": { - "conversations": { - "description": "All the Conversations for a given data store.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversation" - }, - "type": "array" }, - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "name": { + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" + }, + "queryEntry": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", + "description": "The query entry." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", + "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { + "description": "Query Entry captures metadata to be used for search evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", "properties": { - "models": { - "description": "List of custom tuning models.", + "query": { + "description": "Required. The query.", + "type": "string" + }, + "targets": { + "description": "List of targets for the query.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" + "$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse": { - "description": "Response message for DataStoreService.ListDataStores method.", - "id": "GoogleCloudDiscoveryengineV1alphaListDataStoresResponse", + "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { + "description": "Defines the parameters of the query's expected outcome.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", "properties": { - "dataStores": { - "description": "All the customer's DataStores.", + "pageNumbers": { + "description": "Expected page numbers of the target. Each page number must be non negative.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDataStore" + "format": "int32", + "type": "integer" }, "type": "array" }, - "nextPageToken": { - "description": "A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "score": { + "description": "Relevance score of the target.", + "format": "double", + "type": "number" + }, + "uri": { + "description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse": { - "description": "Response message for DocumentService.ListDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaListDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { + "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", + "id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", "properties": { - "documents": { - "description": "The Documents.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument" - }, - "type": "array" + "createTime": { + "description": "Output only. Timestamp the SampleQuerySet was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "nextPageToken": { - "description": "A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "description": { + "description": "The description of the SampleQuerySet.", + "type": "string" + }, + "displayName": { + "description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListEnginesResponse": { - "description": "Response message for EngineService.ListEngines method.", - "id": "GoogleCloudDiscoveryengineV1alphaListEnginesResponse", + "GoogleCloudDiscoveryengineV1alphaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1alphaSchema", "properties": { - "engines": { - "description": "All the customer's Engines.", + "fieldConfigs": { + "description": "Output only. Configurations for fields of the schema.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngine" + "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" }, + "readOnly": true, "type": "array" }, - "nextPageToken": { - "description": "Not supported.", + "jsonSchema": { + "description": "The JSON representation of the schema.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { - "description": "Response message for SchemaService.ListSchemas method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", - "properties": { - "nextPageToken": { - "description": "A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + }, + "name": { + "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, - "schemas": { - "description": "The Schemas.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema" + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse": { - "description": "Response for ListServingConfigs method.", - "id": "GoogleCloudDiscoveryengineV1alphaListServingConfigsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchInfo": { + "description": "Detailed search information.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", "properties": { - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "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.", + "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.", "type": "string" }, - "servingConfigs": { - "description": "All the ServingConfigs for a given dataStore.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfig" - }, - "type": "array" + "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.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListSessionsResponse": { - "description": "Response for ListSessions method.", - "id": "GoogleCloudDiscoveryengineV1alphaListSessionsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { - "nextPageToken": { - "description": "Pagination token, if not returned indicates the last page.", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + }, + "branch": { + "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, - "sessions": { - "description": "All the Sessions for a given data store.", + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", + "type": "string" + }, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "dataStoreSpecs": { + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSession" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.ListTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaListTargetSitesResponse", - "properties": { - "nextPageToken": { - "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", - "type": "string" }, - "targetSites": { - "description": "List of TargetSites.", + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." + }, + "facetSpecs": { + "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" }, "type": "array" }, - "totalSize": { - "description": "The total number of items matching the request. This will always be populated in the response.", + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "description": "Raw image query." + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", + "type": "string" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "offset": { + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaMediaInfo": { - "description": "Media-specific user event information.", - "id": "GoogleCloudDiscoveryengineV1alphaMediaInfo", - "properties": { - "mediaProgressDuration": { - "description": "The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.", - "format": "google-duration", + }, + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, - "mediaProgressPercentage": { - "description": "Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPageInfo": { - "description": "Detailed page information.", - "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", - "properties": { - "pageCategory": { - "description": "The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, 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.", + "pageSize": { + "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. 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 `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.", + "params": { + "additionalProperties": { + "type": "any" + }, + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", + "type": "object" + }, + "query": { + "description": "Raw search query.", "type": "string" }, - "referrerUri": { - "description": "The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty.", + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "rankingExpression": { + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, - "uri": { - "description": "Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.", + "regionCode": { + "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPanelInfo": { - "description": "Detailed panel information associated with a user event.", - "id": "GoogleCloudDiscoveryengineV1alphaPanelInfo", - "properties": { - "displayName": { - "description": "The display name of the panel.", + }, + "relevanceThreshold": { + "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], "type": "string" }, - "panelId": { - "description": "Required. The panel ID.", + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, - "panelPosition": { - "description": "The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set.", - "format": "int32", - "type": "integer" + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "type": "string" }, - "totalPanels": { - "description": "The total number of panels, including this one, shown to the user. Must be set if panel_position is set.", - "format": "int32", - "type": "integer" + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "userPseudoId": { + "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest": { - "description": "Request for pausing training of an engine.", - "id": "GoogleCloudDiscoveryengineV1alphaPauseEngineRequest", - "properties": {}, + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "properties": { + "conditionBoostSpecs": { + "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" + } + }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPrincipal": { - "description": "Principal identifier of a user or a group.", - "id": "GoogleCloudDiscoveryengineV1alphaPrincipal", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { - "groupId": { - "description": "Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.", - "type": "string" + "boost": { + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", + "format": "float", + "type": "number" }, - "userId": { - "description": "User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.", + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "condition": { + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProcessedDocument": { - "description": "Document captures all raw metadata information of items to be recommended or searched.", - "id": "GoogleCloudDiscoveryengineV1alphaProcessedDocument", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { + "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "document": { - "description": "Required. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", + "attributeType": { + "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "enumDescriptions": [ + "Unspecified AttributeType.", + "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." + ], + "type": "string" + }, + "controlPoints": { + "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, - "jsonData": { - "description": "The JSON string representation of the processed document.", + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1alphaProject", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { + "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, - "type": "string" - }, - "provisionCompletionTime": { - "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", - "format": "google-datetime", - "readOnly": true, + "attributeValue": { + "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "chunkSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, - "id": { - "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", - "type": "string" + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "enumDescriptions": [ - "The default value of the enum. This value is not actually used.", - "The project has given consent to the terms of service.", - "The project is pending to review and accept the terms of service.", - "The project has declined or revoked the agreement to terms of service." + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest": { - "description": "Request for ProjectService.ProvisionProject method.", - "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { - "acceptDataUseTerms": { - "description": "Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms).", - "type": "boolean" + "numNextChunks": { + "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", + "format": "int32", + "type": "integer" }, - "dataUseTermsVersion": { - "description": "Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time.", - "type": "string" + "numPreviousChunks": { + "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "maxExtractiveAnswerCount": { + "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "maxExtractiveSegmentCount": { + "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest": { - "description": "Request message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "maxSnippetCount": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", + "format": "int32", + "type": "integer" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "type": "boolean" + }, + "returnSnippet": { + "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", + "type": "boolean" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" + "ignoreNonSummarySeekingQuery": { + "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", + "type": "boolean" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" + "includeCitations": { + "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", + "type": "boolean" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "languageCode": { + "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest": { - "description": "Request message for DocumentService.PurgeDocuments method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest", - "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", - "description": "The desired location of errors incurred during the purge." }, - "filter": { - "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", - "type": "string" + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "summaryResultCount": { + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", + "format": "int32", + "type": "integer" }, - "force": { - "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", "type": "boolean" - }, - "gcsSource": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", - "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { - "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" - }, - "purgeSample": { - "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig": { - "description": "Configuration of destination for Purge related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeErrorConfig", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "gcsPrefix": { - "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "version": { + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest": { - "description": "Request message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { - "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest": { - "description": "Request message for PurgeUserEvents method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { - "filter": { - "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", - "type": "string" - }, - "force": { - "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.", + "enableDynamicPosition": { + "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" + }, + "excludedFilterKeys": { + "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "type": "string" + }, + "type": "array" + }, + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." + }, + "limit": { + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { - "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { - "purgeCount": { - "description": "The total count of events purged as a result of the operation.", - "format": "int64", + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" + }, + "contains": { + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intervals": { + "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" + }, + "type": "array" + }, + "key": { + "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", + "type": "string" + }, + "orderBy": { + "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" + }, + "prefixes": { + "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + }, + "restrictedValues": { + "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQuery": { - "description": "Defines a user inputed query.", - "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { - "queryId": { - "description": "Unique Id for the query.", - "type": "string" - }, - "text": { - "description": "Plain text.", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankRequest": { - "description": "Request message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankRequest", + "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "ignoreRecordDetailsInResponse": { - "description": "If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.", - "type": "boolean" - }, - "model": { - "description": "The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified.", - "type": "string" - }, - "query": { - "description": "The query to use.", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "records": { - "description": "Required. A list of records to rank. At most 200 records to rank.", + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" - }, - "type": "array" - }, - "topN": { - "description": "The number of results to return. If this is unset or no bigger than zero, returns all results.", - "format": "int32", - "type": "integer" - }, - "userLabels": { - "additionalProperties": { "type": "string" }, - "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", - "type": "object" + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "properties": { + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", + "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", + "Automatic query expansion built by the Search API." + ], + "type": "string" + }, + "pinUnexpandedResults": { + "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankResponse": { - "description": "Response message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "properties": { - "records": { - "description": "A list of records sorted by descending score.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRankingRecord" - }, - "type": "array" + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRankingRecord": { - "description": "Record message for RankService.Rank method.", - "id": "GoogleCloudDiscoveryengineV1alphaRankingRecord", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { - "content": { - "description": "The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", - "type": "string" - }, - "id": { - "description": "The unique ID to represent the record.", + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, - "score": { - "description": "The score of this record based on the given query and selected model.", - "format": "float", - "type": "number" - }, - "title": { - "description": "The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.", + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", + "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendRequest": { - "description": "Request message for Recommend method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", + "GoogleCloudDiscoveryengineV1alphaSearchResponse": { + "description": "Response message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", "properties": { - "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", + "appliedControls": { + "description": "Controls applied as part of the Control service.", + "items": { + "type": "string" + }, + "type": "array" + }, + "attributionToken": { + "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", "type": "string" }, - "pageSize": { - "description": "Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.", - "format": "int32", - "type": "integer" + "correctedQuery": { + "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.", + "type": "string" }, - "params": { - "additionalProperties": { - "type": "any" + "facets": { + "description": "Results of facets requested by user.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" }, - "description": "Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.", - "type": "object" - }, - "userEvent": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent", - "description": "Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset." + "type": "array" }, - "userLabels": { - "additionalProperties": { - "type": "string" + "geoSearchDebugInfo": { + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" }, - "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", - "type": "object" + "type": "array" }, - "validateOnly": { - "description": "Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaRecommendResponse": { - "description": "Response message for Recommend method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponse", - "properties": { - "attributionToken": { - "description": "A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.", + "guidedSearchResult": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", + "description": "Guided search result." + }, + "naturalLanguageQueryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "description": "Natural language query understanding information for the returned results." + }, + "nextPageToken": { + "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, - "missingIds": { - "description": "IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.", + "oneBoxResults": { + "description": "A list of One Box results. There can be multiple One Box results of different types.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult" }, "type": "array" }, + "queryExpansionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "description": "Query expansion information for the returned results." + }, + "redirectUri": { + "description": "The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.", + "type": "string" + }, "results": { - "description": "A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).", + "description": "A list of matched documents. The order represents the ranking.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" }, "type": "array" }, - "validateOnly": { - "description": "True if RecommendRequest.validate_only was set.", - "type": "boolean" + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + }, + "summary": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", + "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." + }, + "totalSize": { + "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult": { - "description": "RecommendationResult represents a generic recommendation result with associated metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaRecommendResponseRecommendationResult", + "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { + "description": "A facet result.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", "properties": { - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "Set if `returnDocument` is set to true in RecommendRequest.params." + "dynamicFacet": { + "description": "Whether the facet is dynamically generated.", + "type": "boolean" }, - "id": { - "description": "Resource ID of the recommended Document.", + "key": { + "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", "type": "string" }, - "metadata": { - "additionalProperties": { - "type": "any" + "values": { + "description": "The facet values for this field.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" }, - "description": "Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params.", - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { + "description": "A facet value which contains value names and their count.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "count": { + "description": "Number of items that have this facet value.", + "format": "int64", "type": "string" }, - "invalidUris": { - "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", - "items": { - "type": "string" - }, - "type": "array" - }, - "pendingCount": { - "description": "Total number of URIs that have yet to be crawled.", - "format": "int32", - "type": "integer" - }, - "quotaExceededCount": { - "description": "Total number of URIs that were rejected due to insufficient indexing resources.", - "format": "int32", - "type": "integer" - }, - "successCount": { - "description": "Total number of URIs that have been crawled so far.", - "format": "int32", - "type": "integer" + "interval": { + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval", + "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "value": { + "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", "type": "string" - }, - "validUrisCount": { - "description": "Total number of unique URIs in the request that are not in invalid_uris.", - "format": "int32", - "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest": { - "description": "Request message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { + "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", "properties": { - "uris": { - "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.", - "items": { - "type": "string" - }, - "type": "array" + "errorMessage": { + "description": "The error produced.", + "type": "string" + }, + "originalAddressQuery": { + "description": "The address from which forward geocoding ingestion produced issues.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { - "description": "Response message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult": { + "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", "properties": { - "failedUris": { - "description": "URIs that were not crawled before the LRO terminated.", + "followUpQuestions": { + "description": "Suggested follow-up questions.", "items": { "type": "string" }, "type": "array" }, - "failureSamples": { - "description": "Details for a sample of up to 10 `failed_uris`.", + "refinementAttributes": { + "description": "A list of ranked refinement attributes.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { - "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { + "description": "Useful attribute for search result refinements.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", "properties": { - "failureReasons": { - "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" - }, - "type": "array" + "attributeKey": { + "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", + "type": "string" }, - "uri": { - "description": "URI that failed to be crawled.", + "attributeValue": { + "description": "Attribute value used to refine the results. For example, `\"drama\"`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { - "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo": { + "description": "Information describing what natural language understanding was done on the input query.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo", "properties": { - "corpusType": { - "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", - "enum": [ - "CORPUS_TYPE_UNSPECIFIED", - "DESKTOP", - "MOBILE" - ], - "enumDescriptions": [ - "Default value.", - "Denotes a crawling attempt for the desktop version of a page.", - "Denotes a crawling attempt for the mobile version of a page." - ], + "extractedFilters": { + "description": "The filters that were extracted from the input query.", "type": "string" }, - "errorMessage": { - "description": "Reason why the URI was not crawled.", + "rewrittenQuery": { + "description": "Rewritten input query minus the extracted filters.", "type": "string" + }, + "structuredExtractedFilter": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "description": "The filters that were extracted from the input query represented in a structured form." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReply": { - "description": "Defines a reply message to user.", - "id": "GoogleCloudDiscoveryengineV1alphaReply", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { + "description": "The filters that were extracted from the input query represented in a structured form.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", "properties": { - "references": { - "deprecated": true, - "description": "References in the reply.", + "expression": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { + "description": "Logical `And` operator.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "properties": { + "expressions": { + "description": "The expressions that were ANDed together.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaReplyReference" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { + "description": "The expression denoting the filter that was extracted from the input query.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "properties": { + "andExpr": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "description": "Logical \"And\" compound operator connecting multiple expressions." }, - "reply": { - "deprecated": true, - "description": "DEPRECATED: use `summary` instead. Text reply.", - "type": "string" + "geolocationConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "description": "Geolocation constraint expression." }, - "summary": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", - "description": "Summary based on search results." + "numberConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "description": "Numerical constraint expression." + }, + "orExpr": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "description": "Logical \"Or\" compound operator connecting multiple expressions." + }, + "stringConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "description": "String constraint expression." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReplyReference": { - "deprecated": true, - "description": "Defines reference in reply.", - "id": "GoogleCloudDiscoveryengineV1alphaReplyReference", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { + "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", "properties": { - "anchorText": { - "description": "Anchor text.", + "address": { + "description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.", "type": "string" }, - "end": { - "description": "Anchor text end index.", - "format": "int32", - "type": "integer" + "fieldName": { + "description": "The name of the geolocation field as defined in the schema.", + "type": "string" }, - "start": { - "description": "Anchor text start index.", - "format": "int32", - "type": "integer" + "latitude": { + "description": "The latitude of the geolocation inferred from the input query.", + "format": "double", + "type": "number" }, - "uri": { - "description": "URI link reference.", - "type": "string" + "longitude": { + "description": "The longitude of the geolocation inferred from the input query.", + "format": "double", + "type": "number" + }, + "radiusInMeters": { + "description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest": { - "description": "Request for ReportConsentChange method.", - "id": "GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { + "description": "Constraint expression of a number field. Example: price < 100.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", "properties": { - "consentChangeAction": { - "description": "Required. Whether customer decides to accept or decline service term. At this moment, only accept action is supported.", + "comparison": { + "description": "The comparison operation performed between the field value and the value specified in the constraint.", "enum": [ - "CONSENT_CHANGE_ACTION_UNSPECIFIED", - "ACCEPT" + "COMPARISON_UNSPECIFIED", + "EQUALS", + "LESS_THAN_EQUALS", + "LESS_THAN", + "GREATER_THAN_EQUALS", + "GREATER_THAN" ], "enumDescriptions": [ - "Invalid action, user must specify accept/decline", - "User accepts service terms." + "Undefined comparison operator.", + "Denotes equality `=` operator.", + "Denotes less than or equal to `<=` operator.", + "Denotes less than `<` operator.", + "Denotes greater than or equal to `>=` operator.", + "Denotes greater than `>` operator." ], "type": "string" }, - "serviceTermId": { - "description": "Required. The unique identifier of the terms of service to update. Available term ids: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this service term id, the acceptable service_term_version to provide is `2022-11-23`.", + "fieldName": { + "description": "Name of the numerical field as defined in the schema.", "type": "string" }, - "serviceTermVersion": { - "description": "Required. The version string of the terms of service to update.", - "type": "string" + "value": { + "description": "The value specified in the numerical constraint.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirement": { - "description": "A data requirement.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirement", + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { + "description": "Logical `Or` operator.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", "properties": { - "condition": { - "$ref": "GoogleTypeExpr", - "description": "The condition for evaluating the requirement result. Variables in the expression should be provided by `metrics_bindings` or `threshold_bindings`. Where `metrics_bindings` are used for computed metrics and `threshold_bindings` are used to define thresholds for corresponding `metric_bindings`." - }, - "description": { - "description": "The description of the requirement.", - "type": "string" - }, - "displayName": { - "description": "The name of the requirement.", - "type": "string" - }, - "metricBindings": { - "description": "A list of the metric bindings to be used in `condition`.", + "expressions": { + "description": "The expressions that were ORed together.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" }, "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { + "description": "Constraint expression of a string field.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "properties": { + "fieldName": { + "description": "Name of the string field as defined in the schema.", + "type": "string" }, - "thresholdBindings": { - "description": "A list of threshold bindings to be used in `condition`.", + "querySegment": { + "description": "Identifies the keywords within the search query that match a filter.", + "type": "string" + }, + "values": { + "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding" + "type": "string" }, "type": "array" - }, - "type": { - "description": "The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate`", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult": { + "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult", + "properties": { + "oneBoxType": { + "description": "The type of One Box result.", + "enum": [ + "ONE_BOX_TYPE_UNSPECIFIED", + "PEOPLE", + "ORGANIZATION", + "SLACK" + ], + "enumDescriptions": [ + "Default value. Should not be used.", + "One Box result contains people results.", + "One Box result contains organization results.", + "One Box result contains slack results." + ], "type": "string" }, - "violationSamplesBindings": { - "description": "A list of the metric bindings to be used in `condition`.", + "searchResults": { + "description": "The search results for this One Box.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding": { - "description": "Specifies a metrics query and bind its result to a variable which will be used in the `condition`.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding", + "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { + "description": "Information describing query expansion including whether expansion has occurred.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", "properties": { - "category": { - "description": "The category of the metric's target resource. Example: \"Events\"", - "type": "string" + "expandedQuery": { + "description": "Bool describing whether query expansion has occurred.", + "type": "boolean" }, - "description": { - "description": "Human readable description of the corresponding metric filter.", + "pinnedResultCount": { + "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.", + "format": "int64", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult": { + "description": "Represents the search results.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", + "properties": { + "chunk": { + "$ref": "GoogleCloudDiscoveryengineV1alphaChunk", + "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." }, - "metricFilter": { - "description": "The filter string used for metrics query. Example: \"metric.type = \\\"discoveryengine.googleapis.com/events/day_count\\\" AND \" \"metric.conditions.time_range = \\\"NINETY_DAYS\\\"\"", + "document": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", + "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." + }, + "id": { + "description": "Document.id of the searched Document.", "type": "string" }, - "resourceType": { - "description": "The resource being monitored for the metric.", + "modelScores": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" + }, + "description": "Google provided available scores.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo", + "properties": { + "name": { + "description": "Name of the session. If the auto-session mode is used (when SearchRequest.session ends with \"-\"), this field holds the newly generated session name.", "type": "string" }, - "variableId": { - "description": "The variable id to be referenced in `condition`.", + "queryId": { + "description": "Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding": { - "description": "Specifies a multi-level threshold to apply to apply to a `metric_bindings` in the `condition` CEL expression.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { + "description": "Summary of the top N search results specified by the summary spec.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", "properties": { - "blockingThreshold": { - "description": "Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`.", - "format": "double", - "type": "number" + "safetyAttributes": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", + "description": "A collection of Safety Attribute categories and their associated confidence scores." }, - "description": { - "description": "Human readable description of the corresponding threshold and sub-requirement.", - "type": "string" + "summarySkippedReasons": { + "description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "items": { + "enum": [ + "SUMMARY_SKIPPED_REASON_UNSPECIFIED", + "ADVERSARIAL_QUERY_IGNORED", + "NON_SUMMARY_SEEKING_QUERY_IGNORED", + "OUT_OF_DOMAIN_QUERY_IGNORED", + "POTENTIAL_POLICY_VIOLATION", + "LLM_ADDON_NOT_ENABLED", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" + ], + "enumDescriptions": [ + "Default value. The summary skipped reason is not specified.", + "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", + "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", + "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", + "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." + ], + "type": "string" + }, + "type": "array" }, - "variableId": { - "description": "The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`.", + "summaryText": { + "description": "The summary content.", "type": "string" }, - "warningThreshold": { - "description": "Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`.", - "format": "double", - "type": "number" + "summaryWithMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "description": "Summary with metadata information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding": { - "description": "Specifies a samples query and bind its result to a variable which will be used in the `condition`.", - "id": "GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", "properties": { - "description": { - "description": "Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long.", + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", "type": "string" }, - "sampleFilter": { - "description": "The filter string used for samples query. Example: \"sample.type = \\\"retail.googleapis.com/user_event\\\" AND \" \"sample.labels.event_type = \\\"PURCHASE\\\" \"", - "type": "string" + "sources": { + "description": "Citation sources for the attributed segment.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" + }, + "type": "array" }, - "variableId": { - "description": "The variable id to be referenced in `condition`.", + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes/unicode.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest": { - "description": "Request for resuming training of an engine.", - "id": "GoogleCloudDiscoveryengineV1alphaResumeEngineRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1alphaSchema", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { + "description": "Citation metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", "properties": { - "fieldConfigs": { - "description": "Output only. Configurations for fields of the schema.", + "citations": { + "description": "Citations for segments.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" }, - "readOnly": true, "type": "array" - }, - "jsonSchema": { - "description": "The JSON representation of the schema.", - "type": "string" - }, - "name": { - "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", - "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchInfo": { - "description": "Detailed search information.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchInfo", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", "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.", - "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.", - "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.", + "referenceIndex": { + "description": "Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequest": { - "description": "Request message for SearchService.Search method.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { + "description": "Document reference.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", "properties": { - "boostSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", - "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" - }, - "branch": { - "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", - "type": "string" - }, - "canonicalFilter": { - "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", - "type": "string" - }, - "contentSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", - "description": "A specification for configuring the behavior of content search." - }, - "customFineTuningSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "description": "Custom fine tuning configs." - }, - "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" - }, - "type": "array" - }, - "embeddingSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", - "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." - }, - "facetSpecs": { - "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent" }, "type": "array" }, - "filter": { - "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", - "type": "string" - }, - "imageQuery": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", - "description": "Raw image query." - }, - "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", - "type": "string" - }, - "offset": { - "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", - "format": "int32", - "type": "integer" - }, - "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", - "type": "string" - }, - "pageSize": { - "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", - "format": "int32", - "type": "integer" - }, - "pageToken": { - "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", - "type": "string" - }, - "params": { - "additionalProperties": { - "type": "any" - }, - "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", - "type": "object" - }, - "query": { - "description": "Raw search query.", + "document": { + "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", "type": "string" }, - "queryExpansionSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", - "description": "The query expansion specification that specifies the conditions under which query expansion occurs." - }, - "rankingExpression": { - "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", + "title": { + "description": "Title of the document.", "type": "string" }, - "regionCode": { - "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", + "uri": { + "description": "Cloud Storage or HTTP uri for the document.", "type": "string" - }, - "relevanceThreshold": { - "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", - "enum": [ - "RELEVANCE_THRESHOLD_UNSPECIFIED", - "LOWEST", - "LOW", - "MEDIUM", - "HIGH" - ], - "enumDescriptions": [ - "Default value. In this case, server behavior defaults to Google defined threshold.", - "Lowest relevance threshold.", - "Low relevance threshold.", - "Medium relevance threshold.", - "High relevance threshold." - ], + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", + "properties": { + "content": { + "description": "Chunk textual content.", "type": "string" }, - "safeSearch": { - "description": "Whether to turn on safe search. This is only supported for website search.", - "type": "boolean" - }, - "searchAsYouTypeSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", - "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." - }, - "spellCorrectionSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", - "description": "The spell correction specification that specifies the mode under which spell correction takes effect." - }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." - }, - "userLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", - "type": "object" - }, - "userPseudoId": { - "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { - "description": "Boost specification to boost certain documents.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { + "description": "Safety Attribute categories and their associated confidence scores.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", "properties": { - "conditionBoostSpecs": { - "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "categories": { + "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", + "items": { + "type": "string" + }, + "type": "array" + }, + "scores": { + "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" + "format": "float", + "type": "number" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { - "description": "Boost applies to documents which match a condition.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", + "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { + "description": "Summary with metadata information.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", "properties": { - "boost": { - "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", - "format": "float", - "type": "number" + "citationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "description": "Citation metadata for given summary." }, - "boostControlSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", - "description": "Complex specification for custom ranking based on customer defined attribute value." + "references": { + "description": "Document References.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" + }, + "type": "array" }, - "condition": { - "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", + "summary": { + "description": "Summary text with no citation information.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { - "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "GoogleCloudDiscoveryengineV1alphaServingConfig": { + "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfig", "properties": { - "attributeType": { - "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", - "enum": [ - "ATTRIBUTE_TYPE_UNSPECIFIED", - "NUMERICAL", - "FRESHNESS" - ], - "enumDescriptions": [ - "Unspecified AttributeType.", - "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", - "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." - ], + "boostControlIds": { + "description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.", + "items": { + "type": "string" + }, + "type": "array" + }, + "createTime": { + "description": "Output only. ServingConfig created timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "controlPoints": { - "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here." + }, + "displayName": { + "description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "dissociateControlIds": { + "description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + "type": "string" }, "type": "array" }, - "fieldName": { - "description": "The name of the field whose value will be used to determine the boost amount.", + "diversityLevel": { + "description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", "type": "string" }, - "interpolationType": { - "description": "The interpolation type to be applied to connect the control points listed below.", - "enum": [ - "INTERPOLATION_TYPE_UNSPECIFIED", - "LINEAR" - ], - "enumDescriptions": [ - "Interpolation type is unspecified. In this case, it defaults to Linear.", - "Piecewise linear interpolation will be applied." - ], + "embeddingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", + "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config." + }, + "filterControlIds": { + "description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.", + "items": { + "type": "string" + }, + "type": "array" + }, + "genericConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", + "description": "The GenericConfig of the serving configuration." + }, + "guidedSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", + "description": "Guided search configs." + }, + "ignoreControlIds": { + "description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.", + "items": { + "type": "string" + }, + "type": "array" + }, + "mediaConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "description": "The MediaConfig of the serving configuration." + }, + "modelId": { + "description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { - "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", - "properties": { - "attributeValue": { - "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + }, + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", "type": "string" }, - "boostAmount": { - "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { - "description": "A specification for configuring the behavior of content search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", - "properties": { - "chunkSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", - "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" + "onewaySynonymsControlIds": { + "description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" }, - "extractiveContentSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", - "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." + "rankingExpression": { + "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", + "type": "string" }, - "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", + "redirectControlIds": { + "description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "replacementControlIds": { + "description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" + }, + "solutionType": { + "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", "enum": [ - "SEARCH_RESULT_MODE_UNSPECIFIED", - "DOCUMENTS", - "CHUNKS" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "enumDescriptions": [ "Default value.", - "Returns documents in the search result.", - "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." ], "type": "string" }, - "snippetSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", - "description": "If `snippetSpec` is not specified, snippets are not included in the search response." - }, - "summarySpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", - "description": "If `summarySpec` is not specified, summaries are not included in the search response." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { - "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", - "properties": { - "numNextChunks": { - "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", - "format": "int32", - "type": "integer" + "synonymsControlIds": { + "description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "items": { + "type": "string" + }, + "type": "array" }, - "numPreviousChunks": { - "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", - "format": "int32", - "type": "integer" + "updateTime": { + "description": "Output only. ServingConfig updated timestamp.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { - "description": "A specification for configuring the extractive content in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { + "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", "properties": { - "maxExtractiveAnswerCount": { - "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", - "format": "int32", - "type": "integer" - }, - "maxExtractiveSegmentCount": { - "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", - "format": "int32", - "type": "integer" - }, - "numNextSegments": { - "description": "Return at most `num_next_segments` segments after each selected segments.", - "format": "int32", - "type": "integer" - }, - "numPreviousSegments": { - "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", - "format": "int32", - "type": "integer" - }, - "returnExtractiveSegmentScore": { - "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", - "type": "boolean" + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { - "description": "A specification for configuring snippets in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig": { + "description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "id": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", "properties": { - "maxSnippetCount": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", + "contentFreshnessCutoffDays": { + "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", "format": "int32", "type": "integer" }, - "referenceOnly": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", - "type": "boolean" + "contentWatchedPercentageThreshold": { + "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", + "format": "float", + "type": "number" }, - "returnSnippet": { - "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", - "type": "boolean" + "contentWatchedSecondsThreshold": { + "description": "Specifies the content watched minutes threshold for demotion.", + "format": "float", + "type": "number" + }, + "demotionEventType": { + "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { - "description": "A specification for configuring a summary returned in a search response.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "GoogleCloudDiscoveryengineV1alphaSession": { + "description": "External session proto definition.", + "id": "GoogleCloudDiscoveryengineV1alphaSession", "properties": { - "ignoreAdversarialQuery": { - "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", - "type": "boolean" - }, - "ignoreNonSummarySeekingQuery": { - "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", - "type": "boolean" - }, - "includeCitations": { - "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", - "type": "boolean" + "endTime": { + "description": "Output only. The time the session finished.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "languageCode": { - "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", "type": "string" }, - "modelPromptSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", - "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + "startTime": { + "description": "Output only. The time the session started.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "modelSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", - "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + "state": { + "description": "The state of the session.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS" + ], + "enumDescriptions": [ + "State is unspecified.", + "The session is currently open." + ], + "type": "string" }, - "summaryResultCount": { - "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", - "format": "int32", - "type": "integer" + "turns": { + "description": "Turns.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" + }, + "type": "array" }, - "useSemanticChunks": { - "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { - "description": "Specification of the prompt to use with the model.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", - "properties": { - "preamble": { - "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", + "userPseudoId": { + "description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { - "description": "Specification of the model.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "GoogleCloudDiscoveryengineV1alphaSessionTurn": { + "description": "Represents a turn, including a query from the user and a answer from service.", + "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { - "version": { - "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", + "answer": { + "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" + }, + "query": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", + "description": "The user query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { - "dataStore": { - "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { - "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { + "description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", "properties": { - "embeddingVectors": { - "description": "The embedding vector used for retrieval. Limit to 1.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { - "description": "Embedding vector.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", - "properties": { - "fieldPath": { - "description": "Embedding field path in schema.", - "type": "string" + "description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", + "type": "object" }, - "vector": { - "description": "Query embedding vector.", - "items": { - "format": "float", - "type": "number" + "emptyDocumentDataMap": { + "description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", + "type": "boolean" + }, + "schema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" }, - "type": "array" + "description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { - "description": "A facet specification to perform faceted search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { + "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", "properties": { - "enableDynamicPosition": { - "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", - "type": "boolean" - }, - "excludedFilterKeys": { - "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", - "items": { - "type": "string" - }, - "type": "array" - }, - "facetKey": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", - "description": "Required. The facet key specification." - }, - "limit": { - "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", - "format": "int32", - "type": "integer" + "name": { + "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { - "description": "Specifies how a facet is computed.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { - "caseInsensitive": { - "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", - "type": "boolean" - }, - "contains": { - "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", - "items": { - "type": "string" - }, - "type": "array" - }, - "intervals": { - "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" - }, - "type": "array" - }, - "key": { - "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", - "type": "string" - }, - "orderBy": { - "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", + "enum": [ + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" + ], + "enumDescriptions": [ + "Defaults to VERIFIED.", + "Site ownership verified.", + "Site ownership pending verification or verification failed.", + "Site exempt from verification, e.g., a public website that opens to all." + ], "type": "string" }, - "prefixes": { - "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", - "items": { - "type": "string" - }, - "type": "array" - }, - "restrictedValues": { - "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", - "items": { - "type": "string" - }, - "type": "array" + "verifyTime": { + "description": "Latest site verification time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { - "description": "Specifies the image query input.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "GoogleCloudDiscoveryengineV1alphaSpannerSource": { + "description": "The Spanner source for importing data", + "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", "properties": { - "imageBytes": { - "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "databaseId": { + "description": "Required. The database ID of the source Spanner table.", + "type": "string" + }, + "enableDataBoost": { + "description": "Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).", + "type": "boolean" + }, + "instanceId": { + "description": "Required. The instance ID of the source Spanner table.", + "type": "string" + }, + "projectId": { + "description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "type": "string" + }, + "tableId": { + "description": "Required. The table name of the Spanner database that needs to be imported.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { - "description": "Specification to determine under which conditions query expansion should occur.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { + "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", + "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", "properties": { - "condition": { - "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "blockPhrase": { + "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", + "type": "string" + }, + "matchOperator": { + "description": "Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.", "enum": [ - "CONDITION_UNSPECIFIED", - "DISABLED", - "AUTO" + "MATCH_OPERATOR_UNSPECIFIED", + "EXACT_MATCH", + "CONTAINS" ], "enumDescriptions": [ - "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", - "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", - "Automatic query expansion built by the Search API." + "Default value. Should not be used", + "If the suggestion is an exact match to the block_phrase, then block it.", + "If the suggestion contains the block_phrase, then block it." ], "type": "string" - }, - "pinUnexpandedResults": { - "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { - "description": "Specification for search as you type in search requests.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "GoogleCloudDiscoveryengineV1alphaTargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { - "condition": { - "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "exactMatch": { + "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" + }, + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true + }, + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "indexingStatus": { + "description": "Output only. Indexing status.", "enum": [ - "CONDITION_UNSPECIFIED", - "DISABLED", - "ENABLED" + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" ], "enumDescriptions": [ - "Server behavior defaults to Condition.DISABLED.", - "Disables Search As You Type.", - "Enables Search As You Type." + "Defaults to SUCCEEDED.", + "The target site is in the update queue and will be picked up by indexing pipeline.", + "The target site fails to be indexed.", + "The target site has been indexed.", + "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { - "description": "The specification for query spell correction.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", - "properties": { - "mode": { - "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + }, + "name": { + "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", + "readOnly": true, + "type": "string" + }, + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "type": "string" + }, + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, + "type": "string" + }, + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true + }, + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ - "MODE_UNSPECIFIED", - "SUGGESTION_ONLY", - "AUTO" + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" ], "enumDescriptions": [ - "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", - "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", - "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." ], "type": "string" + }, + "updateTime": { + "description": "Output only. The target site's last updated time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponse": { - "description": "Response message for SearchService.Search method.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponse", + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", "properties": { - "appliedControls": { - "description": "Controls applied as part of the Control service.", - "items": { - "type": "string" - }, - "type": "array" - }, - "attributionToken": { - "description": "A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance.", + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", + "properties": { + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTextInput": { + "description": "Defines text input.", + "id": "GoogleCloudDiscoveryengineV1alphaTextInput", + "properties": { + "context": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConversationContext", + "description": "Conversation context of the input." }, - "correctedQuery": { - "description": "Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.", + "input": { + "description": "Text input.", "type": "string" - }, - "facets": { - "description": "Results of facets requested by user.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet" - }, - "type": "array" - }, - "geoSearchDebugInfo": { - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" - }, - "type": "array" - }, - "guidedSearchResult": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", - "description": "Guided search result." - }, - "nextPageToken": { - "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "queryExpansionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", - "description": "Query expansion information for the returned results." - }, - "redirectUri": { - "description": "The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { + "description": "Request message for SearchTuningService.TrainCustomModel method.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the data ingestion and training." }, - "results": { - "description": "A list of matched documents. The order represents the ranking.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult" - }, - "type": "array" + "gcsTrainingInput": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "description": "Cloud Storage training input." }, - "summary": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", - "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." + "modelId": { + "description": "If not provided, a UUID will be generated.", + "type": "string" }, - "totalSize": { - "description": "The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches.", - "format": "int32", - "type": "integer" + "modelType": { + "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet": { - "description": "A facet result.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacet", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { + "description": "Cloud Storage training data input.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", "properties": { - "dynamicFacet": { - "description": "Whether the facet is dynamically generated.", - "type": "boolean" + "corpusDataPath": { + "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", + "type": "string" }, - "key": { - "description": "The key for this facet. For example, `\"colors\"` or `\"price\"`. It matches SearchRequest.FacetSpec.FacetKey.key.", + "queryDataPath": { + "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", "type": "string" }, - "values": { - "description": "The facet values for this field.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue" - }, - "type": "array" + "testDataPath": { + "description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", + "type": "string" + }, + "trainDataPath": { + "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue": { - "description": "A facet value which contains value names and their count.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseFacetFacetValue", + "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { - "count": { - "description": "Number of items that have this facet value.", - "format": "int64", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." }, - "interval": { - "$ref": "GoogleCloudDiscoveryengineV1alphaInterval", - "description": "Interval value for a facet, such as 10, 20) for facet \"price\". It matches [SearchRequest.FacetSpec.FacetKey.intervals." + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "value": { - "description": "Text value of a facet, such as \"Black\" for facet \"colors\".", + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", + "type": "string" + }, + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { - "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", + "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { + "description": "A transaction represents the entire purchase transaction.", + "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", "properties": { - "errorMessage": { - "description": "The error produced.", + "cost": { + "description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost", + "format": "float", + "type": "number" + }, + "currency": { + "description": "Required. Currency code. Use three-character ISO-4217 code.", "type": "string" }, - "originalAddressQuery": { - "description": "The address from which forward geocoding ingestion produced issues.", + "discountValue": { + "description": "The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost", + "format": "float", + "type": "number" + }, + "tax": { + "description": "All the taxes associated with the transaction.", + "format": "float", + "type": "number" + }, + "transactionId": { + "description": "The transaction ID with a length limit of 128 characters.", "type": "string" + }, + "value": { + "description": "Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult": { - "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", + "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { + "description": "Metadata associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", "properties": { - "followUpQuestions": { - "description": "Suggested follow-up questions.", - "items": { - "type": "string" - }, - "type": "array" - }, - "refinementAttributes": { - "description": "A list of ranked refinement attributes.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute" - }, - "type": "array" + "engine": { + "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute": { - "description": "Useful attribute for search result refinements.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResultRefinementAttribute", + "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest": { + "description": "Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { + "description": "Response associated with a tune operation.", + "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { - "attributeKey": { - "description": "Attribute key used to refine the results. For example, `\"movie_type\"`.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "attributeValue": { - "description": "Attribute value used to refine the results. For example, `\"drama\"`.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo": { - "description": "Information describing query expansion including whether expansion has occurred.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseQueryExpansionInfo", + "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "properties": { - "expandedQuery": { - "description": "Bool describing whether query expansion has occurred.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "pinnedResultCount": { - "description": "Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.", - "format": "int64", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult": { - "description": "Represents the search results.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult", + "GoogleCloudDiscoveryengineV1alphaUserEvent": { + "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", + "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", "properties": { - "chunk": { - "$ref": "GoogleCloudDiscoveryengineV1alphaChunk", - "description": "The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS." + "attributes": { + "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.", + "type": "object" }, - "document": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocument", - "description": "The document data snippet in the search response. Only fields that are marked as `retrievable` are populated." + "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: * 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" }, - "id": { - "description": "Document.id of the searched Document.", + "completionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", + "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." + }, + "dataStore": { + "description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.", "type": "string" }, - "modelScores": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDoubleList" + "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.", + "type": "boolean" + }, + "documents": { + "description": "List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" }, - "description": "Google provided available scores.", - "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary": { - "description": "Summary of the top N search results specified by the summary spec.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummary", - "properties": { - "safetyAttributes": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", - "description": "A collection of Safety Attribute categories and their associated confidence scores." + "type": "array" + }, + "engine": { + "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.", + "type": "string" + }, + "eventTime": { + "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", + "format": "google-datetime", + "type": "string" + }, + "eventType": { + "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.", + "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 RecommendRequest, this field may be populated directly from 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": { + "$ref": "GoogleCloudDiscoveryengineV1alphaMediaInfo", + "description": "Media-specific info." + }, + "pageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPageInfo", + "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`." }, - "summarySkippedReasons": { - "description": "Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "panel": { + "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", + "description": "Panel metadata associated with this user event." + }, + "promotionIds": { + "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", "items": { - "enum": [ - "SUMMARY_SKIPPED_REASON_UNSPECIFIED", - "ADVERSARIAL_QUERY_IGNORED", - "NON_SUMMARY_SEEKING_QUERY_IGNORED", - "OUT_OF_DOMAIN_QUERY_IGNORED", - "POTENTIAL_POLICY_VIOLATION", - "LLM_ADDON_NOT_ENABLED" - ], - "enumDescriptions": [ - "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", - "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", - "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled." - ], "type": "string" }, "type": "array" }, - "summaryText": { - "description": "The summary content.", - "type": "string" + "searchInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", + "description": "SearchService.Search details related to the event. This field should be set for `search` event." }, - "summaryWithMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", - "description": "Summary with metadata information." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation", - "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", + "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.", "type": "string" }, - "sources": { - "description": "Citation sources for the attributed segment.", + "tagIds": { + "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource" + "type": "string" }, "type": "array" }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes/unicode.", - "format": "int64", + "transactionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", + "description": "The transaction metadata (if any) associated with this user event." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "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.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata": { - "description": "Citation metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", "properties": { - "citations": { - "description": "Citations for segments.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitation" - }, - "type": "array" + "userAgent": { + "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": { + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationSource", + "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", "properties": { - "referenceIndex": { - "description": "Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.", - "format": "int64", + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference": { - "description": "Document reference.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent" - }, - "type": "array" - }, - "document": { - "description": "Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.", - "type": "string" - }, - "title": { - "description": "Title of the document.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "Cloud Storage or HTTP uri for the document.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReferenceChunkContent", + "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { - "content": { - "description": "Chunk textual content.", - "type": "string" - }, - "pageIdentifier": { - "description": "Page identifier.", - "type": "string" + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes": { - "description": "Safety Attribute categories and their associated confidence scores.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySafetyAttributes", + "GoogleCloudDiscoveryengineV1betaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { - "categories": { - "description": "The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.", + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, "type": "array" }, - "scores": { - "description": "The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.", + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", "items": { - "format": "float", - "type": "number" + "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata": { - "description": "Summary with metadata information.", - "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummarySummaryWithMetadata", + "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "properties": { - "citationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryCitationMetadata", - "description": "Citation metadata for given summary." - }, - "references": { - "description": "Document References.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseSummaryReference" - }, - "type": "array" + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" }, - "summary": { - "description": "Summary text with no citation information.", + "value": { + "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaServingConfig": { - "description": "Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfig", + "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { - "boostControlIds": { - "description": "Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls.", - "items": { - "type": "string" - }, - "type": "array" - }, - "createTime": { - "description": "Output only. ServingConfig created timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "customFineTuningSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", - "description": "Custom fine tuning configs." - }, - "displayName": { - "description": "Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", - "type": "string" - }, - "dissociateControlIds": { - "description": "Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", - "items": { - "type": "string" - }, - "type": "array" - }, - "diversityLevel": { - "description": "How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", - "type": "string" - }, - "embeddingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEmbeddingConfig", - "description": "Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config." - }, - "filterControlIds": { - "description": "Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls.", - "items": { - "type": "string" - }, - "type": "array" - }, - "genericConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", - "description": "The GenericConfig of the serving configuration." - }, - "guidedSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaGuidedSearchSpec", - "description": "Guided search configs." - }, - "ignoreControlIds": { - "description": "Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100.", - "items": { - "type": "string" - }, - "type": "array" - }, - "mediaConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", - "description": "The MediaConfig of the serving configuration." - }, - "modelId": { - "description": "The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION.", + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", "type": "string" }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`", + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", "type": "string" - }, - "onewaySynonymsControlIds": { - "description": "Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaControl": { + "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", + "id": "GoogleCloudDiscoveryengineV1betaControl", + "properties": { + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, + "readOnly": true, "type": "array" }, - "rankingExpression": { - "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).", - "type": "string" + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "description": "Defines a boost-type control" }, - "redirectControlIds": { - "description": "IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "conditions": { + "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, - "replacementControlIds": { - "description": "Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", - "items": { - "type": "string" - }, - "type": "array" + "displayName": { + "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + }, + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "type": "string" + }, + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "description": "Defines a redirect-type control." }, "solutionType": { - "description": "Required. Immutable. Specifies the solution type that a serving config can be associated with.", + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14439,486 +17016,376 @@ ], "type": "string" }, - "synonymsControlIds": { - "description": "Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH.", + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "useCases": { + "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "Value used when unset. Will not occur in CSS.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], "type": "string" }, "type": "array" - }, - "updateTime": { - "description": "Output only. ServingConfig updated timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig": { - "description": "Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfigGenericConfig", - "properties": { - "contentSearchSpec": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", - "description": "Specifies the expected behavior of content search. Only valid for content-search enabled data store." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig": { - "description": "Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.", - "id": "GoogleCloudDiscoveryengineV1alphaServingConfigMediaConfig", + "GoogleCloudDiscoveryengineV1betaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { - "contentFreshnessCutoffDays": { - "description": "Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.", - "format": "int32", - "type": "integer" - }, - "contentWatchedPercentageThreshold": { - "description": "Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.", + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", "format": "float", "type": "number" }, - "contentWatchedSecondsThreshold": { - "description": "Specifies the content watched minutes threshold for demotion.", - "format": "float", - "type": "number" + "dataStore": { + "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" }, - "demotionEventType": { - "description": "Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.", + "filter": { + "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSession": { - "description": "External session proto definition.", - "id": "GoogleCloudDiscoveryengineV1alphaSession", + "GoogleCloudDiscoveryengineV1betaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { - "endTime": { - "description": "Output only. The time the session finished.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", - "type": "string" - }, - "startTime": { - "description": "Output only. The time the session started.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "state": { - "description": "The state of the session.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS" - ], - "enumDescriptions": [ - "State is unspecified.", - "The session is currently open." - ], + "dataStore": { + "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, - "turns": { - "description": "Turns.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" - }, - "type": "array" - }, - "userPseudoId": { - "description": "A unique identifier for tracking users.", + "filter": { + "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSessionTurn": { - "description": "Represents a turn, including a query from the user and a answer from service.", - "id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", + "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", "properties": { - "answer": { - "description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", + "redirectUri": { + "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" - }, - "query": { - "$ref": "GoogleCloudDiscoveryengineV1alphaQuery", - "description": "The user query." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { - "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", + "GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { + "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", + "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", "properties": { - "name": { - "description": "The fully qualified resource name of the site search engine. Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`", - "type": "string" + "synonyms": { + "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", + "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", - "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" - ], - "enumDescriptions": [ - "Defaults to VERIFIED.", - "Site ownership verified.", - "Site ownership pending verification or verification failed.", - "Site exempt from verification, e.g., a public website that opens to all." - ], + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSpannerSource": { - "description": "The Spanner source for importing data", - "id": "GoogleCloudDiscoveryengineV1alphaSpannerSource", + "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { - "databaseId": { - "description": "Required. The database ID of the source Spanner table.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "enableDataBoost": { - "description": "Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas).", - "type": "boolean" - }, - "instanceId": { - "description": "Required. The instance ID of the source Spanner table.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "projectId": { - "description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" - }, - "tableId": { - "description": "Required. The table name of the Spanner database that needs to be imported.", + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry": { - "description": "Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.", - "id": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry", + "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", "properties": { - "blockPhrase": { - "description": "Required. Phrase to block from suggestions served. Can be maximum 125 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "matchOperator": { - "description": "Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.", - "enum": [ - "MATCH_OPERATOR_UNSPECIFIED", - "EXACT_MATCH", - "CONTAINS" - ], - "enumDescriptions": [ - "Default value. Should not be used", - "If the suggestion is an exact match to the block_phrase, then block it.", - "If the suggestion contains the block_phrase, then block it." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSite", + "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", "properties": { - "exactMatch": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", + "type": "string" }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, + "displayName": { + "description": "The display name of the model.", "type": "string" }, - "indexingStatus": { - "description": "Output only. Indexing status.", + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "enumDescriptions": [ - "Defaults to SUCCEEDED.", - "The target site is in the update queue and will be picked up by indexing pipeline.", - "The target site fails to be indexed.", - "The target site has been indexed.", - "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." + "Default value.", + "The model is in a paused training state.", + "The model is currently training.", + "The model has successfully completed training.", + "The model is ready for serving.", + "The model training failed.", + "The model training finished successfully but metrics did not improve." ], - "readOnly": true, "type": "string" }, - "name": { - "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", - "readOnly": true, + "modelVersion": { + "description": "The version of the model.", + "format": "int64", "type": "string" }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", "type": "string" }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", "type": "string" - }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true - }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1betaDataStore", + "properties": { + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" ], "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, - "updateTime": { - "description": "Output only. The target site's last updated time.", + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", - "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", - "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTextInput": { - "description": "Defines text input.", - "id": "GoogleCloudDiscoveryengineV1alphaTextInput", - "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConversationContext", - "description": "Conversation context of the input." }, - "input": { - "description": "Text input.", + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { - "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest": { - "description": "Request message for SearchTuningService.TrainCustomModel method.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest", - "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the data ingestion and training." }, - "gcsTrainingInput": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", - "description": "Cloud Storage training input." + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "description": "Language info for DataStore." }, - "modelId": { - "description": "If not provided, a UUID will be generated.", + "name": { + "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, - "modelType": { - "description": "Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided.", - "type": "string" + "solutionTypes": { + "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1betaSchema", + "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput": { - "description": "Cloud Storage training data input.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput", + "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", "properties": { - "corpusDataPath": { - "description": "The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{\"_id\": \"doc1\", title: \"relevant doc\", \"text\": \"relevant text\"}`", - "type": "string" - }, - "queryDataPath": { - "description": "The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {\"_id\": \"query1\", \"text\": \"example query\"}", - "type": "string" - }, - "testDataPath": { - "description": "Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "trainDataPath": { - "description": "Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\\tcorpus-id\\tscore` * `query1\\tdoc1\\t1`", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { - "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", + "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the data.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "metrics": { - "additionalProperties": { - "format": "double", - "type": "number" - }, - "description": "The metrics of the trained model.", - "type": "object" - }, - "modelName": { - "description": "Fully qualified name of the CustomTuningModel.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "modelStatus": { - "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTransactionInfo": { - "description": "A transaction represents the entire purchase transaction.", - "id": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", + "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", "properties": { - "cost": { - "description": "All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost", - "format": "float", - "type": "number" - }, - "currency": { - "description": "Required. Currency code. Use three-character ISO-4217 code.", - "type": "string" - }, - "discountValue": { - "description": "The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost", - "format": "float", - "type": "number" - }, - "tax": { - "description": "All the taxes associated with the transaction.", - "format": "float", - "type": "number" - }, - "transactionId": { - "description": "The transaction ID with a length limit of 128 characters.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "value": { - "description": "Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.", - "format": "float", - "type": "number" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { - "description": "Metadata associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", - "properties": { - "engine": { - "description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest": { - "description": "Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineRequest", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { - "description": "Response associated with a tune operation.", - "id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14933,9 +17400,9 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14950,355 +17417,478 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUserEvent": { - "description": "UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website.", - "id": "GoogleCloudDiscoveryengineV1alphaUserEvent", + "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", "properties": { - "attributes": { - "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.", - "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: * 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" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "completionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCompletionInfo", - "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." + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, - "dataStore": { - "description": "The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted.", + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, - "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.", + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" + }, + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." }, - "documents": { - "description": "List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired.", + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentInfo" + "type": "string" }, "type": "array" }, - "engine": { - "description": "The Engine resource name, in the form of `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. Optional. Only required for Engine produced user events. For example, user events from blended search.", - "type": "string" - }, - "eventTime": { - "description": "Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened.", + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "eventType": { - "description": "Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc.", - "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 RecommendRequest, this field may be populated directly from 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.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, - "mediaInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaMediaInfo", - "description": "Media-specific info." + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true }, - "pageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPageInfo", - "description": "Page metadata such as categories and other critical information for certain event types such as `view-category-page`." + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." }, - "panel": { - "$ref": "GoogleCloudDiscoveryengineV1alphaPanelInfo", - "description": "Panel metadata associated with this user event." + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "promotionIds": { - "description": "The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID.", + "dataStoreIds": { + "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, "type": "array" }, - "searchInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSearchInfo", - "description": "SearchService.Search details related to the event. This field should be set for `search` event." + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" }, - "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.", + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], "type": "string" }, - "tagIds": { - "description": "A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups.", - "items": { - "type": "string" - }, - "type": "array" + "name": { + "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" }, - "transactionInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTransactionInfo", - "description": "The transaction metadata (if any) associated with this user event." + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, - "userInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", - "description": "Information about the end user." + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" }, - "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.", + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaUserInfo": { - "description": "Information of an end user.", - "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", "properties": { - "userAgent": { - "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" + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, - "userId": { - "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "dialogflowAgentToLink": { + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "business": { + "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "defaultLanguageCode": { + "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" + }, + "location": { + "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "type": "string" + }, + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", - "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1betaCondition", + "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" - }, - "type": "array" - }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" - }, - "type": "array" + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", + "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" - }, - "value": { - "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", + "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", - "format": "google-datetime", - "type": "string" + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" + }, + "type": "array" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", - "format": "google-datetime", + "searchTier": { + "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControl": { - "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", - "id": "GoogleCloudDiscoveryengineV1betaControl", + "GoogleCloudDiscoveryengineV1betaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluation", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", "readOnly": true, - "type": "array" + "type": "string" }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", - "description": "Defines a boost-type control" + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, - "conditions": { - "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCondition" + "$ref": "GoogleRpcStatus" }, + "readOnly": true, "type": "array" }, - "displayName": { - "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" - }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." }, "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", - "description": "Defines a redirect-type control." + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", + "readOnly": true }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "state": { + "description": "Output only. The state of the evaluation.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" ], "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." ], + "readOnly": true, "type": "string" - }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." - }, - "useCases": { - "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "enumDescriptions": [ - "Value used when unset. Will not occur in CSS.", - "Search use case. Expects the traffic has a non-empty query.", - "Browse use case. Expects the traffic has an empty query." - ], - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" - }, - "dataStore": { - "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", - "type": "string" + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "filter": { - "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", "properties": { - "dataStore": { - "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", - "type": "string" - }, - "filter": { - "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "sampleQuerySet": { + "description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", + "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", "properties": { - "redirectUri": { - "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { - "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", - "id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", + "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { + "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", "properties": { - "synonyms": { - "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -15307,26 +17897,88 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { + "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "properties": { + "gcsPrefix": { + "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" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", "properties": { "createTime": { - "description": "Operation create time.", + "description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { + "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -15341,15 +17993,49 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "properties": { + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" + }, + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -15358,190 +18044,204 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", + "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", - "format": "google-datetime", - "type": "string" - }, - "displayName": { - "description": "The display name of the model.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", - "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" - ], - "enumDescriptions": [ - "Default value.", - "The model is in a paused training state.", - "The model is currently training.", - "The model has successfully completed training.", - "The model is ready for serving.", - "The model training failed." - ], - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "modelVersion": { - "description": "The version of the model.", + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", "format": "int64", "type": "string" }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", - "type": "string" - }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1betaDataStore", + "GoogleCloudDiscoveryengineV1betaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1betaInterval", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", - "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" - ], - "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search." - ], - "type": "string" + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "properties": { + "language": { + "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", "readOnly": true, "type": "string" }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "languageCode": { + "description": "The language code for the DataStore.", "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], + "normalizedLanguageCode": { + "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", + "readOnly": true, "type": "string" }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", - "description": "Language info for DataStore." - }, - "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "region": { + "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", + "readOnly": true, "type": "string" - }, - "solutionTypes": { - "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", + "properties": { + "models": { + "description": "List of custom tuning models.", "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" }, "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1betaSchema", - "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1betaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1betaProject", "properties": { "createTime": { - "description": "Operation create time.", + "description": "Output only. The timestamp when this project is created.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "readOnly": true, + "type": "string" + }, + "provisionCompletionTime": { + "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", "format": "google-datetime", + "readOnly": true, "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", "properties": { - "createTime": { - "description": "Operation create time.", + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", "format": "google-datetime", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", "type": "string" + }, + "id": { + "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", + "type": "string" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "enumDescriptions": [ + "The default value of the enum. This value is not actually used.", + "The project has given consent to the terms of service.", + "The project is pending to review and accept the terms of service.", + "The project has declined or revoked the agreement to terms of service." + ], + "type": "string" + }, + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -15550,26 +18250,28 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { + "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "purgeSample": { + "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -15584,683 +18286,673 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", - "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", "type": "string" - }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" - }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1betaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" }, - "includeAncestorHeadings": { - "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", - "type": "boolean" + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", + "GoogleCloudDiscoveryengineV1betaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1betaSchema", "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "name": { + "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1betaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequest", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + }, + "branch": { + "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", + "type": "string" + }, + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", + "type": "string" + }, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "dataStoreSpecs": { + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, "type": "array" }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", + "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." + }, + "facetSpecs": { + "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" + }, + "type": "array" + }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "description": "Raw image query." + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngine", - "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." + "offset": { + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, - "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", - "items": { - "type": "string" + "pageSize": { + "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + }, + "params": { + "additionalProperties": { + "type": "any" }, - "type": "array" + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", + "type": "object" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "query": { + "description": "Raw search query.", "type": "string" }, - "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], - "type": "string" + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, - "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "rankingExpression": { + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "regionCode": { + "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", + "type": "string" }, - "solutionType": { - "description": "Required. The solutions of the engine.", + "relevanceThreshold": { + "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" ], "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." ], "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", - "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" }, - "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", - "properties": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", - "type": "string" + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, - "location": { - "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "userPseudoId": { + "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", - "type": "string" + "conditionBoostSpecs": { + "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", "properties": { - "companyName": { - "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "boost": { + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", + "format": "float", + "type": "number" + }, + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." + }, + "condition": { + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { + "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", - "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], - "type": "string" - }, - "type": "array" - }, - "searchTier": { - "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "attributeType": { + "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" ], "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." + "Unspecified AttributeType.", + "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." ], "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" + "controlPoints": { + "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" + }, + "type": "array" }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { - "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", - "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { + "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "attributeValue": { + "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "chunkSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", + "enum": [ + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" + ], + "enumDescriptions": [ + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." + ], "type": "string" }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { - "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "numNextChunks": { + "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", + "format": "int32", + "type": "integer" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "numPreviousChunks": { + "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "gcsPrefix": { - "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" + "maxExtractiveAnswerCount": { + "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", + "format": "int32", + "type": "integer" + }, + "maxExtractiveSegmentCount": { + "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "maxSnippetCount": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "type": "boolean" + }, + "returnSnippet": { + "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", + "type": "boolean" }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", - "type": "string" + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "ignoreNonSummarySeekingQuery": { + "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", + "type": "boolean" + }, + "includeCitations": { + "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", + "type": "boolean" + }, + "languageCode": { + "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "summaryResultCount": { + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", + "format": "int32", + "type": "integer" + }, + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" - }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", + "version": { + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", + "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", "properties": { - "language": { - "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", - "readOnly": true, - "type": "string" - }, - "languageCode": { - "description": "The language code for the DataStore.", - "type": "string" - }, - "normalizedLanguageCode": { - "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", - "readOnly": true, - "type": "string" - }, - "region": { - "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", - "readOnly": true, + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "properties": { - "models": { - "description": "List of custom tuning models.", + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1betaProject", + "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, - "type": "string" - }, - "provisionCompletionTime": { - "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", - "format": "google-datetime", - "readOnly": true, + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "enableDynamicPosition": { + "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", + "type": "boolean" }, - "id": { - "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", - "type": "string" + "excludedFilterKeys": { + "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "type": "string" + }, + "type": "array" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "enumDescriptions": [ - "The default value of the enum. This value is not actually used.", - "The project has given consent to the terms of service.", - "The project is pending to review and accept the terms of service.", - "The project has declined or revoked the agreement to terms of service." - ], - "type": "string" + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "limit": { + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "contains": { + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", + "intervals": { + "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaInterval" + }, + "type": "array" + }, + "key": { + "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "orderBy": { + "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "prefixes": { + "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + }, + "restrictedValues": { + "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", + "properties": { + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { - "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], "type": "string" }, - "purgeSample": { - "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -16269,61 +18961,85 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", + "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", + "Automatic query expansion built by the Search API." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "pinUnexpandedResults": { + "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1betaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1betaSchema", + "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, - "name": { - "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", + "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." + ], "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" @@ -16560,6 +19276,52 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1betaUserInfo", + "properties": { + "userAgent": { + "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": { + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", + "properties": { + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index 1da8493f4d..0ebbac6109 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -287,6 +287,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+$", "required": true, "type": "string" + }, + "skipDefaultSchemaCreation": { + "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+parent}/dataStores", @@ -481,6 +486,39 @@ }, "resources": { "branches": { + "methods": { + "batchGetDocumentsMetadata": { + "description": "Gets index freshness metadata for Documents. Supported for website search only.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The exact URIs to match by.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/batchGetDocumentsMetadata", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "documents": { "methods": { @@ -2590,6 +2628,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write", @@ -3817,6 +3883,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "skipDefaultSchemaCreation": { + "description": "A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+parent}/dataStores", @@ -3983,6 +4054,39 @@ }, "resources": { "branches": { + "methods": { + "batchGetDocumentsMetadata": { + "description": "Gets index freshness metadata for Documents. Supported for website search only.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata", + "parameterOrder": [ + "parent" + ], + "parameters": { + "matcher.urisMatcher.uris": { + "description": "The exact URIs to match by.", + "location": "query", + "repeated": true, + "type": "string" + }, + "parent": { + "description": "Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/batchGetDocumentsMetadata", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "documents": { "methods": { @@ -5785,6 +5889,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "purge": { + "description": "Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.userEvents.purge", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/userEvents:purge", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "write": { "description": "Writes a single user event.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write", @@ -5822,6 +5954,166 @@ } } }, + "evaluations": { + "methods": { + "create": { + "description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.evaluations.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/evaluations", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Evaluation.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of Evaluations.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/evaluations", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listResults": { + "description": "Gets a list of results for a given a Evaluation.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.listResults", + "parameterOrder": [ + "evaluation" + ], + "parameters": { + "evaluation": { + "description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+evaluation}:listResults", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.evaluations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, "groundingConfigs": { "methods": { "check": { @@ -5956,311 +6248,1574 @@ } } }, - "userEvents": { + "sampleQuerySets": { "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 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}/userEvents:collect", - "httpMethod": "GET", - "id": "discoveryengine.projects.locations.userEvents.collect", + "create": { + "description": "Creates a SampleQuerySet", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ "parent" ], "parameters": { - "ets": { - "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", - "format": "int64", - "location": "query", - "type": "string" - }, "parent": { - "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "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 third-party requests.", - "location": "query", - "type": "string" - }, - "userEvent": { - "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", + "sampleQuerySetId": { + "description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, - "path": "v1beta/{+parent}/userEvents:collect", + "path": "v1beta/{+parent}/sampleQuerySets", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" + }, "response": { - "$ref": "GoogleApiHttpBody" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "write": { - "description": "Writes a single user event.", - "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", - "httpMethod": "POST", - "id": "discoveryengine.projects.locations.userEvents.write", + "delete": { + "description": "Deletes a SampleQuerySet.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SampleQuerySet.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerySets.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQuerySets", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuerySet.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" }, - "writeAsync": { - "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "updateMask": { + "description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", "location": "query", - "type": "boolean" + "type": "string" } }, - "path": "v1beta/{+parent}/userEvents:write", + "path": "v1beta/{+name}", "request": { - "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "response": { - "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "operations": { - "methods": { - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "discoveryengine.projects.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta/{+name}", - "response": { - "$ref": "GoogleLongrunningOperation" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1beta/projects/{projectsId}/operations", - "httpMethod": "GET", - "id": "discoveryengine.projects.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/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" + "resources": { + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1beta/{+name}/operations", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - }, - "revision": "20240621", - "rootUrl": "https://discoveryengine.googleapis.com/", - "schemas": { - "GoogleApiHttpBody": { - "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", - "id": "GoogleApiHttpBody", - "properties": { - "contentType": { - "description": "The HTTP Content-Type header value specifying the content type of the body.", + "sampleQueries": { + "methods": { + "create": { + "description": "Creates a SampleQuery", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + }, + "sampleQueryId": { + "description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQueries", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a SampleQuery.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "DELETE", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a SampleQuery.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "import": { + "description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQueries:import", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Gets a list of SampleQuerys.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/sampleQueries", + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a SampleQuery.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", + "httpMethod": "PATCH", + "id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "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 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}/userEvents:collect", + "httpMethod": "GET", + "id": "discoveryengine.projects.locations.userEvents.collect", + "parameterOrder": [ + "parent" + ], + "parameters": { + "ets": { + "description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", + "format": "int64", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "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 third-party requests.", + "location": "query", + "type": "string" + }, + "userEvent": { + "description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/userEvents:collect", + "response": { + "$ref": "GoogleApiHttpBody" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "write": { + "description": "Writes a single user event.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.userEvents.write", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "writeAsync": { + "description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta/{+parent}/userEvents:write", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "operations": { + "methods": { + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "discoveryengine.projects.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", + "flatPath": "v1beta/projects/{projectsId}/operations", + "httpMethod": "GET", + "id": "discoveryengine.projects.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/[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}/operations", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + }, + "revision": "20240813", + "rootUrl": "https://discoveryengine.googleapis.com/", + "schemas": { + "GoogleApiHttpBody": { + "description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", + "id": "GoogleApiHttpBody", + "properties": { + "contentType": { + "description": "The HTTP Content-Type header value specifying the content type of the body.", + "type": "string" + }, + "data": { + "description": "The HTTP request/response body as raw binary.", + "format": "byte", + "type": "string" + }, + "extensions": { + "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorContext": { + "description": "A description of the context in which an error occurred.", + "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "properties": { + "httpRequest": { + "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "description": "The HTTP request which was processed when the error was triggered." + }, + "reportLocation": { + "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingErrorLog": { + "description": "An error log which is reported to the Error Reporting system.", + "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "properties": { + "context": { + "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", + "description": "A description of the context in which the error occurred." + }, + "importPayload": { + "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "description": "The error payload that is populated on LRO import APIs." + }, + "message": { + "description": "A message describing the error.", + "type": "string" + }, + "requestPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", + "type": "object" + }, + "responsePayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", + "type": "object" + }, + "serviceContext": { + "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", + "description": "The service context in which this error has occurred." + }, + "status": { + "$ref": "GoogleRpcStatus", + "description": "The RPC status associated with the error log." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { + "description": "HTTP request data that is related to a reported error.", + "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "properties": { + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingImportErrorContext": { + "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", + "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "properties": { + "document": { + "description": "The detailed content which caused the error on importing a document.", + "type": "string" + }, + "gcsPath": { + "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", + "type": "string" + }, + "lineNumber": { + "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "type": "string" + }, + "operation": { + "description": "The operation resource name of the LRO.", + "type": "string" + }, + "userEvent": { + "description": "The detailed content which caused the error on importing a user event.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingServiceContext": { + "description": "Describes a running service that sends errors.", + "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "properties": { + "service": { + "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineLoggingSourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are reported.", + "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "properties": { + "functionName": { + "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", + "properties": { + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSite" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Condition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1Condition", + "properties": { + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + }, + "type": "array" + }, + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" + }, + "value": { + "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "properties": { + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Control": { + "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", + "id": "GoogleCloudDiscoveryengineV1Control", + "properties": { + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "description": "Defines a boost-type control" + }, + "conditions": { + "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1Condition" + }, + "type": "array" + }, + "displayName": { + "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + }, + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" + }, + "name": { + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "type": "string" + }, + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "description": "Defines a redirect-type control." + }, + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "useCases": { + "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", + "items": { + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "Value used when unset. Will not occur in CSS.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "properties": { + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "dataStore": { + "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" + }, + "filter": { + "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", + "properties": { + "dataStore": { + "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" + }, + "filter": { + "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "properties": { + "redirectUri": { + "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ControlSynonymsAction": { + "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", + "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "properties": { + "synonyms": { + "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1DataStore", + "properties": { + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "solutionTypes": { + "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" + }, + "type": "array" + }, + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1Schema", + "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1WorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "properties": { + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." + }, + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", + "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + }, + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", + "properties": { + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "properties": { + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" + }, + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", + "properties": { + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", + "properties": { + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Engine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1Engine", + "properties": { + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." + }, + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true + }, + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataStoreIds": { + "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "type": "string" + }, + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "name": { + "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "solutionType": { + "description": "Required. The solutions of the engine.", + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], "type": "string" }, - "data": { - "description": "The HTTP request/response body as raw binary.", - "format": "byte", + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, "type": "string" - }, - "extensions": { - "description": "Application specific response metadata. Must be set in the first response for streaming APIs.", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorContext": { - "description": "A description of the context in which an error occurred.", - "id": "GoogleCloudDiscoveryengineLoggingErrorContext", + "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "properties": { - "httpRequest": { - "$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", - "description": "The HTTP request which was processed when the error was triggered." + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, - "reportLocation": { - "$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", - "description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." + "dialogflowAgentToLink": { + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingErrorLog": { - "description": "An error log which is reported to the Error Reporting system.", - "id": "GoogleCloudDiscoveryengineLoggingErrorLog", + "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "properties": { - "context": { - "$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", - "description": "A description of the context in which the error occurred." + "business": { + "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "type": "string" }, - "importPayload": { - "$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", - "description": "The error payload that is populated on LRO import APIs." + "defaultLanguageCode": { + "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "type": "string" }, - "message": { - "description": "A message describing the error.", + "location": { + "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", "type": "string" }, - "requestPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "properties": { + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "properties": { + "searchAddOns": { + "description": "The add-on that this search engine enables.", + "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], + "type": "string" }, - "description": "The API request payload, represented as a protocol buffer. Most API request types are supported—for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", - "type": "object" + "type": "array" }, - "responsePayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", - "type": "object" + "searchTier": { + "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "serviceContext": { - "$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", - "description": "The service context in which this error has occurred." + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" }, - "status": { - "$ref": "GoogleRpcStatus", - "description": "The RPC status associated with the error log." + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingHttpRequestContext": { - "description": "HTTP request data that is related to a reported error.", - "id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", + "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { + "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", "properties": { - "responseStatusCode": { - "description": "The HTTP response status code for the request.", - "format": "int32", - "type": "integer" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingImportErrorContext": { - "description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", - "id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", + "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", "properties": { - "document": { - "description": "The detailed content which caused the error on importing a document.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "gcsPath": { - "description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" }, - "lineNumber": { - "description": "Line number of the content in file. Should be empty for permission or batch operation error.", + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", "type": "string" }, - "operation": { - "description": "The operation resource name of the LRO.", + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", "type": "string" }, - "userEvent": { - "description": "The detailed content which caused the error on importing a user event.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingServiceContext": { - "description": "Describes a running service that sends errors.", - "id": "GoogleCloudDiscoveryengineLoggingServiceContext", + "GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { + "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", "properties": { - "service": { - "description": "An identifier of the service—for example, `discoveryengine.googleapis.com`.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineLoggingSourceLocation": { - "description": "Indicates a location in the source code of the service for which errors are reported.", - "id": "GoogleCloudDiscoveryengineLoggingSourceLocation", + "GoogleCloudDiscoveryengineV1ImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", "properties": { - "functionName": { - "description": "Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", + "gcsPrefix": { + "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" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6275,223 +7830,223 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", - "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSite" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1Condition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1Condition", + "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", - "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", - "type": "boolean" + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", + "type": "string" }, - "value": { - "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", + "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Control": { - "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", - "id": "GoogleCloudDiscoveryengineV1Control", + "GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" - }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", - "description": "Defines a boost-type control" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." }, - "conditions": { - "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1Condition" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "displayName": { - "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Project": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1Project", + "properties": { + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" }, "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "readOnly": true, "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", - "description": "Defines a redirect-type control." - }, - "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], + "provisionCompletionTime": { + "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." - }, - "useCases": { - "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "enumDescriptions": [ - "Value used when unset. Will not occur in CSS.", - "Search use case. Expects the traffic has a non-empty query.", - "Browse use case. Expects the traffic has an empty query." - ], - "type": "string" + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" }, - "type": "array" + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1ControlBoostAction", + "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", + "type": "string" }, - "dataStore": { - "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", "type": "string" }, - "filter": { - "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "id": { + "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1ControlFilterAction", - "properties": { - "dataStore": { - "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "enum": [ + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" + ], + "enumDescriptions": [ + "The default value of the enum. This value is not actually used.", + "The project has given consent to the terms of service.", + "The project is pending to review and accept the terms of service.", + "The project has declined or revoked the agreement to terms of service." + ], "type": "string" }, - "filter": { - "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", + "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "properties": { - "redirectUri": { - "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ControlSynonymsAction": { - "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", - "id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", + "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { - "synonyms": { - "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" + }, + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", + "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -6500,26 +8055,28 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", + "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { + "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "purgeSample": { + "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6534,181 +8091,181 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1Schema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1Schema", + "properties": { + "jsonSchema": { + "description": "The JSON representation of the schema.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "name": { + "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1DataStore", + "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { + "description": "Verification information for target sites in advanced site search.", + "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", "properties": { - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "siteVerificationState": { + "description": "Site verification state indicating the ownership and validity.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "SITE_VERIFICATION_STATE_UNSPECIFIED", + "VERIFIED", + "UNVERIFIED", + "EXEMPTED" ], "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search." + "Defaults to VERIFIED.", + "Site ownership verified.", + "Site ownership pending verification or verification failed.", + "Site exempt from verification, e.g., a public website that opens to all." ], "type": "string" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", + "verifyTime": { + "description": "Latest site verification time.", "format": "google-datetime", - "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1TargetSite": { + "description": "A target site for the SiteSearchEngine.", + "id": "GoogleCloudDiscoveryengineV1TargetSite", + "properties": { + "exactMatch": { + "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" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", - "readOnly": true, - "type": "string" + "failureReason": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "description": "Output only. Failure reason.", + "readOnly": true }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "generatedUriPattern": { + "description": "Output only. This is system-generated based on the provided_uri_pattern.", + "readOnly": true, "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "indexingStatus": { + "description": "Output only. Indexing status.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "INDEXING_STATUS_UNSPECIFIED", + "PENDING", + "FAILED", + "SUCCEEDED", + "DELETING" ], "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." + "Defaults to SUCCEEDED.", + "The target site is in the update queue and will be picked up by indexing pipeline.", + "The target site fails to be indexed.", + "The target site has been indexed.", + "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], + "readOnly": true, "type": "string" }, "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", + "readOnly": true, "type": "string" }, - "solutionTypes": { - "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", - "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], - "type": "string" - }, - "type": "array" - }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1Schema", - "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "providedUriPattern": { + "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "rootDomainUri": { + "description": "Output only. Root domain of the provided_uri_pattern.", + "readOnly": true, "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "siteVerificationInfo": { + "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", + "description": "Output only. Site ownership and validity verification status.", + "readOnly": true + }, + "type": { + "description": "The type of the target site, e.g., whether the site is to be included or excluded.", + "enum": [ + "TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" + ], + "enumDescriptions": [ + "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", + "Include the target site.", + "Exclude the target site." + ], "type": "string" }, "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", + "description": "Output only. The target site's last updated time.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { + "description": "Site search indexing failure reasons.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "quotaFailure": { + "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "description": "Failed due to insufficient quota." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { + "description": "Failed due to insufficient quota.", + "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "totalRequiredQuota": { + "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata": { + "description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6723,878 +8280,601 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1TrainCustomModelResponse": { + "description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1TrainCustomModelResponse", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", - "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the data.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "parsingConfigOverrides": { + "metrics": { "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" + "format": "double", + "type": "number" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "description": "The metrics of the trained model.", "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", - "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" - }, - "includeAncestorHeadings": { - "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", - "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." - }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." - }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", - "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", - "items": { - "type": "string" - }, - "type": "array" }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "modelName": { + "description": "Fully qualified name of the CustomTuningModel.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "modelStatus": { + "description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1Engine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1Engine", + "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { + "description": "Metadata for UpdateSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", + "description": "Operation create time.", "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", - "items": { - "type": "string" - }, - "type": "array" - }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", - "type": "string" - }, - "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], - "type": "string" - }, - "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", - "type": "string" - }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." - }, - "solutionType": { - "description": "Required. The solutions of the engine.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], "type": "string" }, "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", - "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", + "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1WorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1WorkspaceConfig", "properties": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", - "type": "string" - }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", - "type": "string" - }, - "location": { - "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", - "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", + "GoogleCloudDiscoveryengineV1alphaAclConfig": { + "description": "Access Control Configuration.", + "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "properties": { - "companyName": { - "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Identity provider config." + }, + "name": { + "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaAnswer": { + "description": "Defines an answer.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "answerSkippedReasons": { + "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "items": { "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" + "ANSWER_SKIPPED_REASON_UNSPECIFIED", + "ADVERSARIAL_QUERY_IGNORED", + "NON_ANSWER_SEEKING_QUERY_IGNORED", + "OUT_OF_DOMAIN_QUERY_IGNORED", + "POTENTIAL_POLICY_VIOLATION", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." + "Default value. The answer skipped reason is not specified.", + "The adversarial query ignored case.", + "The non-answer seeking query ignored case.", + "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", + "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, "type": "array" }, - "searchTier": { - "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], + "answerText": { + "description": "The textual answer.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", + }, + "citations": { + "description": "Citations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" + }, + "type": "array" + }, + "completeTime": { + "description": "Output only. Answer completed timestamp.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", + "createTime": { + "description": "Output only. Answer creation timestamp.", + "format": "google-datetime", + "readOnly": true, "type": "string" }, - "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", + "name": { + "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { - "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", - "id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", - "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "queryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "description": "Query understanding information." }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "references": { + "description": "References.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "relatedQuestions": { + "description": "Suggested related questions.", + "items": { + "type": "string" + }, + "type": "array" }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", + "state": { + "description": "The state of the answer generation.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Answer generation is currently in progress.", + "Answer generation currently failed.", + "Answer generation has succeeded." + ], "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "steps": { + "description": "Answer generation steps.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { - "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { + "description": "Citation info for a segment.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "endIndex": { + "description": "End of the attributed segment, exclusive.", + "format": "int64", + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "sources": { + "description": "Citation sources for the attributed segment.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1ImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "properties": { - "gcsPrefix": { - "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.", + }, + "startIndex": { + "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { + "description": "Citation source.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "referenceId": { + "description": "ID of the citation source.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { + "description": "Query understanding information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "queryClassificationInfo": { + "description": "Query classification information.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" }, "type": "array" - }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", - "type": "string" - }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { + "description": "Query classification information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" + "positive": { + "description": "Classification output.", + "type": "boolean" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "type": { + "description": "Query classification type.", + "enum": [ + "TYPE_UNSPECIFIED", + "ADVERSARIAL_QUERY", + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" + ], + "enumDescriptions": [ + "Unspecified query classification type.", + "Adversarial query classification type.", + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReference": { + "description": "Reference.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "chunkInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "description": "Chunk information." }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", - "type": "string" + "unstructuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "description": "Unstructured document information." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Project": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1Project", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, + "content": { + "description": "Chunk textual content.", "type": "string" }, - "provisionCompletionTime": { - "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "documentMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "description": "Document metadata." }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { + "description": "Document metadata.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", + "document": { + "description": "Document resource name.", "type": "string" }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" }, - "id": { - "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", - "type": "string" + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", - "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" - ], - "enumDescriptions": [ - "The default value of the enum. This value is not actually used.", - "The project has given consent to the terms of service.", - "The project is pending to review and accept the terms of service.", - "The project has declined or revoked the agreement to terms of service." - ], + "title": { + "description": "Title.", "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "document": { + "description": "Document resource name.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { + "description": "Unstructured document information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "chunkContents": { + "description": "List of cited chunk contents derived from document content.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", - "type": "boolean" + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "type": "object" + }, + "title": { + "description": "Title.", + "type": "string" + }, + "uri": { + "description": "URI for the document.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { + "description": "Chunk content.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", + "content": { + "description": "Chunk textual content.", "type": "string" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", + "pageIdentifier": { + "description": "Page identifier.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { - "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStep": { + "description": "Step information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", - "type": "string" - }, - "purgeSample": { - "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", + "actions": { + "description": "Actions.", "items": { - "type": "string" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" + }, + "description": { + "description": "The description of the step.", + "type": "string" + }, + "state": { + "description": "The state of the step.", + "enum": [ + "STATE_UNSPECIFIED", + "IN_PROGRESS", + "FAILED", + "SUCCEEDED" + ], + "enumDescriptions": [ + "Unknown.", + "Step is currently in progress.", + "Step currently failed.", + "Step has succeeded." + ], + "type": "string" + }, + "thought": { + "description": "The thought of the step.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { + "description": "Action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "observation": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", + "description": "Observation." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "searchAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "description": "Search action." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { + "description": "Observation.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "searchResults": { + "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1Schema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1Schema", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { - "jsonSchema": { - "description": "The JSON representation of the schema.", - "type": "string" + "chunkInfo": { + "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" + }, + "type": "array" }, - "name": { - "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "document": { + "description": "Document resource name.", "type": "string" }, - "structSchema": { + "snippetInfo": { + "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" + }, + "type": "array" + }, + "structData": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, - "description": "The structured representation of the schema.", + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1SiteVerificationInfo": { - "description": "Verification information for target sites in advanced site search.", - "id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", - "properties": { - "siteVerificationState": { - "description": "Site verification state indicating the ownership and validity.", - "enum": [ - "SITE_VERIFICATION_STATE_UNSPECIFIED", - "VERIFIED", - "UNVERIFIED", - "EXEMPTED" - ], - "enumDescriptions": [ - "Defaults to VERIFIED.", - "Site ownership verified.", - "Site ownership pending verification or verification failed.", - "Site exempt from verification, e.g., a public website that opens to all." - ], + }, + "title": { + "description": "Title.", "type": "string" }, - "verifyTime": { - "description": "Latest site verification time.", - "format": "google-datetime", + "uri": { + "description": "URI for the document.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSite": { - "description": "A target site for the SiteSearchEngine.", - "id": "GoogleCloudDiscoveryengineV1TargetSite", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { + "description": "Chunk information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { - "exactMatch": { - "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" - }, - "failureReason": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", - "description": "Output only. Failure reason.", - "readOnly": true - }, - "generatedUriPattern": { - "description": "Output only. This is system-generated based on the provided_uri_pattern.", - "readOnly": true, - "type": "string" - }, - "indexingStatus": { - "description": "Output only. Indexing status.", - "enum": [ - "INDEXING_STATUS_UNSPECIFIED", - "PENDING", - "FAILED", - "SUCCEEDED", - "DELETING" - ], - "enumDescriptions": [ - "Defaults to SUCCEEDED.", - "The target site is in the update queue and will be picked up by indexing pipeline.", - "The target site fails to be indexed.", - "The target site has been indexed.", - "The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." - ], - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", - "readOnly": true, - "type": "string" - }, - "providedUriPattern": { - "description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", - "type": "string" - }, - "rootDomainUri": { - "description": "Output only. Root domain of the provided_uri_pattern.", - "readOnly": true, + "chunk": { + "description": "Chunk resource name.", "type": "string" }, - "siteVerificationInfo": { - "$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", - "description": "Output only. Site ownership and validity verification status.", - "readOnly": true - }, - "type": { - "description": "The type of the target site, e.g., whether the site is to be included or excluded.", - "enum": [ - "TYPE_UNSPECIFIED", - "INCLUDE", - "EXCLUDE" - ], - "enumDescriptions": [ - "This value is unused. In this case, server behavior defaults to Type.INCLUDE.", - "Include the target site.", - "Exclude the target site." - ], + "content": { + "description": "Chunk textual content.", "type": "string" }, - "updateTime": { - "description": "Output only. The target site's last updated time.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { - "description": "Site search indexing failure reasons.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { + "description": "Snippet information.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", "properties": { - "quotaFailure": { - "$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", - "description": "Failed due to insufficient quota." + "snippet": { + "description": "Snippet content.", + "type": "string" + }, + "snippetStatus": { + "description": "Status of the snippet defined by the search team.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { - "description": "Failed due to insufficient quota.", - "id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", + "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { + "description": "Search action.", + "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", "properties": { - "totalRequiredQuota": { - "description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", - "format": "int64", + "query": { + "description": "The query to search.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { - "description": "Metadata for UpdateSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7609,599 +8889,756 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { + "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", + "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "targetSites": { + "description": "TargetSites created.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCondition": { + "description": "Defines circumstances to be checked before allowing a behavior", + "id": "GoogleCloudDiscoveryengineV1alphaCondition", + "properties": { + "activeTimeRange": { + "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "queryTerms": { + "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { + "description": "Matcher for search request query", + "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", + "properties": { + "fullMatch": { + "description": "Whether the search query needs to exactly match the query term.", + "type": "boolean" + }, + "value": { + "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAclConfig": { - "description": "Access Control Configuration.", - "id": "GoogleCloudDiscoveryengineV1alphaAclConfig", + "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { + "description": "Used for time-dependent conditions.", + "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", "properties": { - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Identity provider config." + "endTime": { + "description": "End of time range. Range is inclusive. Must be in the future.", + "format": "google-datetime", + "type": "string" }, - "name": { - "description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "startTime": { + "description": "Start of time range. Range is inclusive.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswer": { - "description": "Defines an answer.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswer", + "GoogleCloudDiscoveryengineV1alphaControl": { + "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", + "id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { - "answerSkippedReasons": { - "description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", + "associatedServingConfigIds": { + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { - "enum": [ - "ANSWER_SKIPPED_REASON_UNSPECIFIED", - "ADVERSARIAL_QUERY_IGNORED", - "NON_ANSWER_SEEKING_QUERY_IGNORED", - "OUT_OF_DOMAIN_QUERY_IGNORED", - "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" - ], - "enumDescriptions": [ - "Default value. The answer skipped reason is not specified.", - "The adversarial query ignored case.", - "The non-answer seeking query ignored case.", - "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", - "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." - ], "type": "string" }, + "readOnly": true, "type": "array" }, - "answerText": { - "description": "The textual answer.", - "type": "string" + "boostAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "description": "Defines a boost-type control" }, - "citations": { - "description": "Citations.", + "conditions": { + "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" + "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" }, "type": "array" }, - "completeTime": { - "description": "Output only. Answer completed timestamp.", - "format": "google-datetime", - "readOnly": true, + "displayName": { + "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, - "createTime": { - "description": "Output only. Answer creation timestamp.", - "format": "google-datetime", - "readOnly": true, - "type": "string" + "filterAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "description": "Defines a filter-type control Currently not supported by Recommendation" }, "name": { - "description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", + "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, - "queryUnderstandingInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", - "description": "Query understanding information." - }, - "references": { - "description": "References.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" - }, - "type": "array" - }, - "relatedQuestions": { - "description": "Suggested related questions.", - "items": { - "type": "string" - }, - "type": "array" + "redirectAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "description": "Defines a redirect-type control." }, - "state": { - "description": "The state of the answer generation.", + "solutionType": { + "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" ], "enumDescriptions": [ - "Unknown.", - "Answer generation is currently in progress.", - "Answer generation currently failed.", - "Answer generation has succeeded." + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." ], "type": "string" }, - "steps": { - "description": "Answer generation steps.", + "synonymsAction": { + "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "description": "Treats a group of terms as synonyms of one another." + }, + "useCases": { + "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" + "enum": [ + "SEARCH_USE_CASE_UNSPECIFIED", + "SEARCH_USE_CASE_SEARCH", + "SEARCH_USE_CASE_BROWSE" + ], + "enumDescriptions": [ + "Value used when unset. Will not occur in CSS.", + "Search use case. Expects the traffic has a non-empty query.", + "Browse use case. Expects the traffic has an empty query." + ], + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitation": { - "description": "Citation info for a segment.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", + "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { + "description": "Adjusts order of products in returned list.", + "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { - "endIndex": { - "description": "End of the attributed segment, exclusive.", - "format": "int64", + "boost": { + "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", + "format": "float", + "type": "number" + }, + "dataStore": { + "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, - "sources": { - "description": "Citation sources for the attributed segment.", + "filter": { + "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { + "description": "Specified which products may be included in results. Uses same filter as boost.", + "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "properties": { + "dataStore": { + "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "type": "string" + }, + "filter": { + "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { + "description": "Redirects a shopper to the provided URI.", + "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "properties": { + "redirectUri": { + "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { + "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", + "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "properties": { + "synonyms": { + "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" + "type": "string" }, "type": "array" - }, - "startIndex": { - "description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { - "description": "Citation source.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", + "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", "properties": { - "referenceId": { - "description": "ID of the citation source.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { - "description": "Query understanding information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", + "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { - "queryClassificationInfo": { - "description": "Query classification information.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" - }, - "type": "array" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { - "description": "Query classification information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", + "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { + "description": "Metadata for Create Schema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { - "positive": { - "description": "Classification output.", - "type": "boolean" + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "type": { - "description": "Query classification type.", - "enum": [ - "TYPE_UNSPECIFIED", - "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" - ], - "enumDescriptions": [ - "Unspecified query classification type.", - "Adversarial query classification type.", - "Non-answer-seeking query classification type." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReference": { - "description": "Reference.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", + "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { - "chunkInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", - "description": "Chunk information." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "unstructuredDocumentInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", - "description": "Unstructured document information." + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", + "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { + "description": "Defines custom fine tuning spec.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { - "chunk": { - "description": "Chunk resource name.", - "type": "string" - }, - "content": { - "description": "Chunk textual content.", - "type": "string" - }, - "documentMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", - "description": "Document metadata." - }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" + "enableSearchAdaptor": { + "description": "Whether or not to enable and include custom fine tuned search adaptor model.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { - "description": "Document metadata.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", + "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { + "description": "Metadata that describes a custom tuned model.", + "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", "properties": { - "document": { - "description": "Document resource name.", + "createTime": { + "deprecated": true, + "description": "Timestamp the Model was created at.", + "format": "google-datetime", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "displayName": { + "description": "The display name of the model.", "type": "string" }, - "structData": { + "metrics": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "format": "double", + "type": "number" }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", + "description": "The metrics of the trained model.", "type": "object" }, - "title": { - "description": "Title.", + "modelState": { + "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "enum": [ + "MODEL_STATE_UNSPECIFIED", + "TRAINING_PAUSED", + "TRAINING", + "TRAINING_COMPLETE", + "READY_FOR_SERVING", + "TRAINING_FAILED", + "NO_IMPROVEMENT" + ], + "enumDescriptions": [ + "Default value.", + "The model is in a paused training state.", + "The model is currently training.", + "The model has successfully completed training.", + "The model is ready for serving.", + "The model training failed.", + "The model training finished successfully but metrics did not improve." + ], "type": "string" }, - "uri": { - "description": "URI for the document.", + "modelVersion": { + "description": "The version of the model.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", + "type": "string" + }, + "trainingStartTime": { + "description": "Timestamp the model training was initiated.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { - "description": "Unstructured document information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", + "GoogleCloudDiscoveryengineV1alphaDataStore": { + "description": "DataStore captures global settings and configs at the DataStore level.", + "id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { - "chunkContents": { - "description": "List of cited chunk contents derived from document content.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" - }, - "type": "array" + "aclEnabled": { + "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", + "type": "boolean" }, - "document": { - "description": "Document resource name.", + "contentConfig": { + "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "enum": [ + "CONTENT_CONFIG_UNSPECIFIED", + "NO_CONTENT", + "CONTENT_REQUIRED", + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" + ], + "enumDescriptions": [ + "Default value.", + "Only contains documents without any Document.content.", + "Only contains documents with Document.content.", + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." + ], "type": "string" }, - "structData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "createTime": { + "description": "Output only. Timestamp the DataStore was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "defaultSchemaId": { + "description": "Output only. The id of the default Schema asscociated to this data store.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "type": "string" + }, + "documentProcessingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "description": "Configuration for Document understanding and enrichment." + }, + "idpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "description": "Output only. Data store level identity provider config.", + "readOnly": true + }, + "industryVertical": { + "description": "Immutable. The industry vertical that the data store registers.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "languageInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "description": "Language info for DataStore." + }, + "name": { + "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "solutionTypes": { + "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "items": { + "enum": [ + "SOLUTION_TYPE_UNSPECIFIED", + "SOLUTION_TYPE_RECOMMENDATION", + "SOLUTION_TYPE_SEARCH", + "SOLUTION_TYPE_CHAT", + "SOLUTION_TYPE_GENERATIVE_CHAT" + ], + "enumDescriptions": [ + "Default value.", + "Used for Recommendations AI.", + "Used for Discovery Search.", + "Used for use cases related to the Generative AI agent.", + "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." + ], + "type": "string" }, - "description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", - "type": "object" + "type": "array" }, - "title": { - "description": "Title.", - "type": "string" + "startingSchema": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", + "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." }, - "uri": { - "description": "URI for the document.", - "type": "string" + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { - "description": "Chunk content.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", + "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { + "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { - "content": { - "description": "Chunk textual content.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "pageIdentifier": { - "description": "Page identifier.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStep": { - "description": "Step information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", + "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { + "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { - "actions": { - "description": "Actions.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" - }, - "type": "array" - }, - "description": { - "description": "The description of the step.", - "type": "string" - }, - "state": { - "description": "The state of the step.", - "enum": [ - "STATE_UNSPECIFIED", - "IN_PROGRESS", - "FAILED", - "SUCCEEDED" - ], - "enumDescriptions": [ - "Unknown.", - "Step is currently in progress.", - "Step currently failed.", - "Step has succeeded." - ], + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "thought": { - "description": "The thought of the step.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { - "description": "Action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", + "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { + "description": "Metadata for DeleteSchema LRO.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { - "observation": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "description": "Observation." + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" }, - "searchAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", - "description": "Search action." - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { - "description": "Observation.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", - "properties": { - "searchResults": { - "description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" - }, - "type": "array" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", + "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { - "chunkInfo": { - "description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" - }, - "type": "array" - }, - "document": { - "description": "Document resource name.", - "type": "string" - }, - "snippetInfo": { - "description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" - }, - "type": "array" - }, - "title": { - "description": "Title.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "uri": { - "description": "URI for the document.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { - "description": "Chunk information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", "properties": { - "chunk": { - "description": "Chunk resource name.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "content": { - "description": "Chunk textual content.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "relevanceScore": { - "description": "Relevance score.", - "format": "float", - "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { - "description": "Snippet information.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", + "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { + "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { - "snippet": { - "description": "Snippet content.", - "type": "string" + "chunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "description": "Whether chunking mode is enabled." }, - "snippetStatus": { - "description": "Status of the snippet defined by the search team.", + "defaultParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", + "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." + }, + "name": { + "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" + }, + "parsingConfigOverrides": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" + }, + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { - "description": "Search action.", - "id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { + "description": "Configuration for chunking config.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", "properties": { - "query": { - "description": "The query to search.", - "type": "string" + "layoutBasedChunkingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "description": "Configuration for the layout based chunking." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { + "description": "Configuration for the layout based chunking.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "chunkSize": { + "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "includeAncestorHeadings": { + "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { - "description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", - "id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { + "description": "Related configurations applied to a specific type of document parser.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { - "targetSites": { - "description": "TargetSites created.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" - }, - "type": "array" + "digitalParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "description": "Configurations applied to digital parser." + }, + "layoutParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "description": "Configurations applied to layout parser." + }, + "ocrParsingConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCondition": { - "description": "Defines circumstances to be checked before allowing a behavior", - "id": "GoogleCloudDiscoveryengineV1alphaCondition", + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { + "description": "The digital parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { + "description": "The layout parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { + "description": "The OCR parsing configurations for documents.", + "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { - "activeTimeRange": { - "description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", + "enhancedDocumentElements": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" + "type": "string" }, "type": "array" }, - "queryTerms": { - "description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { - "description": "Matcher for search request query", - "id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", - "properties": { - "fullMatch": { - "description": "Whether the search query needs to exactly match the query term.", + "useNativeText": { + "description": "If true, will use native text instead of OCR text on pages containing native text.", "type": "boolean" - }, - "value": { - "description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { - "description": "Used for time-dependent conditions.", - "id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { - "endTime": { - "description": "End of time range. Range is inclusive. Must be in the future.", + "createTime": { + "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "startTime": { - "description": "Start of time range. Range is inclusive.", + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControl": { - "description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", - "id": "GoogleCloudDiscoveryengineV1alphaControl", + "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { + "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", + "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngine": { + "description": "Metadata that describes the training and serving parameters of an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { - "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", - "items": { - "type": "string" - }, - "readOnly": true, - "type": "array" + "chatEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, - "boostAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", - "description": "Defines a boost-type control" + "chatEngineMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", + "readOnly": true }, - "conditions": { - "description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", + "commonConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "description": "Common config spec that specifies the metadata of the engine." + }, + "createTime": { + "description": "Output only. Timestamp the Recommendation Engine was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataStoreIds": { + "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCondition" + "type": "string" }, "type": "array" }, "displayName": { - "description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, - "filterAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", - "description": "Defines a filter-type control Currently not supported by Recommendation" + "industryVertical": { + "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", + "enum": [ + "INDUSTRY_VERTICAL_UNSPECIFIED", + "GENERIC", + "MEDIA", + "HEALTHCARE_FHIR" + ], + "enumDescriptions": [ + "Value used when unset.", + "The generic vertical for documents that are not specific to any industry vertical.", + "The media industry vertical.", + "The healthcare FHIR vertical." + ], + "type": "string" + }, + "mediaRecommendationEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." }, "name": { - "description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", + "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, - "redirectAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", - "description": "Defines a redirect-type control." + "recommendationMetadata": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", + "readOnly": true + }, + "searchEngineConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + }, + "similarDocumentsConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "description": "Additional config specs for a `similar-items` engine." }, "solutionType": { - "description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", + "description": "Required. The solutions of the engine.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -8218,351 +9655,561 @@ ], "type": "string" }, - "synonymsAction": { - "$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", - "description": "Treats a group of terms as synonyms of one another." + "updateTime": { + "description": "Output only. Timestamp the Recommendation Engine was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { + "description": "Configurations for a Chat Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "properties": { + "agentCreationConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, - "useCases": { - "description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", - "items": { - "enum": [ - "SEARCH_USE_CASE_UNSPECIFIED", - "SEARCH_USE_CASE_SEARCH", - "SEARCH_USE_CASE_BROWSE" - ], - "enumDescriptions": [ - "Value used when unset. Will not occur in CSS.", - "Search use case. Expects the traffic has a non-empty query.", - "Browse use case. Expects the traffic has an empty query." - ], - "type": "string" - }, - "type": "array" + "dialogflowAgentToLink": { + "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlBoostAction": { - "description": "Adjusts order of products in returned list.", - "id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { + "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { - "boost": { - "description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", - "format": "float", - "type": "number" + "business": { + "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "type": "string" }, - "dataStore": { - "description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "defaultLanguageCode": { + "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" }, - "filter": { - "description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "location": { + "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "type": "string" + }, + "timeZone": { + "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { + "description": "Additional information of a Chat Engine. Fields in this message are output only.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "properties": { + "dialogflowAgent": { + "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { + "description": "Common configurations for an Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "properties": { + "companyName": { + "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { + "description": "Additional config specs for a Media Recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "properties": { + "optimizationObjective": { + "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "type": "string" + }, + "optimizationObjectiveConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + }, + "trainingState": { + "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "enum": [ + "TRAINING_STATE_UNSPECIFIED", + "PAUSED", + "TRAINING" + ], + "enumDescriptions": [ + "Unspecified training state.", + "The engine training is paused.", + "The engine is training." + ], + "type": "string" + }, + "type": { + "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlFilterAction": { - "description": "Specified which products may be included in results. Uses same filter as boost.", - "id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", + "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { + "description": "Custom threshold for `cvr` optimization_objective.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { - "dataStore": { - "description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", + "targetField": { + "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, - "filter": { - "description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", - "type": "string" + "targetFieldValueFloat": { + "description": "Required. The threshold to be applied to the target (e.g., 0.5).", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { - "description": "Redirects a shopper to the provided URI.", - "id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", + "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { + "description": "Additional information of a recommendation engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { - "redirectUri": { - "description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", + "dataState": { + "description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", + "enum": [ + "DATA_STATE_UNSPECIFIED", + "DATA_OK", + "DATA_ERROR" + ], + "enumDescriptions": [ + "Unspecified default value, should never be explicitly set.", + "The engine has sufficient training data.", + "The engine does not have sufficient training data. Error messages can be queried via Stackdriver." + ], + "readOnly": true, + "type": "string" + }, + "lastTuneTime": { + "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "servingState": { + "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", + "enum": [ + "SERVING_STATE_UNSPECIFIED", + "INACTIVE", + "ACTIVE", + "TUNED" + ], + "enumDescriptions": [ + "Unspecified serving state.", + "The engine is not serving.", + "The engine is serving and can be queried.", + "The engine is trained on tuned hyperparameters and can be queried." + ], + "readOnly": true, + "type": "string" + }, + "tuningOperation": { + "description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { - "description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", - "id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", + "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { + "description": "Configurations for a Search Engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", "properties": { - "synonyms": { - "description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", + "searchAddOns": { + "description": "The add-on that this search engine enables.", "items": { + "enum": [ + "SEARCH_ADD_ON_UNSPECIFIED", + "SEARCH_ADD_ON_LLM" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Large language model add-on." + ], "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "searchTier": { + "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", + "enum": [ + "SEARCH_TIER_UNSPECIFIED", + "SEARCH_TIER_STANDARD", + "SEARCH_TIER_ENTERPRISE" + ], + "enumDescriptions": [ + "Default value when the enum is unspecified. This is invalid to use.", + "Standard tier.", + "Enterprise tier." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { + "description": "Additional config specs for a `similar-items` engine.", + "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { + "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { - "description": "Metadata for Create Schema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { + "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "dataSizeBytes": { + "description": "Data size in terms of bytes.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "documentCount": { + "description": "Total number of documents.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "properties": { "createTime": { - "description": "Operation create time.", + "description": "Output only. Timestamp the Evaluation was created at.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { - "description": "Metadata that describes a custom tuned model.", - "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", - "properties": { - "createTime": { - "description": "Timestamp the Model was created at.", + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", "format": "google-datetime", + "readOnly": true, "type": "string" }, - "displayName": { - "description": "The display name of the model.", + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, - "modelState": { - "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the evaluation.", "enum": [ - "MODEL_STATE_UNSPECIFIED", - "TRAINING_PAUSED", - "TRAINING", - "TRAINING_COMPLETE", - "READY_FOR_SERVING", - "TRAINING_FAILED" + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" ], "enumDescriptions": [ - "Default value.", - "The model is in a paused training state.", - "The model is currently training.", - "The model has successfully completed training.", - "The model is ready for serving.", - "The model training failed." + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." ], + "readOnly": true, "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." }, - "modelVersion": { - "description": "The version of the model.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", - "type": "string" - }, - "trainingStartTime": { - "description": "Timestamp the model training was initiated.", - "format": "google-datetime", + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", + "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", + "properties": { + "sampleQuerySet": { + "description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDataStore": { - "description": "DataStore captures global settings and configs at the DataStore level.", - "id": "GoogleCloudDiscoveryengineV1alphaDataStore", + "GoogleCloudDiscoveryengineV1alphaFieldConfig": { + "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", + "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", "properties": { - "aclEnabled": { - "description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", - "type": "boolean" + "advancedSiteSearchDataSources": { + "description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", + "items": { + "enum": [ + "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", + "METATAGS", + "PAGEMAP", + "URI_PATTERN_MAPPING", + "SCHEMA_ORG" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrieve value from meta tag.", + "Retrieve value from page map.", + "Retrieve value from the attributes set by SiteSearchEngineService.SetUriPatternDocumentData API.", + "Retrieve value from schema.org data." + ], + "type": "string" + }, + "type": "array" + }, + "completableOption": { + "description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "COMPLETABLE_OPTION_UNSPECIFIED", + "COMPLETABLE_ENABLED", + "COMPLETABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Completable option enabled for a schema field.", + "Completable option disabled for a schema field." + ], + "type": "string" }, - "contentConfig": { - "description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", + "dynamicFacetableOption": { + "description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ - "CONTENT_CONFIG_UNSPECIFIED", - "NO_CONTENT", - "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", + "DYNAMIC_FACETABLE_ENABLED", + "DYNAMIC_FACETABLE_DISABLED" ], "enumDescriptions": [ - "Default value.", - "Only contains documents without any Document.content.", - "Only contains documents with Document.content.", - "The data store is used for public website search." + "Value used when unset.", + "Dynamic facetable option enabled for a schema field.", + "Dynamic facetable option disabled for a schema field." ], "type": "string" }, - "createTime": { - "description": "Output only. Timestamp the DataStore was created at.", - "format": "google-datetime", - "readOnly": true, + "fieldPath": { + "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" }, - "defaultSchemaId": { - "description": "Output only. The id of the default Schema asscociated to this data store.", + "fieldType": { + "description": "Output only. Raw type of the field.", + "enum": [ + "FIELD_TYPE_UNSPECIFIED", + "OBJECT", + "STRING", + "NUMBER", + "INTEGER", + "BOOLEAN", + "GEOLOCATION", + "DATETIME" + ], + "enumDescriptions": [ + "Field type is unspecified.", + "Field value type is Object.", + "Field value type is String.", + "Field value type is Number.", + "Field value type is Integer.", + "Field value type is Boolean.", + "Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", + "Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" + ], "readOnly": true, "type": "string" }, - "displayName": { - "description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", + "indexableOption": { + "description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "INDEXABLE_OPTION_UNSPECIFIED", + "INDEXABLE_ENABLED", + "INDEXABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Indexable option enabled for a schema field.", + "Indexable option disabled for a schema field." + ], "type": "string" }, - "documentProcessingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", - "description": "Configuration for Document understanding and enrichment." - }, - "idpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", - "description": "Output only. Data store level identity provider config.", - "readOnly": true + "keyPropertyType": { + "description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", + "readOnly": true, + "type": "string" }, - "industryVertical": { - "description": "Immutable. The industry vertical that the data store registers.", + "recsFilterableOption": { + "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" + "FILTERABLE_OPTION_UNSPECIFIED", + "FILTERABLE_ENABLED", + "FILTERABLE_DISABLED" ], "enumDescriptions": [ "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." + "Filterable option enabled for a schema field.", + "Filterable option disabled for a schema field." ], "type": "string" }, - "languageInfo": { - "$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", - "description": "Language info for DataStore." - }, - "name": { - "description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "retrievableOption": { + "description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "RETRIEVABLE_OPTION_UNSPECIFIED", + "RETRIEVABLE_ENABLED", + "RETRIEVABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Retrievable option enabled for a schema field.", + "Retrievable option disabled for a schema field." + ], "type": "string" }, - "solutionTypes": { - "description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", + "schemaOrgPaths": { + "description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", "items": { - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], "type": "string" }, "type": "array" }, - "startingSchema": { - "$ref": "GoogleCloudDiscoveryengineV1alphaSchema", - "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + "searchableOption": { + "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", + "enum": [ + "SEARCHABLE_OPTION_UNSPECIFIED", + "SEARCHABLE_ENABLED", + "SEARCHABLE_DISABLED" + ], + "enumDescriptions": [ + "Value used when unset.", + "Searchable option enabled for a schema field.", + "Searchable option disabled for a schema field." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { - "description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", + "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "documentDataMap": { + "additionalProperties": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + }, + "description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaIdpConfig": { + "description": "Identity Provider Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "properties": { + "externalIdpConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "description": "External Identity provider config." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "idpType": { + "description": "Identity provider type configured.", + "enum": [ + "IDP_TYPE_UNSPECIFIED", + "GSUITE", + "THIRD_PARTY" + ], + "enumDescriptions": [ + "Default value. ACL search not enabled.", + "Google 1P provider.", + "Third party provider." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { - "description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { + "description": "Third party IDP Config.", + "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "workforcePoolName": { + "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { - "description": "Metadata for DeleteSchema LRO.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of CompletionSuggestions that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of CompletionSuggestions successfully imported.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -8571,32 +10218,48 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", + "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { + "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { + "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of entries that were processed.", + "format": "int64", + "type": "string" + }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -8605,118 +10268,88 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { - "description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", + "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { + "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { - "chunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", - "description": "Whether chunking mode is enabled." - }, - "defaultParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", - "description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." - }, - "name": { - "description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", - "type": "string" + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors in the request if set." }, - "parsingConfigOverrides": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", - "type": "object" + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { - "description": "Configuration for chunking config.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { + "description": "Configuration of destination for Import related errors.", + "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { - "layoutBasedChunkingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", - "description": "Configuration for the layout based chunking." + "gcsPrefix": { + "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" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { - "description": "Configuration for the layout based chunking.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { - "chunkSize": { - "description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", - "format": "int32", - "type": "integer" + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", + "type": "string" }, - "includeAncestorHeadings": { - "description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", - "type": "boolean" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { - "description": "Related configurations applied to a specific type of document parser.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", - "properties": { - "digitalParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "description": "Configurations applied to digital parser." + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" }, - "layoutParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "description": "Configurations applied to layout parser." + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" }, - "ocrParsingConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", - "description": "Configurations applied to OCR parser. Currently it only applies to PDFs." + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { - "description": "The digital parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { - "description": "The layout parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { - "description": "The OCR parsing configurations for documents.", - "id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", + "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { + "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { - "enhancedDocumentElements": { - "deprecated": true, - "description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" - }, - "useNativeText": { - "description": "If true, will use native text instead of OCR text on pages containing native text.", - "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8731,1159 +10364,1262 @@ }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { - "description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", - "id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEngine": { - "description": "Metadata that describes the training and serving parameters of an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngine", + "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { - "chatEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", - "description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." - }, - "chatEngineMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", - "description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", - "readOnly": true - }, - "commonConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", - "description": "Common config spec that specifies the metadata of the engine." - }, - "createTime": { - "description": "Output only. Timestamp the Recommendation Engine was created at.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "dataStoreIds": { - "description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", "items": { - "type": "string" + "$ref": "GoogleRpcStatus" }, "type": "array" }, - "displayName": { - "description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", + "failedEntriesCount": { + "description": "Count of deny list entries that failed to be imported.", + "format": "int64", "type": "string" }, - "industryVertical": { - "description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", - "enum": [ - "INDUSTRY_VERTICAL_UNSPECIFIED", - "GENERIC", - "MEDIA", - "HEALTHCARE_FHIR" - ], - "enumDescriptions": [ - "Value used when unset.", - "The generic vertical for documents that are not specific to any industry vertical.", - "The media industry vertical.", - "The healthcare FHIR vertical." - ], + "importedEntriesCount": { + "description": "Count of deny list entries successfully imported.", + "format": "int64", "type": "string" - }, - "mediaRecommendationEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", - "description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." - }, - "name": { - "description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { + "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "recommendationMetadata": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", - "description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", - "readOnly": true - }, - "searchEngineConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", - "description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" }, - "similarDocumentsConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "description": "Additional config specs for a `similar-items` engine." + "successCount": { + "description": "Count of entries that were processed successfully.", + "format": "int64", + "type": "string" }, - "solutionType": { - "description": "Required. The solutions of the engine.", - "enum": [ - "SOLUTION_TYPE_UNSPECIFIED", - "SOLUTION_TYPE_RECOMMENDATION", - "SOLUTION_TYPE_SEARCH", - "SOLUTION_TYPE_CHAT", - "SOLUTION_TYPE_GENERATIVE_CHAT" - ], - "enumDescriptions": [ - "Default value.", - "Used for Recommendations AI.", - "Used for Discovery Search.", - "Used for use cases related to the Generative AI agent.", - "Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { + "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", + "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "description": "Echoes the destination for the complete errors if this field was set in the request." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + }, + "joinedEventsCount": { + "description": "Count of user events imported with complete existing Documents.", + "format": "int64", "type": "string" }, - "updateTime": { - "description": "Output only. Timestamp the Recommendation Engine was last updated.", - "format": "google-datetime", - "readOnly": true, + "unjoinedEventsCount": { + "description": "Count of user events imported, but with Document information not found in the existing Branch.", + "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { - "description": "Configurations for a Chat Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", + "GoogleCloudDiscoveryengineV1alphaInterval": { + "description": "A floating point interval.", + "id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { - "agentCreationConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", - "description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." + "exclusiveMaximum": { + "description": "Exclusive upper bound.", + "format": "double", + "type": "number" }, - "dialogflowAgentToLink": { - "description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", - "type": "string" + "exclusiveMinimum": { + "description": "Exclusive lower bound.", + "format": "double", + "type": "number" + }, + "maximum": { + "description": "Inclusive upper bound.", + "format": "double", + "type": "number" + }, + "minimum": { + "description": "Inclusive lower bound.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { - "description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", + "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { + "description": "Language info for DataStore.", + "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { - "business": { - "description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", + "language": { + "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", + "readOnly": true, "type": "string" }, - "defaultLanguageCode": { - "description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", + "languageCode": { + "description": "The language code for the DataStore.", "type": "string" }, - "location": { - "description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", + "normalizedLanguageCode": { + "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", + "readOnly": true, "type": "string" }, - "timeZone": { - "description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", + "region": { + "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", + "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { - "description": "Additional information of a Chat Engine. Fields in this message are output only.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", + "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { + "description": "Response message for SearchTuningService.ListCustomModels method.", + "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { - "dialogflowAgent": { - "description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", - "type": "string" + "models": { + "description": "List of custom tuning models.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { - "description": "Common configurations for an Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", + "GoogleCloudDiscoveryengineV1alphaProject": { + "description": "Metadata and configurations for a Google Cloud project in the service.", + "id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { - "companyName": { - "description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", + "createTime": { + "description": "Output only. The timestamp when this project is created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", + "readOnly": true, + "type": "string" + }, + "provisionCompletionTime": { + "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", + "format": "google-datetime", + "readOnly": true, "type": "string" + }, + "serviceTermsMap": { + "additionalProperties": { + "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" + }, + "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", + "readOnly": true, + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { - "description": "Additional config specs for a Media Recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", + "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { + "description": "Metadata about the terms of service.", + "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { - "optimizationObjective": { - "description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", + "acceptTime": { + "description": "The last time when the project agreed to the terms of service.", + "format": "google-datetime", "type": "string" }, - "optimizationObjectiveConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", - "description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." + "declineTime": { + "description": "The last time when the project declined or revoked the agreement to terms of service.", + "format": "google-datetime", + "type": "string" }, - "trainingState": { - "description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", + "id": { + "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", + "type": "string" + }, + "state": { + "description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ - "TRAINING_STATE_UNSPECIFIED", - "PAUSED", - "TRAINING" + "STATE_UNSPECIFIED", + "TERMS_ACCEPTED", + "TERMS_PENDING", + "TERMS_DECLINED" ], "enumDescriptions": [ - "Unspecified training state.", - "The engine training is paused.", - "The engine is training." + "The default value of the enum. This value is not actually used.", + "The project has given consent to the terms of service.", + "The project is pending to review and accept the terms of service.", + "The project has declined or revoked the agreement to terms of service." ], "type": "string" }, - "type": { - "description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", + "version": { + "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { - "description": "Custom threshold for `cvr` optimization_objective.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", + "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { + "description": "Metadata associated with a project provision operation.", + "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { + "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { - "targetField": { - "description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "targetFieldValueFloat": { - "description": "Required. The threshold to be applied to the target (e.g., 0.5).", - "format": "float", - "type": "number" + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { - "description": "Additional information of a recommendation engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", + "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { + "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", "properties": { - "dataState": { - "description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", - "enum": [ - "DATA_STATE_UNSPECIFIED", - "DATA_OK", - "DATA_ERROR" - ], - "enumDescriptions": [ - "Unspecified default value, should never be explicitly set.", - "The engine has sufficient training data.", - "The engine does not have sufficient training data. Error messages can be queried via Stackdriver." - ], - "readOnly": true, - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "lastTuneTime": { - "description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", + "purgeSucceeded": { + "description": "Whether the completion suggestions were successfully purged.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { + "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", "format": "google-datetime", - "readOnly": true, "type": "string" }, - "servingState": { - "description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", - "enum": [ - "SERVING_STATE_UNSPECIFIED", - "INACTIVE", - "ACTIVE", - "TUNED" - ], - "enumDescriptions": [ - "Unspecified serving state.", - "The engine is not serving.", - "The engine is serving and can be queried.", - "The engine is trained on tuned hyperparameters and can be queried." - ], - "readOnly": true, + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", + "type": "string" + }, + "ignoredCount": { + "description": "Count of entries that were ignored as entries were not found.", + "format": "int64", "type": "string" }, - "tuningOperation": { - "description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", - "readOnly": true, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { - "description": "Configurations for a Search Engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", + "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { + "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "properties": { - "searchAddOns": { - "description": "The add-on that this search engine enables.", + "purgeCount": { + "description": "The total count of documents purged as a result of the operation.", + "format": "int64", + "type": "string" + }, + "purgeSample": { + "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", "items": { - "enum": [ - "SEARCH_ADD_ON_UNSPECIFIED", - "SEARCH_ADD_ON_LLM" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Large language model add-on." - ], "type": "string" }, "type": "array" - }, - "searchTier": { - "description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", - "enum": [ - "SEARCH_TIER_UNSPECIFIED", - "SEARCH_TIER_STANDARD", - "SEARCH_TIER_ENTERPRISE" - ], - "enumDescriptions": [ - "Default value when the enum is unspecified. This is invalid to use.", - "Standard tier.", - "Enterprise tier." - ], - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { - "description": "Additional config specs for a `similar-items` engine.", - "id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { - "description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { + "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { - "description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", + "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { + "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", "properties": { - "dataSizeBytes": { - "description": "Data size in terms of bytes.", - "format": "int64", - "type": "string" + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" }, - "documentCount": { - "description": "Total number of documents.", + "purgeCount": { + "description": "Number of suggestion deny list entries purged.", "format": "int64", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaFieldConfig": { - "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", - "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { + "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { - "advancedSiteSearchDataSources": { - "description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", - "items": { - "enum": [ - "ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", - "METATAGS", - "PAGEMAP", - "SCHEMA_ORG" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrieve value from meta tag.", - "Retrieve value from page map.", - "Retrieve value from schema.org data." - ], - "type": "string" - }, - "type": "array" - }, - "completableOption": { - "description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "COMPLETABLE_OPTION_UNSPECIFIED", - "COMPLETABLE_ENABLED", - "COMPLETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Completable option enabled for a schema field.", - "Completable option disabled for a schema field." - ], - "type": "string" - }, - "dynamicFacetableOption": { - "description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", - "DYNAMIC_FACETABLE_ENABLED", - "DYNAMIC_FACETABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Dynamic facetable option enabled for a schema field.", - "Dynamic facetable option disabled for a schema field." - ], + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", "type": "string" }, - "fieldPath": { - "description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", + "failureCount": { + "description": "Count of entries that encountered errors while processing.", + "format": "int64", "type": "string" }, - "fieldType": { - "description": "Output only. Raw type of the field.", - "enum": [ - "FIELD_TYPE_UNSPECIFIED", - "OBJECT", - "STRING", - "NUMBER", - "INTEGER", - "BOOLEAN", - "GEOLOCATION", - "DATETIME" - ], - "enumDescriptions": [ - "Field type is unspecified.", - "Field value type is Object.", - "Field value type is String.", - "Field value type is Number.", - "Field value type is Integer.", - "Field value type is Boolean.", - "Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", - "Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" - ], - "readOnly": true, + "successCount": { + "description": "Count of entries that were deleted successfully.", + "format": "int64", "type": "string" }, - "indexableOption": { - "description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "INDEXABLE_OPTION_UNSPECIFIED", - "INDEXABLE_ENABLED", - "INDEXABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Indexable option enabled for a schema field.", - "Indexable option disabled for a schema field." - ], + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", "type": "string" - }, - "keyPropertyType": { - "description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", - "readOnly": true, + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { + "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", + "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", + "properties": { + "purgeCount": { + "description": "The total count of events purged as a result of the operation.", + "format": "int64", "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, - "recsFilterableOption": { - "description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", - "enum": [ - "FILTERABLE_OPTION_UNSPECIFIED", - "FILTERABLE_ENABLED", - "FILTERABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Filterable option enabled for a schema field.", - "Filterable option disabled for a schema field." - ], - "type": "string" + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" }, - "retrievableOption": { - "description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "RETRIEVABLE_OPTION_UNSPECIFIED", - "RETRIEVABLE_ENABLED", - "RETRIEVABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Retrievable option enabled for a schema field.", - "Retrievable option disabled for a schema field." - ], - "type": "string" + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" }, - "schemaOrgPaths": { - "description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", - "items": { - "type": "string" - }, - "type": "array" + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, - "searchableOption": { - "description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", - "enum": [ - "SEARCHABLE_OPTION_UNSPECIFIED", - "SEARCHABLE_ENABLED", - "SEARCHABLE_DISABLED" - ], - "enumDescriptions": [ - "Value used when unset.", - "Searchable option enabled for a schema field.", - "Searchable option disabled for a schema field." - ], - "type": "string" + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", + "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfig": { - "description": "Identity Provider Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", + "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", "properties": { - "externalIdpConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", - "description": "External Identity provider config." + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" }, - "idpType": { - "description": "Identity provider type configured.", - "enum": [ - "IDP_TYPE_UNSPECIFIED", - "GSUITE", - "THIRD_PARTY" - ], - "enumDescriptions": [ - "Default value. ACL search not enabled.", - "Google 1P provider.", - "Third party provider." - ], - "type": "string" + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { - "description": "Third party IDP Config.", - "id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", + "GoogleCloudDiscoveryengineV1alphaQuery": { + "description": "Defines a user inputed query.", + "id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { - "workforcePoolName": { - "description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", + "queryId": { + "description": "Unique Id for the query.", + "type": "string" + }, + "text": { + "description": "Plain text.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, - "failureCount": { - "description": "Count of CompletionSuggestions that failed to be imported.", - "format": "int64", - "type": "string" + "invalidUris": { + "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingCount": { + "description": "Total number of URIs that have yet to be crawled.", + "format": "int32", + "type": "integer" + }, + "quotaExceededCount": { + "description": "Total number of URIs that were rejected due to insufficient indexing resources.", + "format": "int32", + "type": "integer" }, "successCount": { - "description": "Count of CompletionSuggestions successfully imported.", - "format": "int64", - "type": "string" + "description": "Total number of URIs that have been crawled so far.", + "format": "int32", + "type": "integer" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" + }, + "validUrisCount": { + "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { - "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", - "id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "The desired location of errors incurred during the Import." + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", + "items": { + "type": "string" + }, + "type": "array" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { - "description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { + "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", - "type": "string" - }, - "totalCount": { - "description": "Total count of entries that were processed.", - "format": "int64", - "type": "string" + "failureReasons": { + "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + }, + "type": "array" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "uri": { + "description": "URI that failed to be crawled.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { - "description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { + "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors in the request if set." + "corpusType": { + "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DESKTOP", + "MOBILE" + ], + "enumDescriptions": [ + "Default value.", + "Denotes a crawling attempt for the desktop version of a page.", + "Denotes a crawling attempt for the mobile version of a page." + ], + "type": "string" }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "errorMessage": { + "description": "Reason why the URI was not crawled.", + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { - "description": "Configuration of destination for Import related errors.", - "id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", + "GoogleCloudDiscoveryengineV1alphaSchema": { + "description": "Defines the structure and layout of a type of document data.", + "id": "GoogleCloudDiscoveryengineV1alphaSchema", "properties": { - "gcsPrefix": { - "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.", + "fieldConfigs": { + "description": "Output only. Configurations for fields of the schema.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" + }, + "readOnly": true, + "type": "array" + }, + "jsonSchema": { + "description": "The JSON representation of the schema.", + "type": "string" + }, + "name": { + "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" + }, + "structSchema": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The structured representation of the schema.", + "type": "object" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequest": { + "description": "Request message for SearchService.Search method.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + "boostSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", + "description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" + }, + "branch": { + "description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "canonicalFilter": { + "description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", + "type": "string" + }, + "contentSearchSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", + "description": "A specification for configuring the behavior of content search." + }, + "customFineTuningSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", + "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." + }, + "dataStoreSpecs": { + "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" + }, + "type": "array" + }, + "embeddingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", + "description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." + }, + "facetSpecs": { + "description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" + }, + "type": "array" + }, + "filter": { + "description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", + "type": "string" + }, + "imageQuery": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", + "description": "Raw image query." + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", + "type": "string" + }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, + "offset": { + "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "orderBy": { + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", - "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" + }, + "params": { + "additionalProperties": { + "type": "any" }, - "type": "array" + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", + "type": "object" }, - "failedEntriesCount": { - "description": "Count of deny list entries that failed to be imported.", - "format": "int64", + "query": { + "description": "Raw search query.", "type": "string" }, - "importedEntriesCount": { - "description": "Count of deny list entries successfully imported.", - "format": "int64", + "queryExpansionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", + "description": "The query expansion specification that specifies the conditions under which query expansion occurs." + }, + "rankingExpression": { + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { - "description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", - "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", + }, + "regionCode": { + "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", + "relevanceThreshold": { + "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], "type": "string" }, - "successCount": { - "description": "Count of entries that were processed successfully.", - "format": "int64", + "safeSearch": { + "description": "Whether to turn on safe search. This is only supported for website search.", + "type": "boolean" + }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "type": "string" + }, + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, + "spellCorrectionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "description": "The spell correction specification that specifies the mode under which spell correction takes effect." + }, + "userInfo": { + "$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", + "type": "object" + }, + "userPseudoId": { + "description": "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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { - "description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", - "id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { + "description": "Boost specification to boost certain documents.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { - "errorConfig": { - "$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", - "description": "Echoes the destination for the complete errors if this field was set in the request." - }, - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", + "conditionBoostSpecs": { + "description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { - "$ref": "GoogleRpcStatus" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, "type": "array" - }, - "joinedEventsCount": { - "description": "Count of user events imported with complete existing Documents.", - "format": "int64", - "type": "string" - }, - "unjoinedEventsCount": { - "description": "Count of user events imported, but with Document information not found in the existing Branch.", - "format": "int64", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { - "description": "Language info for DataStore.", - "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { + "description": "Boost applies to documents which match a condition.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { - "language": { - "description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", - "readOnly": true, - "type": "string" - }, - "languageCode": { - "description": "The language code for the DataStore.", - "type": "string" + "boost": { + "description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", + "format": "float", + "type": "number" }, - "normalizedLanguageCode": { - "description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", - "readOnly": true, - "type": "string" + "boostControlSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", + "description": "Complex specification for custom ranking based on customer defined attribute value." }, - "region": { - "description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", - "readOnly": true, + "condition": { + "description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { - "description": "Response message for SearchTuningService.ListCustomModels method.", - "id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { + "description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { - "models": { - "description": "List of custom tuning models.", + "attributeType": { + "description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", + "enum": [ + "ATTRIBUTE_TYPE_UNSPECIFIED", + "NUMERICAL", + "FRESHNESS" + ], + "enumDescriptions": [ + "Unspecified AttributeType.", + "The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", + "For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." + ], + "type": "string" + }, + "controlPoints": { + "description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "type": "array" + }, + "fieldName": { + "description": "The name of the field whose value will be used to determine the boost amount.", + "type": "string" + }, + "interpolationType": { + "description": "The interpolation type to be applied to connect the control points listed below.", + "enum": [ + "INTERPOLATION_TYPE_UNSPECIFIED", + "LINEAR" + ], + "enumDescriptions": [ + "Interpolation type is unspecified. In this case, it defaults to Linear.", + "Piecewise linear interpolation will be applied." + ], + "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProject": { - "description": "Metadata and configurations for a Google Cloud project in the service.", - "id": "GoogleCloudDiscoveryengineV1alphaProject", + "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { + "description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { - "createTime": { - "description": "Output only. The timestamp when this project is created.", - "format": "google-datetime", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", - "readOnly": true, - "type": "string" - }, - "provisionCompletionTime": { - "description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", - "format": "google-datetime", - "readOnly": true, + "attributeValue": { + "description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, - "serviceTermsMap": { - "additionalProperties": { - "$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" - }, - "description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", - "readOnly": true, - "type": "object" + "boostAmount": { + "description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", + "format": "float", + "type": "number" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { - "description": "Metadata about the terms of service.", - "id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { + "description": "A specification for configuring the behavior of content search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { - "acceptTime": { - "description": "The last time when the project agreed to the terms of service.", - "format": "google-datetime", - "type": "string" - }, - "declineTime": { - "description": "The last time when the project declined or revoked the agreement to terms of service.", - "format": "google-datetime", - "type": "string" + "chunkSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, - "id": { - "description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", - "type": "string" + "extractiveContentSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", + "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, - "state": { - "description": "Whether the project has accepted/rejected the service terms or it is still pending.", + "searchResultMode": { + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ - "STATE_UNSPECIFIED", - "TERMS_ACCEPTED", - "TERMS_PENDING", - "TERMS_DECLINED" + "SEARCH_RESULT_MODE_UNSPECIFIED", + "DOCUMENTS", + "CHUNKS" ], "enumDescriptions": [ - "The default value of the enum. This value is not actually used.", - "The project has given consent to the terms of service.", - "The project is pending to review and accept the terms of service.", - "The project has declined or revoked the agreement to terms of service." + "Default value.", + "Returns documents in the search result.", + "Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, - "version": { - "description": "The version string of the terms of service. For acceptable values, see the comments for id above.", - "type": "string" + "snippetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", + "description": "If `snippetSpec` is not specified, snippets are not included in the search response." + }, + "summarySpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", + "description": "If `summarySpec` is not specified, summaries are not included in the search response." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { + "description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", + "properties": { + "numNextChunks": { + "description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", + "format": "int32", + "type": "integer" + }, + "numPreviousChunks": { + "description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { - "description": "Metadata associated with a project provision operation.", - "id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", - "properties": {}, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { - "description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { + "description": "A specification for configuring the extractive content in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "maxExtractiveAnswerCount": { + "description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", + "format": "int32", + "type": "integer" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "maxExtractiveSegmentCount": { + "description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", + "format": "int32", + "type": "integer" + }, + "numNextSegments": { + "description": "Return at most `num_next_segments` segments after each selected segments.", + "format": "int32", + "type": "integer" + }, + "numPreviousSegments": { + "description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", + "format": "int32", + "type": "integer" + }, + "returnExtractiveSegmentScore": { + "description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { - "description": "Response message for CompletionService.PurgeCompletionSuggestions method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { + "description": "A specification for configuring snippets in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" + "maxSnippetCount": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", + "format": "int32", + "type": "integer" }, - "purgeSucceeded": { - "description": "Whether the completion suggestions were successfully purged.", + "referenceOnly": { + "deprecated": true, + "description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", + "type": "boolean" + }, + "returnSnippet": { + "description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { - "description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { + "description": "A specification for configuring a summary returned in a search response.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "ignoreAdversarialQuery": { + "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", + "type": "boolean" }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" }, - "ignoredCount": { - "description": "Count of entries that were ignored as entries were not found.", - "format": "int64", - "type": "string" + "ignoreNonSummarySeekingQuery": { + "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", + "type": "boolean" }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" + "includeCitations": { + "description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", + "type": "boolean" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "languageCode": { + "description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" + }, + "modelPromptSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", + "description": "If specified, the spec will be used to modify the prompt provided to the LLM." + }, + "modelSpec": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", + "description": "If specified, the spec will be used to modify the model specification provided to the LLM." + }, + "summaryResultCount": { + "description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", + "format": "int32", + "type": "integer" + }, + "useSemanticChunks": { + "description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", + "type": "boolean" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { - "description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { + "description": "Specification of the prompt to use with the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { - "purgeCount": { - "description": "The total count of documents purged as a result of the operation.", - "format": "int64", + "preamble": { + "description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" - }, - "purgeSample": { - "description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", - "items": { - "type": "string" - }, - "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { - "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { + "description": "Specification of the model.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "version": { + "description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { - "description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", "properties": { - "errorSamples": { - "description": "A sample of errors encountered while processing the request.", - "items": { - "$ref": "GoogleRpcStatus" - }, - "type": "array" - }, - "purgeCount": { - "description": "Number of suggestion deny list entries purged.", - "format": "int64", + "dataStore": { + "description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { - "description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { + "description": "The specification that uses customized query embedding vector to do semantic document retrieval.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" - }, - "failureCount": { - "description": "Count of entries that encountered errors while processing.", - "format": "int64", - "type": "string" - }, - "successCount": { - "description": "Count of entries that were deleted successfully.", - "format": "int64", - "type": "string" - }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", - "type": "string" + "embeddingVectors": { + "description": "The embedding vector used for retrieval. Limit to 1.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { - "description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", - "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", + "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { + "description": "Embedding vector.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { - "purgeCount": { - "description": "The total count of events purged as a result of the operation.", - "format": "int64", + "fieldPath": { + "description": "Embedding field path in schema.", "type": "string" + }, + "vector": { + "description": "Query embedding vector.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaQuery": { - "description": "Defines a user inputed query.", - "id": "GoogleCloudDiscoveryengineV1alphaQuery", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { + "description": "A facet specification to perform faceted search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { - "queryId": { - "description": "Unique Id for the query.", - "type": "string" + "enableDynamicPosition": { + "description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", + "type": "boolean" }, - "text": { - "description": "Plain text.", - "type": "string" + "excludedFilterKeys": { + "description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "items": { + "type": "string" + }, + "type": "array" + }, + "facetKey": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", + "description": "Required. The facet key specification." + }, + "limit": { + "description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", + "format": "int32", + "type": "integer" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { - "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { + "description": "Specifies how a facet is computed.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { - "createTime": { - "description": "Operation create time.", - "format": "google-datetime", - "type": "string" + "caseInsensitive": { + "description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", + "type": "boolean" }, - "invalidUris": { - "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", + "contains": { + "description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, - "pendingCount": { - "description": "Total number of URIs that have yet to be crawled.", - "format": "int32", - "type": "integer" - }, - "quotaExceededCount": { - "description": "Total number of URIs that were rejected due to insufficient indexing resources.", - "format": "int32", - "type": "integer" + "intervals": { + "description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaInterval" + }, + "type": "array" }, - "successCount": { - "description": "Total number of URIs that have been crawled so far.", - "format": "int32", - "type": "integer" + "key": { + "description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", + "type": "string" }, - "updateTime": { - "description": "Operation last update time. If the operation is done, this is also the finish time.", - "format": "google-datetime", + "orderBy": { + "description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, - "validUrisCount": { - "description": "Total number of unique URIs in the request that are not in invalid_uris.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { - "description": "Response message for SiteSearchEngineService.RecrawlUris method.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", - "properties": { - "failedUris": { - "description": "URIs that were not crawled before the LRO terminated.", + "prefixes": { + "description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, - "failureSamples": { - "description": "Details for a sample of up to 10 `failed_uris`.", + "restrictedValues": { + "description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + "type": "string" }, "type": "array" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { - "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { + "description": "Specifies the image query input.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { - "failureReasons": { - "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "imageBytes": { + "description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "properties": { + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], + "type": "string" + }, + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + "type": "string" }, "type": "array" - }, - "uri": { - "description": "URI that failed to be crawled.", - "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { - "description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", - "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { + "description": "Specification to determine under which conditions query expansion should occur.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { - "corpusType": { - "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "condition": { + "description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", "enum": [ - "CORPUS_TYPE_UNSPECIFIED", - "DESKTOP", - "MOBILE" + "CONDITION_UNSPECIFIED", + "DISABLED", + "AUTO" ], "enumDescriptions": [ - "Default value.", - "Denotes a crawling attempt for the desktop version of a page.", - "Denotes a crawling attempt for the mobile version of a page." + "Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", + "Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", + "Automatic query expansion built by the Search API." ], "type": "string" }, - "errorMessage": { - "description": "Reason why the URI was not crawled.", + "pinUnexpandedResults": { + "description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", + "properties": { + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudDiscoveryengineV1alphaSchema": { - "description": "Defines the structure and layout of a type of document data.", - "id": "GoogleCloudDiscoveryengineV1alphaSchema", + "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { - "fieldConfigs": { - "description": "Output only. Configurations for fields of the schema.", - "items": { - "$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" - }, - "readOnly": true, - "type": "array" - }, - "jsonSchema": { - "description": "The JSON representation of the schema.", + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, - "name": { - "description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { + "description": "The specification for query spell correction.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", + "properties": { + "mode": { + "description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", + "enum": [ + "MODE_UNSPECIFIED", + "SUGGESTION_ONLY", + "AUTO" + ], + "enumDescriptions": [ + "Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", + "Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", + "Automatic spell correction built by the Search API. Search will be based on the corrected query if found." + ], "type": "string" - }, - "structSchema": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The structured representation of the schema.", - "type": "object" } }, "type": "object" @@ -9949,6 +11685,29 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { + "description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", + "id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", @@ -10181,6 +11940,52 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaUserInfo": { + "description": "Information of an end user.", + "id": "GoogleCloudDiscoveryengineV1alphaUserInfo", + "properties": { + "userAgent": { + "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": { + "description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1alphaWorkspaceConfig", + "properties": { + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -10202,7 +12007,7 @@ "type": "string" }, "projectId": { - "description": "The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -10225,7 +12030,9 @@ "NON_ANSWER_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "NO_RELEVANT_CONTENT" + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The answer skipped reason is not specified.", @@ -10233,7 +12040,9 @@ "The non-answer seeking query ignored case.", "The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", "The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." + "The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Google skips the answer if the query is classified as a jail-breaking query.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -10477,12 +12286,14 @@ "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type." + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." ], "type": "string" }, @@ -10573,7 +12384,7 @@ "type": "string" }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -10724,7 +12535,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswer", - "description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." + "description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -10764,12 +12575,14 @@ "enum": [ "TYPE_UNSPECIFIED", "ADVERSARIAL_QUERY", - "NON_ANSWER_SEEKING_QUERY" + "NON_ANSWER_SEEKING_QUERY", + "JAIL_BREAKING_QUERY" ], "enumDescriptions": [ "Unspecified query classification type.", "Adversarial query classification type.", - "Non-answer-seeking query classification type." + "Non-answer-seeking query classification type.", + "Jail-breaking query classification type." ], "type": "string" } @@ -10784,6 +12597,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo", "description": "Chunk information." }, + "structuredDocumentInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo", + "description": "Structured document information." + }, "unstructuredDocumentInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo", "description": "Unstructured document information." @@ -10808,7 +12625,7 @@ "description": "Document metadata." }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -10846,6 +12663,25 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo": { + "description": "Structured search information.", + "id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo", + "properties": { + "document": { + "description": "Document resource name.", + "type": "string" + }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Structured search data.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo": { "description": "Unstructured document information.", "id": "GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo", @@ -10891,6 +12727,11 @@ "pageIdentifier": { "description": "Page identifier.", "type": "string" + }, + "relevanceScore": { + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", + "format": "float", + "type": "number" } }, "type": "object" @@ -10983,6 +12824,14 @@ }, "type": "array" }, + "structData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", + "type": "object" + }, "title": { "description": "Title.", "type": "string" @@ -11007,7 +12856,7 @@ "type": "string" }, "relevanceScore": { - "description": "Relevance score.", + "description": "The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation.", "format": "float", "type": "number" } @@ -11085,6 +12934,63 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse": { + "description": "Response message for DocumentService.BatchGetDocumentsMetadata method.", + "id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse", + "properties": { + "documentsMetadata": { + "description": "The metadata of the Documents.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata": { + "description": "The metadata of a Document.", + "id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata", + "properties": { + "lastRefreshedTime": { + "description": "The timestamp of the last time the Document was last indexed.", + "format": "google-datetime", + "type": "string" + }, + "matcherValue": { + "$ref": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "description": "The value of the matcher that was used to match the Document." + }, + "status": { + "description": "The status of the document.", + "enum": [ + "STATUS_UNSPECIFIED", + "STATUS_INDEXED", + "STATUS_NOT_IN_TARGET_SITE", + "STATUS_NOT_IN_INDEX" + ], + "enumDescriptions": [ + "Should never be set.", + "The Document is indexed.", + "The Document is not indexed because its URI is not in the TargetSite.", + "The Document is not indexed." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue": { + "description": "The value of the matcher that was used to match the Document.", + "id": "GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue", + "properties": { + "uri": { + "description": "If match by URI, the URI of the Document.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest": { "description": "Request message for SiteSearchEngineService.BatchVerifyTargetSites method.", "id": "GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest", @@ -11112,7 +13018,7 @@ "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { - "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -11263,7 +13169,7 @@ "type": "string" }, "projectId": { - "description": "The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -11353,6 +13259,11 @@ "description": "Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned.", "type": "boolean" }, + "score": { + "description": "Confidence score for the claim in the answer candidate, in the range of [0, 1].", + "format": "double", + "type": "number" + }, "startPos": { "description": "Position indicating the start of the claim in the answer candidate, measured in bytes.", "format": "int32", @@ -11502,7 +13413,7 @@ "type": "boolean" }, "projectId": { - "description": "The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -11663,7 +13574,7 @@ "id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { "associatedServingConfigIds": { - "description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", + "description": "Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.", "items": { "type": "string" }, @@ -11991,6 +13902,12 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { + "description": "Metadata for EvaluationService.CreateEvaluation method.", + "id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", + "properties": {}, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -12067,6 +13984,7 @@ "id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", "properties": { "createTime": { + "deprecated": true, "description": "Timestamp the Model was created at.", "format": "google-datetime", "type": "string" @@ -12075,6 +13993,14 @@ "description": "The display name of the model.", "type": "string" }, + "metrics": { + "additionalProperties": { + "format": "double", + "type": "number" + }, + "description": "The metrics of the trained model.", + "type": "object" + }, "modelState": { "description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", "enum": [ @@ -12083,7 +14009,8 @@ "TRAINING", "TRAINING_COMPLETE", "READY_FOR_SERVING", - "TRAINING_FAILED" + "TRAINING_FAILED", + "NO_IMPROVEMENT" ], "enumDescriptions": [ "Default value.", @@ -12091,7 +14018,8 @@ "The model is currently training.", "The model has successfully completed training.", "The model is ready for serving.", - "The model training failed." + "The model training failed.", + "The model training finished successfully but metrics did not improve." ], "type": "string" }, @@ -12122,13 +14050,15 @@ "CONTENT_CONFIG_UNSPECIFIED", "NO_CONTENT", "CONTENT_REQUIRED", - "PUBLIC_WEBSITE" + "PUBLIC_WEBSITE", + "GOOGLE_WORKSPACE" ], "enumDescriptions": [ "Default value.", "Only contains documents without any Document.content.", "Only contains documents with Document.content.", - "The data store is used for public website search." + "The data store is used for public website search.", + "The data store is used for workspace search. Details of workspace data store are specified in the WorkspaceConfig." ], "type": "string" }, @@ -12199,6 +14129,10 @@ "startingSchema": { "$ref": "GoogleCloudDiscoveryengineV1betaSchema", "description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." + }, + "workspaceConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", + "description": "Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE." } }, "type": "object" @@ -12382,6 +14316,11 @@ "description": "The Document resource ID.", "type": "string" }, + "joined": { + "description": "Output only. Whether the referenced Document can be found in the data store.", + "readOnly": true, + "type": "boolean" + }, "name": { "description": "The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`", "type": "string" @@ -12425,7 +14364,7 @@ "additionalProperties": { "$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" }, - "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.", + "description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.", "type": "object" } }, @@ -12744,6 +14683,96 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaEvaluation": { + "description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluation", + "properties": { + "createTime": { + "description": "Output only. Timestamp the Evaluation was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "endTime": { + "description": "Output only. Timestamp the Evaluation was completed at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "GoogleRpcStatus", + "description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", + "readOnly": true + }, + "errorSamples": { + "description": "Output only. A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "readOnly": true, + "type": "array" + }, + "evaluationSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "description": "Required. The specification of the evaluation." + }, + "name": { + "description": "Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", + "readOnly": true + }, + "state": { + "description": "Output only. The state of the evaluation.", + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED" + ], + "enumDescriptions": [ + "The evaluation is unspecified.", + "The service is preparing to run the evaluation.", + "The evaluation is in progress.", + "The evaluation completed successfully.", + "The evaluation failed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { + "description": "Describes the specification of the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", + "properties": { + "querySetSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "description": "Required. The specification of the query set." + }, + "searchRequest": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", + "description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { + "description": "Describes the specification of the query set.", + "id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", + "properties": { + "sampleQuerySet": { + "description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaFactChunk": { "description": "Fact Chunk.", "id": "GoogleCloudDiscoveryengineV1betaFactChunk", @@ -12805,6 +14834,13 @@ "gcsStagingDir": { "description": "Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.", "type": "string" + }, + "resourceTypes": { + "description": "The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -13099,6 +15135,93 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { + "description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", + "properties": { + "createTime": { + "description": "ImportSampleQueries operation create time.", + "format": "google-datetime", + "type": "string" + }, + "failureCount": { + "description": "Count of SampleQuerys that failed to be imported.", + "format": "int64", + "type": "string" + }, + "successCount": { + "description": "Count of SampleQuerys successfully imported.", + "format": "int64", + "type": "string" + }, + "totalCount": { + "description": "Total count of SampleQuerys that were processed.", + "format": "int64", + "type": "string" + }, + "updateTime": { + "description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest": { + "description": "Request message for SampleQueryService.ImportSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest", + "properties": { + "bigquerySource": { + "$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource", + "description": "BigQuery input source." + }, + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", + "description": "Cloud Storage location for the input content." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", + "description": "The Inline source for sample query entries." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource": { + "description": "The inline source for SampleQuerys.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", + "properties": { + "sampleQueries": { + "description": "Required. A list of SampleQuerys to import. Max of 1000 items.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { + "description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", + "id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", + "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", + "description": "The desired location of errors incurred during the Import." + }, + "errorSamples": { + "description": "A sample of errors encountered while processing the request.", + "items": { + "$ref": "GoogleRpcStatus" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -13418,6 +15541,95 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse": { + "description": "Response message for EvaluationService.ListEvaluationResults method.", + "id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse", + "properties": { + "evaluationResults": { + "description": "The EvaluationResults.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult": { + "description": "Represents the results of an evaluation for a single SampleQuery.", + "id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult", + "properties": { + "qualityMetrics": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", + "readOnly": true + }, + "sampleQuery": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery", + "description": "Output only. The SampleQuery that was evaluated.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse": { + "description": "Response message for EvaluationService.ListEvaluations method.", + "id": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse", + "properties": { + "evaluations": { + "description": "The Evaluations.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": { + "description": "Response message for SampleQueryService.ListSampleQueries method.", + "id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQueries": { + "description": "The SampleQuerys.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse": { + "description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", + "id": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse", + "properties": { + "nextPageToken": { + "description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "sampleQuerySets": { + "description": "The SampleQuerySets.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1betaListSchemasResponse", @@ -13702,6 +15914,10 @@ "description": "Request message for DocumentService.PurgeDocuments method.", "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest", "properties": { + "errorConfig": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig", + "description": "The desired location of errors incurred during the purge." + }, "filter": { "description": "Required. Filter matching documents to purge. Only currently supported value is `*` (all items).", "type": "string" @@ -13709,6 +15925,28 @@ "force": { "description": "Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents.", "type": "boolean" + }, + "gcsSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", + "description": "Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line." + }, + "inlineSource": { + "$ref": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource", + "description": "Inline source for the input content for purge." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource": { + "description": "The inline source for the input config for DocumentService.PurgeDocuments method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource", + "properties": { + "documents": { + "description": "Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items.", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -13732,6 +15970,17 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig": { + "description": "Configuration of destination for Purge related errors.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeErrorConfig", + "properties": { + "gcsPrefix": { + "description": "Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", @@ -13774,6 +16023,75 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest": { + "description": "Request message for PurgeUserEvents method.", + "id": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest", + "properties": { + "filter": { + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "type": "string" + }, + "force": { + "description": "The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetrics": { + "description": "Describes the metrics produced by the evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", + "properties": { + "docNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "docPrecision": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" + }, + "docRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" + }, + "pageNdcg": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" + }, + "pageRecall": { + "$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { + "description": "Stores the metric values at specific top-k levels.", + "id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", + "properties": { + "top1": { + "description": "The top-1 value.", + "format": "double", + "type": "number" + }, + "top10": { + "description": "The top-10 value.", + "format": "double", + "type": "number" + }, + "top3": { + "description": "The top-3 value.", + "format": "double", + "type": "number" + }, + "top5": { + "description": "The top-5 value.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1betaQuery", @@ -14024,6 +16342,94 @@ "properties": {}, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSampleQuery": { + "description": "Sample Query captures metadata to be used for evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQuery", + "properties": { + "createTime": { + "description": "Output only. Timestamp the SampleQuery was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Identifier. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + }, + "queryEntry": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", + "description": "The query entry." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry": { + "description": "Query Entry captures metadata to be used for search evaluation.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", + "properties": { + "query": { + "description": "Required. The query.", + "type": "string" + }, + "targets": { + "description": "List of targets for the query.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget": { + "description": "Defines the parameters of the query's expected outcome.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget", + "properties": { + "pageNumbers": { + "description": "Expected page numbers of the target. Each page number must be non negative.", + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "score": { + "description": "Relevance score of the target.", + "format": "double", + "type": "number" + }, + "uri": { + "description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSampleQuerySet": { + "description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", + "id": "GoogleCloudDiscoveryengineV1betaSampleQuerySet", + "properties": { + "createTime": { + "description": "Output only. Timestamp the SampleQuerySet was created at.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the SampleQuerySet.", + "type": "string" + }, + "displayName": { + "description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", + "type": "string" + }, + "name": { + "description": "Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -14117,13 +16523,17 @@ "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, + "naturalLanguageQueryUnderstandingSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." + }, "offset": { "description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", "format": "int32", "type": "integer" }, "orderBy": { - "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", + "description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, "pageSize": { @@ -14151,17 +16561,51 @@ "description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, "rankingExpression": { - "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", + "description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, "regionCode": { "description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" }, + "relevanceThreshold": { + "description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", + "enum": [ + "RELEVANCE_THRESHOLD_UNSPECIFIED", + "LOWEST", + "LOW", + "MEDIUM", + "HIGH" + ], + "enumDescriptions": [ + "Default value. In this case, server behavior defaults to Google defined threshold.", + "Lowest relevance threshold.", + "Low relevance threshold.", + "Medium relevance threshold.", + "High relevance threshold." + ], + "type": "string" + }, "safeSearch": { "description": "Whether to turn on safe search. This is only supported for website search.", "type": "boolean" }, + "searchAsYouTypeSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." + }, + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "type": "string" + }, + "session": { + "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "type": "string" + }, + "sessionSpec": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "description": "Session specification. Can be used only when `session` is set." + }, "spellCorrectionSpec": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", "description": "The spell correction specification that specifies the mode under which spell correction takes effect." @@ -14291,7 +16735,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { - "description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", + "description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14393,6 +16837,10 @@ "description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", "type": "boolean" }, + "ignoreLowRelevantContent": { + "description": "Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers.", + "type": "boolean" + }, "ignoreNonSummarySeekingQuery": { "description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", "type": "boolean" @@ -14448,7 +16896,7 @@ "type": "object" }, "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { - "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", + "description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", "properties": { "dataStore": { @@ -14576,6 +17024,34 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { + "description": "Specification to enable natural language understanding capabilities for search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", + "properties": { + "filterExtractionCondition": { + "description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables NL filter extraction.", + "Enables NL filter extraction." + ], + "type": "string" + }, + "geoSearchQueryDetectionFieldNames": { + "description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { "description": "Specification to determine under which conditions query expansion should occur.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", @@ -14601,6 +17077,43 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { + "description": "Specification for search as you type in search requests.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", + "properties": { + "condition": { + "description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", + "enum": [ + "CONDITION_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Server behavior defaults to Condition.DISABLED.", + "Disables Search As You Type.", + "Enables Search As You Type." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { + "description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", + "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", + "properties": { + "queryId": { + "description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", + "type": "string" + }, + "searchResultPersistenceCount": { + "description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { "description": "The specification for query spell correction.", "id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", @@ -14658,10 +17171,21 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult", "description": "Guided search result." }, + "naturalLanguageQueryUnderstandingInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "description": "Natural language query understanding information for the returned results." + }, "nextPageToken": { "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, + "oneBoxResults": { + "description": "A list of One Box results. There can be multiple One Box results of different types.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult" + }, + "type": "array" + }, "queryExpansionInfo": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo", "description": "Query expansion information for the returned results." @@ -14677,6 +17201,10 @@ }, "type": "array" }, + "sessionInfo": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo", + "description": "Session information. Only set if SearchRequest.session is provided. See its description for more details." + }, "summary": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary", "description": "A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set." @@ -14782,6 +17310,209 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo": { + "description": "Information describing what natural language understanding was done on the input query.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo", + "properties": { + "extractedFilters": { + "description": "The filters that were extracted from the input query.", + "type": "string" + }, + "rewrittenQuery": { + "description": "Rewritten input query minus the extracted filters.", + "type": "string" + }, + "structuredExtractedFilter": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "description": "The filters that were extracted from the input query represented in a structured form." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter": { + "description": "The filters that were extracted from the input query represented in a structured form.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter", + "properties": { + "expression": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "description": "The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression": { + "description": "Logical `And` operator.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "properties": { + "expressions": { + "description": "The expressions that were ANDed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression": { + "description": "The expression denoting the filter that was extracted from the input query.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression", + "properties": { + "andExpr": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression", + "description": "Logical \"And\" compound operator connecting multiple expressions." + }, + "geolocationConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "description": "Geolocation constraint expression." + }, + "numberConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "description": "Numerical constraint expression." + }, + "orExpr": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "description": "Logical \"Or\" compound operator connecting multiple expressions." + }, + "stringConstraint": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "description": "String constraint expression." + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint": { + "description": "Constraint of a geolocation field. Name of the geolocation field as defined in the schema.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint", + "properties": { + "address": { + "description": "The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results.", + "type": "string" + }, + "fieldName": { + "description": "The name of the geolocation field as defined in the schema.", + "type": "string" + }, + "latitude": { + "description": "The latitude of the geolocation inferred from the input query.", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude of the geolocation inferred from the input query.", + "format": "double", + "type": "number" + }, + "radiusInMeters": { + "description": "The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint": { + "description": "Constraint expression of a number field. Example: price < 100.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint", + "properties": { + "comparison": { + "description": "The comparison operation performed between the field value and the value specified in the constraint.", + "enum": [ + "COMPARISON_UNSPECIFIED", + "EQUALS", + "LESS_THAN_EQUALS", + "LESS_THAN", + "GREATER_THAN_EQUALS", + "GREATER_THAN" + ], + "enumDescriptions": [ + "Undefined comparison operator.", + "Denotes equality `=` operator.", + "Denotes less than or equal to `<=` operator.", + "Denotes less than `<` operator.", + "Denotes greater than or equal to `>=` operator.", + "Denotes greater than `>` operator." + ], + "type": "string" + }, + "fieldName": { + "description": "Name of the numerical field as defined in the schema.", + "type": "string" + }, + "value": { + "description": "The value specified in the numerical constraint.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression": { + "description": "Logical `Or` operator.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression", + "properties": { + "expressions": { + "description": "The expressions that were ORed together.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint": { + "description": "Constraint expression of a string field.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint", + "properties": { + "fieldName": { + "description": "Name of the string field as defined in the schema.", + "type": "string" + }, + "querySegment": { + "description": "Identifies the keywords within the search query that match a filter.", + "type": "string" + }, + "values": { + "description": "Values of the string field. The record will only be returned if the field value matches one of the values specified here.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult": { + "description": "OneBoxResult is a holder for all results of specific type that we want to display in UI differently.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult", + "properties": { + "oneBoxType": { + "description": "The type of One Box result.", + "enum": [ + "ONE_BOX_TYPE_UNSPECIFIED", + "PEOPLE", + "ORGANIZATION", + "SLACK" + ], + "enumDescriptions": [ + "Default value. Should not be used.", + "One Box result contains people results.", + "One Box result contains organization results.", + "One Box result contains slack results." + ], + "type": "string" + }, + "searchResults": { + "description": "The search results for this One Box.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo": { "description": "Information describing query expansion including whether expansion has occurred.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo", @@ -14824,6 +17555,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo": { + "description": "Information about the session.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo", + "properties": { + "name": { + "description": "Name of the session. If the auto-session mode is used (when SearchRequest.session ends with \"-\"), this field holds the newly generated session name.", + "type": "string" + }, + "queryId": { + "description": "Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchResponseSummary": { "description": "Summary of the top N search results specified by the summary spec.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseSummary", @@ -14841,15 +17587,21 @@ "NON_SUMMARY_SEEKING_QUERY_IGNORED", "OUT_OF_DOMAIN_QUERY_IGNORED", "POTENTIAL_POLICY_VIOLATION", - "LLM_ADDON_NOT_ENABLED" + "LLM_ADDON_NOT_ENABLED", + "NO_RELEVANT_CONTENT", + "JAIL_BREAKING_QUERY_IGNORED", + "CUSTOMER_POLICY_VIOLATION" ], "enumDescriptions": [ "Default value. The summary skipped reason is not specified.", - "The adversarial query ignored case. Only populated when SummarySpec.ignore_adversarial_query is set to `true`.", - "The non-summary seeking query ignored case. Only populated when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", + "The adversarial query ignored case. Only used when SummarySpec.ignore_adversarial_query is set to `true`.", + "The non-summary seeking query ignored case. Only used when SummarySpec.ignore_non_summary_seeking_query is set to `true`.", "The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.", "The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.", - "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled." + "The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.", + "The no relevant content case. Google skips the summary if there is no relevant content in the retrieved search results.", + "The jail-breaking query ignored case. For example, \"Reply in the tone of a competing company's CEO\". Only used when [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] is set to `true`.", + "The customer policy violation case. Google skips the summary if there is a customer policy violation detected. The policy is defined by the customer." ], "type": "string" }, @@ -15075,7 +17827,7 @@ "type": "array" }, "rankingExpression": { - "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding).", + "description": "The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, "redirectControlIds": { @@ -15280,7 +18032,7 @@ "type": "string" }, "projectId": { - "description": "The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", + "description": "The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", "type": "string" }, "tableId": { @@ -15736,6 +18488,37 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaWorkspaceConfig": { + "description": "Config to store data store type configuration for workspace data", + "id": "GoogleCloudDiscoveryengineV1betaWorkspaceConfig", + "properties": { + "dasherCustomerId": { + "description": "Obfuscated Dasher customer ID.", + "type": "string" + }, + "type": { + "description": "The Google Workspace data source.", + "enum": [ + "TYPE_UNSPECIFIED", + "GOOGLE_DRIVE", + "GOOGLE_MAIL", + "GOOGLE_SITES", + "GOOGLE_CALENDAR", + "GOOGLE_GROUPS" + ], + "enumDescriptions": [ + "Default value.", + "The data store is used to store content from Google Drive.", + "The data store is used to store content from Gmail.", + "The data store is used to store content from Google Sites.", + "The data store is used to store content from Google Calendar.", + "The data store is used to store content from Google Groups." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index b27c068990..b85dbb0582 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -9222,7 +9222,7 @@ } } }, - "revision": "20240627", + "revision": "20240717", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -16719,7 +16719,7 @@ "type": "array" }, "adGroupQaIds": { - "description": "Optional. YouTube Ad Groups QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "description": "Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "items": { "format": "int64", "type": "string" @@ -16751,7 +16751,7 @@ "type": "array" }, "lineItemQaIds": { - "description": "Optional. Line Items QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "description": "Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "items": { "format": "int64", "type": "string" @@ -19624,8 +19624,8 @@ "Line Item.", "YouTube Ad Group.", "YouTube Ad.", - "Line Item QA.", - "YouTube Ad Group QA." + "Line Item - QA format.", + "YouTube Ad Group - QA format." ], "type": "string" }, @@ -19656,8 +19656,8 @@ "Advertiser ID. If selected, all filter IDs must be Advertiser IDs that belong to the Partner specified in CreateSdfDownloadTaskRequest.", "Campaign ID. If selected, all filter IDs must be Campaign IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "Media Product ID. If selected, all filter IDs must be Media Product IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_MEDIA_PRODUCT`.", - "Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`.", - "Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_AD_GROUP`, and `FILE_TYPE_AD`." + "Insertion Order ID. If selected, all filter IDs must be Insertion Order IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_INSERTION_ORDER`, `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`, `FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`.", + "Line Item ID. If selected, all filter IDs must be Line Item IDs that belong to the Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Can only be used for downloading `FILE_TYPE_LINE_ITEM`, `FILE_TYPE_LINE_ITEM_QA`,`FILE_TYPE_AD_GROUP`, `FILE_TYPE_AD_GROUP_QA`, and `FILE_TYPE_AD`." ], "type": "string" } @@ -20529,7 +20529,8 @@ "type": "array" }, "publisherReviewStatuses": { - "description": "Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information.", + "deprecated": true, + "description": "Publisher review statuses for the creative.", "items": { "$ref": "PublisherReviewStatus" }, diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index 780fc2f5b0..5bba5d1663 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -17,19 +17,219 @@ "documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/", "endpoints": [ { - "location": "africa-south1", "description": "Regional Endpoint", - "endpointUrl": "https://dlp.africa-south1.rep.googleapis.com/" + "endpointUrl": "https://dlp.africa-south1.rep.googleapis.com/", + "location": "africa-south1" }, { "description": "Regional Endpoint", - "location": "australia-southeast1", - "endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/" + "endpointUrl": "https://dlp.asia-east1.rep.googleapis.com/", + "location": "asia-east1" }, { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-east2.rep.googleapis.com/", + "location": "asia-east2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-northeast1.rep.googleapis.com/", + "location": "asia-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-northeast2.rep.googleapis.com/", + "location": "asia-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-northeast3.rep.googleapis.com/", + "location": "asia-northeast3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-south1.rep.googleapis.com/", + "location": "asia-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-south2.rep.googleapis.com/", + "location": "asia-south2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-southeast1.rep.googleapis.com/", + "location": "asia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.asia-southeast2.rep.googleapis.com/", + "location": "asia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/", + "location": "australia-southeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.australia-southeast2.rep.googleapis.com/", + "location": "australia-southeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-central2.rep.googleapis.com/", + "location": "europe-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-north1.rep.googleapis.com/", + "location": "europe-north1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-north2.rep.googleapis.com/", + "location": "europe-north2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-southwest1.rep.googleapis.com/", + "location": "europe-southwest1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west1.rep.googleapis.com/", + "location": "europe-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west10.rep.googleapis.com/", + "location": "europe-west10" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west12.rep.googleapis.com/", + "location": "europe-west12" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west2.rep.googleapis.com/", + "location": "europe-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west3.rep.googleapis.com/", + "location": "europe-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west4.rep.googleapis.com/", + "location": "europe-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west6.rep.googleapis.com/", + "location": "europe-west6" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", "endpointUrl": "https://dlp.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.me-central1.rep.googleapis.com/", + "location": "me-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.me-central2.rep.googleapis.com/", + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.me-west1.rep.googleapis.com/", + "location": "me-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.northamerica-northeast1.rep.googleapis.com/", + "location": "northamerica-northeast1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.northamerica-northeast2.rep.googleapis.com/", + "location": "northamerica-northeast2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.northamerica-south1.rep.googleapis.com/", + "location": "northamerica-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.southamerica-east1.rep.googleapis.com/", + "location": "southamerica-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.southamerica-west1.rep.googleapis.com/", + "location": "southamerica-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west4.rep.googleapis.com/", + "location": "us-west4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://dlp.us-west8.rep.googleapis.com/", + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -147,7 +347,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name. The format of this value is as follows: locations/ LOCATION_ID", + "description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`", "location": "query", "type": "string" } @@ -191,7 +391,7 @@ "type": "string" }, "parent": { - "description": "The parent resource name. The format of this value is as follows: locations/ LOCATION_ID", + "description": "The parent resource name. The format of this value is as follows: `locations/{location_id}`", "location": "path", "pattern": "^locations/[^/]+$", "required": true, @@ -224,7 +424,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -307,7 +507,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -323,7 +523,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -380,7 +580,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -463,7 +663,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -479,7 +679,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -568,7 +768,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -613,7 +813,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -681,6 +881,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists Connections in a parent. Use SearchConnections to see all connections within an organization.", + "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections", + "httpMethod": "GET", + "id": "dlp.organizations.locations.connections.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of results per page, max 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", + "location": "path", + "pattern": "^organizations/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+parent}/connections", + "response": { + "$ref": "GooglePrivacyDlpV2ListConnectionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Update a Connection.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}", @@ -735,7 +976,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent name, typically an organization, without location. For example: `organizations/12345678`.", + "description": "Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -764,7 +1005,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -847,7 +1088,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -863,7 +1104,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -920,7 +1161,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -998,7 +1239,7 @@ ], "parameters": { "orderBy": { - "description": "Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", + "description": "Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", "location": "query", "type": "string" }, @@ -1014,7 +1255,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1081,7 +1322,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -1097,7 +1338,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1191,12 +1432,12 @@ ], "parameters": { "filter": { - "description": "Optional. Allows filtering. 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}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", + "description": "Optional. Allows filtering. 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}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", + "description": "Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", "location": "query", "type": "string" }, @@ -1241,7 +1482,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1324,7 +1565,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -1340,7 +1581,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1397,7 +1638,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1485,7 +1726,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "description": "Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -1501,7 +1742,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1603,7 +1844,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -1648,7 +1889,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1731,7 +1972,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -1747,7 +1988,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -1859,7 +2100,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", "location": "query", "type": "string" }, @@ -1906,7 +2147,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1989,7 +2230,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -2005,7 +2246,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2066,7 +2307,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2094,7 +2335,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2122,7 +2363,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2154,7 +2395,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2237,7 +2478,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -2253,7 +2494,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2338,7 +2579,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2426,7 +2667,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -2442,7 +2683,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2486,7 +2727,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2518,7 +2759,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2601,7 +2842,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -2617,7 +2858,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2702,7 +2943,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2790,7 +3031,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "description": "Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -2806,7 +3047,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -2910,7 +3151,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -2955,7 +3196,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3024,7 +3265,7 @@ ] }, "list": { - "description": "Lists Connections in a parent.", + "description": "Lists Connections in a parent. Use SearchConnections to see all connections within an organization.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections", "httpMethod": "GET", "id": "dlp.projects.locations.connections.list", @@ -3049,7 +3290,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent name, for example: `projects/project-id/locations/global`.", + "description": "Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3118,7 +3359,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent name, typically an organization, without location. For example: `organizations/12345678`.", + "description": "Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3147,7 +3388,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3175,7 +3416,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3203,7 +3444,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3235,7 +3476,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3318,7 +3559,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -3334,7 +3575,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3391,7 +3632,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3469,7 +3710,7 @@ ], "parameters": { "orderBy": { - "description": "Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", + "description": "Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status.", "location": "query", "type": "string" }, @@ -3485,7 +3726,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value is as follows: `projects/{project_id}/locations/{location_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3570,7 +3811,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3714,7 +3955,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state`", "location": "query", "type": "string" }, @@ -3730,7 +3971,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3824,12 +4065,12 @@ ], "parameters": { "filter": { - "description": "Optional. Allows filtering. 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}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", + "description": "Optional. Allows filtering. 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}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like \"gs://bucket\". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = \"gs://mybucket\"` The length of this field should be no more than 500 characters.", "location": "query", "type": "string" }, "orderBy": { - "description": "Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", + "description": "Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created.", "location": "query", "type": "string" }, @@ -3874,7 +4115,7 @@ ], "parameters": { "parent": { - "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3906,7 +4147,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3989,7 +4230,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name.", "location": "query", "type": "string" }, @@ -4005,7 +4246,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4090,7 +4331,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4206,7 +4447,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", + "description": "Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status.", "location": "query", "type": "string" }, @@ -4222,7 +4463,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4324,7 +4565,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds.", "location": "query", "type": "string" }, @@ -4369,7 +4610,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4452,7 +4693,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -4468,7 +4709,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4580,7 +4821,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource.", "location": "query", "type": "string" }, @@ -4627,7 +4868,7 @@ ], "parameters": { "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` + Organizations scope, location specified: `organizations/{org_id}/locations/{location_id}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4710,7 +4951,7 @@ "type": "string" }, "orderBy": { - "description": "Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", + "description": "Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name.", "location": "query", "type": "string" }, @@ -4726,7 +4967,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", + "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id}/locations/{location_id}` + Projects scope, no location specified (defaults to global): `projects/{project_id}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4774,7 +5015,7 @@ } } }, - "revision": "20240624", + "revision": "20240808", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -4847,6 +5088,12 @@ "properties": {}, "type": "object" }, + "GooglePrivacyDlpV2AllOtherResources": { + "description": "Match discovery resources not covered by any other filter.", + "id": "GooglePrivacyDlpV2AllOtherResources", + "properties": {}, + "type": "object" + }, "GooglePrivacyDlpV2AllText": { "description": "Apply to all text.", "id": "GooglePrivacyDlpV2AllText", @@ -5419,6 +5666,29 @@ }, "type": "object" }, + "GooglePrivacyDlpV2CloudStorageDiscoveryTarget": { + "description": "Target used to match against for discovery with Cloud Storage buckets.", + "id": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget", + "properties": { + "conditions": { + "$ref": "GooglePrivacyDlpV2DiscoveryFileStoreConditions", + "description": "Optional. In addition to matching the filter, these conditions must be true before a profile is generated." + }, + "disabled": { + "$ref": "GooglePrivacyDlpV2Disabled", + "description": "Optional. Disable profiling for buckets that match this filter." + }, + "filter": { + "$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageFilter", + "description": "Required. The buckets the generation_cadence applies to. The first target with a matching filter will be the one to apply to a bucket." + }, + "generationCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence", + "description": "Optional. How often and when to update profiles. New buckets that match both the filter and conditions are scanned as quickly as possible depending on system capacity." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2CloudStorageFileSet": { "description": "Message representing a set of files in Cloud Storage.", "id": "GooglePrivacyDlpV2CloudStorageFileSet", @@ -5514,6 +5784,21 @@ }, "type": "object" }, + "GooglePrivacyDlpV2CloudStorageRegex": { + "description": "A pattern to match against one or more file stores. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub.", + "id": "GooglePrivacyDlpV2CloudStorageRegex", + "properties": { + "bucketNameRegex": { + "description": "Optional. Regex to test the bucket name against. If empty, all buckets match. Example: \"marketing2021\" or \"(marketing)\\d{4}\" will both match the bucket gs://marketing2021", + "type": "string" + }, + "projectIdRegex": { + "description": "Optional. For organizations, if unset, will match all projects.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2CloudStorageRegexFileSet": { "description": "Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: \"mybucket\", include_regex: [\"directory1/.*\"], exclude_regex: [\"directory1/excluded.*\"]}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [\".*\"]`). Some other common use cases: * `{bucket_name: \"mybucket\", exclude_regex: [\".*\\.pdf\"]}` will include all files in `mybucket` except for .pdf files * `{bucket_name: \"mybucket\", include_regex: [\"directory/[^/]+\"]}` will include all files directly under `gs://mybucket/directory/`, without matching across `/`", "id": "GooglePrivacyDlpV2CloudStorageRegexFileSet", @@ -5539,6 +5824,21 @@ }, "type": "object" }, + "GooglePrivacyDlpV2CloudStorageResourceReference": { + "description": "Identifies a single Cloud Storage bucket.", + "id": "GooglePrivacyDlpV2CloudStorageResourceReference", + "properties": { + "bucketName": { + "description": "Required. The bucket to scan.", + "type": "string" + }, + "projectId": { + "description": "Required. If within a project-level config, then this must match the config's project id.", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2Color": { "description": "Represents a color in the RGB color space.", "id": "GooglePrivacyDlpV2Color", @@ -6128,7 +6428,7 @@ "description": "Required. The key used by the encryption algorithm." }, "customAlphabet": { - "description": "This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/", + "description": "This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[}]|\\:;\"'<,>.?/``", "type": "string" }, "radix": { @@ -6224,6 +6524,10 @@ "pubSubNotification": { "$ref": "GooglePrivacyDlpV2PubSubNotification", "description": "Publish a message into the Pub/Sub topic." + }, + "tagResources": { + "$ref": "GooglePrivacyDlpV2TagResources", + "description": "Tags the profiled resources with the specified tag values." } }, "type": "object" @@ -6310,7 +6614,7 @@ "id": "GooglePrivacyDlpV2DataProfileLocation", "properties": { "folderId": { - "description": "The ID of the Folder within an organization to scan.", + "description": "The ID of the folder within an organization to scan.", "format": "int64", "type": "string" }, @@ -6573,11 +6877,11 @@ "id": "GooglePrivacyDlpV2Deidentify", "properties": { "cloudStorageOutput": { - "description": "Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for cloud storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket", + "description": "Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket", "type": "string" }, "fileTypesToTransform": { - "description": "List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV.", + "description": "List of user-specified file type groups to transform. If specified, only the files with these file types will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV.", "items": { "enum": [ "FILE_TYPE_UNSPECIFIED", @@ -7005,6 +7309,10 @@ "description": "How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity.", "id": "GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence", "properties": { + "inspectTemplateModifiedCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update." + }, "refreshFrequency": { "description": "Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changed. Defaults to never.", "enum": [ @@ -7028,6 +7336,107 @@ }, "type": "object" }, + "GooglePrivacyDlpV2DiscoveryCloudStorageConditions": { + "description": "Requirements that must be true before a Cloud Storage bucket or object is scanned in discovery for the first time. There is an AND relationship between the top-level attributes.", + "id": "GooglePrivacyDlpV2DiscoveryCloudStorageConditions", + "properties": { + "includedBucketAttributes": { + "description": "Required. Only objects with the specified attributes will be scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset.", + "items": { + "enum": [ + "CLOUD_STORAGE_BUCKET_ATTRIBUTE_UNSPECIFIED", + "ALL_SUPPORTED_BUCKETS", + "AUTOCLASS_DISABLED", + "AUTOCLASS_ENABLED" + ], + "enumDescriptions": [ + "Unused.", + "Scan buckets regardless of the attribute.", + "Buckets with autoclass disabled (https://cloud.google.com/storage/docs/autoclass). Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set.", + "Buckets with autoclass enabled (https://cloud.google.com/storage/docs/autoclass). Only one of AUTOCLASS_DISABLED or AUTOCLASS_ENABLED should be set. Scanning Autoclass-enabled buckets can affect object storage classes." + ], + "type": "string" + }, + "type": "array" + }, + "includedObjectAttributes": { + "description": "Required. Only objects with the specified attributes will be scanned. If an object has one of the specified attributes but is inside an excluded bucket, it will not be scanned. Defaults to [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no objects match the included_object_attributes.", + "items": { + "enum": [ + "CLOUD_STORAGE_OBJECT_ATTRIBUTE_UNSPECIFIED", + "ALL_SUPPORTED_OBJECTS", + "STANDARD", + "NEARLINE", + "COLDLINE", + "ARCHIVE", + "REGIONAL", + "MULTI_REGIONAL", + "DURABLE_REDUCED_AVAILABILITY" + ], + "enumDescriptions": [ + "Unused.", + "Scan objects regardless of the attribute.", + "Scan objects with the standard storage class.", + "Scan objects with the nearline storage class. This will incur retrieval fees.", + "Scan objects with the coldline storage class. This will incur retrieval fees.", + "Scan objects with the archive storage class. This will incur retrieval fees.", + "Scan objects with the regional storage class.", + "Scan objects with the multi-regional storage class.", + "Scan objects with the dual-regional storage class. This will incur retrieval fees." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryCloudStorageFilter": { + "description": "Determines which buckets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID and bucket name.", + "id": "GooglePrivacyDlpV2DiscoveryCloudStorageFilter", + "properties": { + "cloudStorageResourceReference": { + "$ref": "GooglePrivacyDlpV2CloudStorageResourceReference", + "description": "Optional. The bucket to scan. Targets including this can only include one target (the target with this bucket). This enables profiling the contents of a single bucket, while the other options allow for easy profiling of many bucets within a project or an organization." + }, + "collection": { + "$ref": "GooglePrivacyDlpV2FileStoreCollection", + "description": "Optional. A specific set of buckets for this filter to apply to." + }, + "others": { + "$ref": "GooglePrivacyDlpV2AllOtherResources", + "description": "Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence": { + "description": "How often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity.", + "id": "GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence", + "properties": { + "inspectTemplateModifiedCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "description": "Optional. Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update." + }, + "refreshFrequency": { + "description": "Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never.", + "enum": [ + "UPDATE_FREQUENCY_UNSPECIFIED", + "UPDATE_FREQUENCY_NEVER", + "UPDATE_FREQUENCY_DAILY", + "UPDATE_FREQUENCY_MONTHLY" + ], + "enumDescriptions": [ + "Unspecified.", + "After the data profile is created, it will never be updated.", + "The data profile can be updated up to once every 24 hours.", + "The data profile can be updated up to once every 30 days. Default." + ], + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2DiscoveryConfig": { "description": "Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention).", "id": "GooglePrivacyDlpV2DiscoveryConfig", @@ -7108,10 +7517,51 @@ }, "type": "object" }, + "GooglePrivacyDlpV2DiscoveryFileStoreConditions": { + "description": "Requirements that must be true before a file store is scanned in discovery for the first time. There is an AND relationship between the top-level attributes.", + "id": "GooglePrivacyDlpV2DiscoveryFileStoreConditions", + "properties": { + "cloudStorageConditions": { + "$ref": "GooglePrivacyDlpV2DiscoveryCloudStorageConditions", + "description": "Optional. Cloud Storage conditions." + }, + "createdAfter": { + "description": "Optional. File store must have been created after this date. Used to avoid backfilling.", + "format": "google-datetime", + "type": "string" + }, + "minAge": { + "description": "Optional. Minimum age a file store must have. If set, the value must be 1 hour or greater.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2DiscoveryGenerationCadence": { "description": "What must take place for a profile to be updated and how frequently it should occur. New tables are scanned as quickly as possible depending on system capacity.", "id": "GooglePrivacyDlpV2DiscoveryGenerationCadence", "properties": { + "inspectTemplateModifiedCadence": { + "$ref": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "description": "Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update." + }, + "refreshFrequency": { + "description": "Frequency at which profiles should be updated, regardless of whether the underlying resource has changed. Defaults to never.", + "enum": [ + "UPDATE_FREQUENCY_UNSPECIFIED", + "UPDATE_FREQUENCY_NEVER", + "UPDATE_FREQUENCY_DAILY", + "UPDATE_FREQUENCY_MONTHLY" + ], + "enumDescriptions": [ + "Unspecified.", + "After the data profile is created, it will never be updated.", + "The data profile can be updated up to once every 24 hours.", + "The data profile can be updated up to once every 30 days. Default." + ], + "type": "string" + }, "schemaModifiedCadence": { "$ref": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence", "description": "Governs when to update data profiles when a schema is modified." @@ -7123,6 +7573,29 @@ }, "type": "object" }, + "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence": { + "description": "The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change.", + "id": "GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence", + "properties": { + "frequency": { + "description": "How frequently data profiles can be updated when the template is modified. Defaults to never.", + "enum": [ + "UPDATE_FREQUENCY_UNSPECIFIED", + "UPDATE_FREQUENCY_NEVER", + "UPDATE_FREQUENCY_DAILY", + "UPDATE_FREQUENCY_MONTHLY" + ], + "enumDescriptions": [ + "Unspecified.", + "After the data profile is created, it will never be updated.", + "The data profile can be updated up to once every 24 hours.", + "The data profile can be updated up to once every 30 days. Default." + ], + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence": { "description": "The cadence at which to update data profiles when a schema is modified.", "id": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence", @@ -7168,7 +7641,7 @@ "id": "GooglePrivacyDlpV2DiscoveryStartingLocation", "properties": { "folderId": { - "description": "The ID of the Folder within an organization to scan.", + "description": "The ID of the folder within an organization to be scanned.", "format": "int64", "type": "string" }, @@ -7230,6 +7703,10 @@ "$ref": "GooglePrivacyDlpV2CloudSqlDiscoveryTarget", "description": "Cloud SQL target for Discovery. The first target to match a table will be the one applied." }, + "cloudStorageTarget": { + "$ref": "GooglePrivacyDlpV2CloudStorageDiscoveryTarget", + "description": "Cloud Storage target for Discovery. The first target to match a table will be the one applied." + }, "secretsTarget": { "$ref": "GooglePrivacyDlpV2SecretsDiscoveryTarget", "description": "Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed." @@ -7534,7 +8011,7 @@ "description": "The data risk level of this cluster. RISK_LOW if nothing has been scanned." }, "errors": { - "description": "A list of Errors detected while scanning this cluster. The list is truncated to 10 per cluster.", + "description": "A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster.", "items": { "$ref": "GooglePrivacyDlpV2Error" }, @@ -7545,14 +8022,14 @@ "description": "The file cluster type." }, "fileExtensionsScanned": { - "description": "A sample of file types scanned in this cluster. Empty if no files were scanned.", + "description": "A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content.", "items": { "$ref": "GooglePrivacyDlpV2FileExtensionInfo" }, "type": "array" }, "fileExtensionsSeen": { - "description": "A sample of file types seen in this cluster. Empty if no files were seen.", + "description": "A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content.", "items": { "$ref": "GooglePrivacyDlpV2FileExtensionInfo" }, @@ -7637,8 +8114,19 @@ }, "type": "object" }, + "GooglePrivacyDlpV2FileStoreCollection": { + "description": "Match file stores (e.g. buckets) using regex filters.", + "id": "GooglePrivacyDlpV2FileStoreCollection", + "properties": { + "includeRegexes": { + "$ref": "GooglePrivacyDlpV2FileStoreRegexes", + "description": "Optional. A collection of regular expressions to match a file store against." + } + }, + "type": "object" + }, "GooglePrivacyDlpV2FileStoreDataProfile": { - "description": "The profile for a file store. * Google Cloud Storage: maps 1:1 with a bucket.", + "description": "The profile for a file store. * Cloud Storage: maps 1:1 with a bucket.", "id": "GooglePrivacyDlpV2FileStoreDataProfile", "properties": { "configSnapshot": { @@ -7659,7 +8147,7 @@ "description": "The resource type that was profiled." }, "dataStorageLocations": { - "description": "For resources that have multiple storage locations, these are those regions. For Google Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.", + "description": "For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile.", "items": { "type": "string" }, @@ -7684,11 +8172,11 @@ "type": "boolean" }, "fileStoreLocation": { - "description": "The location of the file store. * Google Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations", + "description": "The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations", "type": "string" }, "fileStorePath": { - "description": "The file store path. * Google Cloud Storage: `gs://{bucket}`", + "description": "The file store path. * Cloud Storage: `gs://{bucket}`", "type": "string" }, "fullResource": { @@ -7718,7 +8206,7 @@ "description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated." }, "projectDataProfile": { - "description": "The resource name to the project data profile for this file store.", + "description": "The resource name of the project data profile for this file store.", "type": "string" }, "projectId": { @@ -7729,7 +8217,7 @@ "additionalProperties": { "$ref": "GooglePrivacyDlpV2Value" }, - "description": "Attributes of the resource being profiled. Currently used attributes: - customer_managed_encryption: boolean true: the resource is encrypted with a customer-managed key. false: the resource is encrypted with a provider-managed key.", + "description": "Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key.", "type": "object" }, "resourceLabels": { @@ -7787,6 +8275,31 @@ }, "type": "object" }, + "GooglePrivacyDlpV2FileStoreRegex": { + "description": "A pattern to match against one or more file stores.", + "id": "GooglePrivacyDlpV2FileStoreRegex", + "properties": { + "cloudStorageRegex": { + "$ref": "GooglePrivacyDlpV2CloudStorageRegex", + "description": "Optional. Regex for Cloud Storage." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2FileStoreRegexes": { + "description": "A collection of regular expressions to determine what file store to match against.", + "id": "GooglePrivacyDlpV2FileStoreRegexes", + "properties": { + "patterns": { + "description": "Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB.", + "items": { + "$ref": "GooglePrivacyDlpV2FileStoreRegex" + }, + "type": "array" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2Finding": { "description": "Represents a piece of potentially sensitive content.", "id": "GooglePrivacyDlpV2Finding", @@ -10830,7 +11343,7 @@ "description": "Success or error status from the most recent profile generation attempt. May be empty if the profile is still being generated." }, "projectDataProfile": { - "description": "The resource name to the project data profile for this table.", + "description": "The resource name of the project data profile for this table.", "type": "string" }, "resourceLabels": { @@ -10937,6 +11450,67 @@ }, "type": "object" }, + "GooglePrivacyDlpV2TagCondition": { + "description": "The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level.", + "id": "GooglePrivacyDlpV2TagCondition", + "properties": { + "sensitivityScore": { + "$ref": "GooglePrivacyDlpV2SensitivityScore", + "description": "Conditions attaching the tag to a resource on its profile having this sensitivity score." + }, + "tag": { + "$ref": "GooglePrivacyDlpV2TagValue", + "description": "The tag value to attach to resources." + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2TagResources": { + "description": "If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag.", + "id": "GooglePrivacyDlpV2TagResources", + "properties": { + "lowerDataRiskToLow": { + "description": "Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles.", + "type": "boolean" + }, + "profileGenerationsToTag": { + "description": "The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`.", + "items": { + "enum": [ + "PROFILE_GENERATION_UNSPECIFIED", + "PROFILE_GENERATION_NEW", + "PROFILE_GENERATION_UPDATE" + ], + "enumDescriptions": [ + "Unused.", + "The profile is the first profile for the resource.", + "The profile is an update to a previous profile." + ], + "type": "string" + }, + "type": "array" + }, + "tagConditions": { + "description": "The tags to associate with different conditions.", + "items": { + "$ref": "GooglePrivacyDlpV2TagCondition" + }, + "type": "array" + } + }, + "type": "object" + }, + "GooglePrivacyDlpV2TagValue": { + "description": "A value of a tag.", + "id": "GooglePrivacyDlpV2TagValue", + "properties": { + "namespacedValue": { + "description": "The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`, for example, \"123456/environment/prod\".", + "type": "string" + } + }, + "type": "object" + }, "GooglePrivacyDlpV2TaggedField": { "description": "A column with a semantic tag attached.", "id": "GooglePrivacyDlpV2TaggedField", @@ -11027,7 +11601,7 @@ }, "timestampField": { "$ref": "GooglePrivacyDlpV2FieldId", - "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." + "description": "Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation." } }, "type": "object" diff --git a/discovery/dns-v1.json b/discovery/dns-v1.json index 99a2a4acc0..e5d3232e19 100644 --- a/discovery/dns-v1.json +++ b/discovery/dns-v1.json @@ -1824,7 +1824,7 @@ } } }, - "revision": "20240616", + "revision": "20240719", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2893,6 +2893,10 @@ "format": "int32", "type": "integer" }, + "internetHealthChecksPerManagedZone": { + "format": "int32", + "type": "integer" + }, "itemsPerRoutingPolicy": { "description": "Maximum allowed number of items per routing policy.", "format": "int32", @@ -3009,6 +3013,10 @@ "geo": { "$ref": "RRSetRoutingPolicyGeoPolicy" }, + "healthCheck": { + "description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", + "type": "string" + }, "kind": { "default": "dns#rRSetRoutingPolicy", "type": "string" @@ -3080,6 +3088,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { + "externalEndpoints": { + "description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", + "items": { + "type": "string" + }, + "type": "array" + }, "internalLoadBalancers": { "description": "Configuration for internal load balancers to be health checked.", "items": { diff --git a/discovery/dns-v1beta2.json b/discovery/dns-v1beta2.json index 3d1c670663..85d23a3dd8 100644 --- a/discovery/dns-v1beta2.json +++ b/discovery/dns-v1beta2.json @@ -1821,7 +1821,7 @@ } } }, - "revision": "20240616", + "revision": "20240719", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2890,6 +2890,10 @@ "format": "int32", "type": "integer" }, + "internetHealthChecksPerManagedZone": { + "format": "int32", + "type": "integer" + }, "itemsPerRoutingPolicy": { "description": "Maximum allowed number of items per routing policy.", "format": "int32", @@ -3010,6 +3014,10 @@ "$ref": "RRSetRoutingPolicyGeoPolicy", "deprecated": true }, + "healthCheck": { + "description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", + "type": "string" + }, "kind": { "default": "dns#rRSetRoutingPolicy", "type": "string" @@ -3085,6 +3093,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { + "externalEndpoints": { + "description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", + "items": { + "type": "string" + }, + "type": "array" + }, "internalLoadBalancers": { "description": "Configuration for internal load balancers to be health checked.", "items": { diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index 221324979d..3035a2b40e 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -183,6 +183,11 @@ "required": true, "type": "string" }, + "includeTabsContent": { + "description": "Whether to populate the Document.tabs field instead of the text content fields like `body` and `documentStyle` on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.", + "location": "query", + "type": "boolean" + }, "suggestionsViewMode": { "description": "The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.", "enum": [ @@ -216,7 +221,7 @@ } } }, - "revision": "20230929", + "revision": "20240730", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -341,6 +346,21 @@ }, "type": "object" }, + "BookmarkLink": { + "description": "A reference to a bookmark in this document.", + "id": "BookmarkLink", + "properties": { + "id": { + "description": "The ID of a bookmark in this document.", + "type": "string" + }, + "tabId": { + "description": "The ID of the tab containing this bookmark.", + "type": "string" + } + }, + "type": "object" + }, "Bullet": { "description": "Describes the bullet of a paragraph.", "id": "Bullet", @@ -671,6 +691,10 @@ "footerId": { "description": "The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.", "type": "string" + }, + "tabId": { + "description": "The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" @@ -682,6 +706,10 @@ "headerId": { "description": "The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.", "type": "string" + }, + "tabId": { + "description": "The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" @@ -697,6 +725,10 @@ "namedRangeId": { "description": "The ID of the named range to delete.", "type": "string" + }, + "tabsCriteria": { + "$ref": "TabsCriteria", + "description": "Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs." } }, "type": "object" @@ -719,6 +751,10 @@ "objectId": { "description": "The ID of the positioned object to delete.", "type": "string" + }, + "tabId": { + "description": "The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" @@ -775,7 +811,7 @@ "properties": { "body": { "$ref": "Body", - "description": "Output only. The main body of the document." + "description": "Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document." }, "documentId": { "description": "Output only. The ID of the document.", @@ -783,59 +819,59 @@ }, "documentStyle": { "$ref": "DocumentStyle", - "description": "Output only. The style of the document." + "description": "Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document." }, "footers": { "additionalProperties": { "$ref": "Footer" }, - "description": "Output only. The footers in the document, keyed by footer ID.", + "description": "Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "footnotes": { "additionalProperties": { "$ref": "Footnote" }, - "description": "Output only. The footnotes in the document, keyed by footnote ID.", + "description": "Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "headers": { "additionalProperties": { "$ref": "Header" }, - "description": "Output only. The headers in the document, keyed by header ID.", + "description": "Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "inlineObjects": { "additionalProperties": { "$ref": "InlineObject" }, - "description": "Output only. The inline objects in the document, keyed by object ID.", + "description": "Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "lists": { "additionalProperties": { "$ref": "List" }, - "description": "Output only. The lists in the document, keyed by list ID.", + "description": "Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "namedRanges": { "additionalProperties": { "$ref": "NamedRanges" }, - "description": "Output only. The named ranges in the document, keyed by name.", + "description": "Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "namedStyles": { "$ref": "NamedStyles", - "description": "Output only. The named styles of the document." + "description": "Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document." }, "positionedObjects": { "additionalProperties": { "$ref": "PositionedObject" }, - "description": "Output only. The positioned objects in the document, keyed by object ID.", + "description": "Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "revisionId": { @@ -846,14 +882,14 @@ "additionalProperties": { "$ref": "SuggestedDocumentStyle" }, - "description": "Output only. The suggested changes to the style of the document, keyed by suggestion ID.", + "description": "Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "suggestedNamedStylesChanges": { "additionalProperties": { "$ref": "SuggestedNamedStyles" }, - "description": "Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.", + "description": "Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document.", "type": "object" }, "suggestionsViewMode": { @@ -872,6 +908,13 @@ ], "type": "string" }, + "tabs": { + "description": "Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field.", + "items": { + "$ref": "Tab" + }, + "type": "array" + }, "title": { "description": "The title of the document.", "type": "string" @@ -1046,6 +1089,88 @@ }, "type": "object" }, + "DocumentTab": { + "description": "A tab with document contents.", + "id": "DocumentTab", + "properties": { + "body": { + "$ref": "Body", + "description": "The main body of the document tab." + }, + "documentStyle": { + "$ref": "DocumentStyle", + "description": "The style of the document tab." + }, + "footers": { + "additionalProperties": { + "$ref": "Footer" + }, + "description": "The footers in the document tab, keyed by footer ID.", + "type": "object" + }, + "footnotes": { + "additionalProperties": { + "$ref": "Footnote" + }, + "description": "The footnotes in the document tab, keyed by footnote ID.", + "type": "object" + }, + "headers": { + "additionalProperties": { + "$ref": "Header" + }, + "description": "The headers in the document tab, keyed by header ID.", + "type": "object" + }, + "inlineObjects": { + "additionalProperties": { + "$ref": "InlineObject" + }, + "description": "The inline objects in the document tab, keyed by object ID.", + "type": "object" + }, + "lists": { + "additionalProperties": { + "$ref": "List" + }, + "description": "The lists in the document tab, keyed by list ID.", + "type": "object" + }, + "namedRanges": { + "additionalProperties": { + "$ref": "NamedRanges" + }, + "description": "The named ranges in the document tab, keyed by name.", + "type": "object" + }, + "namedStyles": { + "$ref": "NamedStyles", + "description": "The named styles of the document tab." + }, + "positionedObjects": { + "additionalProperties": { + "$ref": "PositionedObject" + }, + "description": "The positioned objects in the document tab, keyed by object ID.", + "type": "object" + }, + "suggestedDocumentStyleChanges": { + "additionalProperties": { + "$ref": "SuggestedDocumentStyle" + }, + "description": "The suggested changes to the style of the document tab, keyed by suggestion ID.", + "type": "object" + }, + "suggestedNamedStylesChanges": { + "additionalProperties": { + "$ref": "SuggestedNamedStyles" + }, + "description": "The suggested changes to the named styles of the document tab, keyed by suggestion ID.", + "type": "object" + } + }, + "type": "object" + }, "EmbeddedDrawingProperties": { "description": "The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.", "id": "EmbeddedDrawingProperties", @@ -1233,6 +1358,10 @@ "segmentId": { "description": "The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.", "type": "string" + }, + "tabId": { + "description": "The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" @@ -1352,6 +1481,21 @@ }, "type": "object" }, + "HeadingLink": { + "description": "A reference to a heading in this document.", + "id": "HeadingLink", + "properties": { + "id": { + "description": "The ID of a heading in this document.", + "type": "string" + }, + "tabId": { + "description": "The ID of the tab containing this heading.", + "type": "string" + } + }, + "type": "object" + }, "HorizontalRule": { "description": "A ParagraphElement representing a horizontal line.", "id": "HorizontalRule", @@ -1716,12 +1860,24 @@ "description": "A reference to another portion of a document or an external URL resource.", "id": "Link", "properties": { + "bookmark": { + "$ref": "BookmarkLink", + "description": "A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned." + }, "bookmarkId": { - "description": "The ID of a bookmark in this document.", + "description": "The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.", "type": "string" }, + "heading": { + "$ref": "HeadingLink", + "description": "A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned." + }, "headingId": { - "description": "The ID of a heading in this document.", + "description": "The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document.", + "type": "string" + }, + "tabId": { + "description": "The ID of a tab in this document.", "type": "string" }, "url": { @@ -1822,6 +1978,10 @@ "segmentId": { "description": "The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.", "type": "string" + }, + "tabId": { + "description": "The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" @@ -2760,6 +2920,10 @@ "description": "The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.", "format": "int32", "type": "integer" + }, + "tabId": { + "description": "The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" @@ -2775,6 +2939,10 @@ "replaceText": { "description": "The text that will replace the matched text.", "type": "string" + }, + "tabsCriteria": { + "$ref": "TabsCriteria", + "description": "Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs." } }, "type": "object" @@ -2811,6 +2979,10 @@ ], "type": "string" }, + "tabId": { + "description": "The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", + "type": "string" + }, "uri": { "description": "The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.", "type": "string" @@ -2830,6 +3002,10 @@ "description": "The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.", "type": "string" }, + "tabsCriteria": { + "$ref": "TabsCriteria", + "description": "Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs." + }, "text": { "description": "Replaces the content of the specified named range(s) with the given text.", "type": "string" @@ -3535,6 +3711,57 @@ }, "type": "object" }, + "Tab": { + "description": "A tab in a document.", + "id": "Tab", + "properties": { + "childTabs": { + "description": "The child tabs nested within this tab.", + "items": { + "$ref": "Tab" + }, + "type": "array" + }, + "documentTab": { + "$ref": "DocumentTab", + "description": "A tab with document contents, like text and images." + }, + "tabProperties": { + "$ref": "TabProperties", + "description": "The properties of the tab, like ID and title." + } + }, + "type": "object" + }, + "TabProperties": { + "description": "Properties of a tab.", + "id": "TabProperties", + "properties": { + "index": { + "description": "The zero-based index of the tab within the parent.", + "format": "int32", + "type": "integer" + }, + "nestingLevel": { + "description": "Output only. The depth of the tab within the document. Root-level tabs start at 0.", + "format": "int32", + "type": "integer" + }, + "parentTabId": { + "description": "Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.", + "type": "string" + }, + "tabId": { + "description": "Output only. The ID of the tab. This field can't be changed.", + "type": "string" + }, + "title": { + "description": "The user-visible name of the tab.", + "type": "string" + } + }, + "type": "object" + }, "TabStop": { "description": "A tab stop within a paragraph.", "id": "TabStop", @@ -3998,6 +4225,20 @@ }, "type": "object" }, + "TabsCriteria": { + "description": "A criteria that specifies in which tabs a request executes.", + "id": "TabsCriteria", + "properties": { + "tabIds": { + "description": "The list of tab IDs in which the request executes.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TextRun": { "description": "A ParagraphElement that represents a run of text that all has the same styling.", "id": "TextRun", @@ -4171,6 +4412,10 @@ "description": "The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `\"background\"`.", "format": "google-fieldmask", "type": "string" + }, + "tabId": { + "description": "The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.", + "type": "string" } }, "type": "object" diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index 9cd1f5c048..dfd690f916 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20240619", + "revision": "20240813", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4471,6 +4471,10 @@ "$ref": "GoogleCloudDocumentaiV1GcsDocument", "description": "A raw document on Google Cloud Storage." }, + "imagelessMode": { + "description": "Optional. Option to remove images from the document.", + "type": "boolean" + }, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1Document", "description": "An inline document proto." @@ -4686,6 +4690,11 @@ "$ref": "GoogleCloudDocumentaiV1DocumentSchema", "description": "The schema of the processor version. Describes the output." }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -4793,6 +4802,62 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", + "properties": { + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "properties": { + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", + "type": "string" + }, + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "properties": { + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" + }, + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1RawDocument": { "description": "Payload message of raw document content (bytes).", "id": "GoogleCloudDocumentaiV1RawDocument", diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index 840e8a667a..7cb71d0cf2 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -1284,7 +1284,7 @@ } } }, - "revision": "20240619", + "revision": "20240813", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -9073,6 +9073,10 @@ "$ref": "GoogleCloudDocumentaiV1beta3GcsDocument", "description": "A raw document on Google Cloud Storage." }, + "imagelessMode": { + "description": "Optional. Option to remove images from the document.", + "type": "boolean" + }, "inlineDocument": { "$ref": "GoogleCloudDocumentaiV1beta3Document", "description": "An inline document proto." @@ -9293,6 +9297,11 @@ "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", "description": "The schema of the processor version. Describes the output." }, + "genAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", + "description": "Output only. Information about Generative AI model-based processor versions.", + "readOnly": true + }, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -9400,6 +9409,62 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": { + "description": "Information about Generative AI model-based processor versions.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", + "properties": { + "customGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "description": "Information for a custom Generative AI model created by the user." + }, + "foundationGenAiModelInfo": { + "$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "description": "Information for a pretrained Google-managed foundation model." + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { + "description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", + "properties": { + "baseProcessorVersionId": { + "description": "The base processor version ID for the custom model.", + "type": "string" + }, + "customModelType": { + "description": "The type of custom model created by the user.", + "enum": [ + "CUSTOM_MODEL_TYPE_UNSPECIFIED", + "VERSIONED_FOUNDATION", + "FINE_TUNED" + ], + "enumDescriptions": [ + "The model type is unspecified.", + "The model is a versioned foundation model.", + "The model is a finetuned foundation model." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { + "description": "Information for a pretrained Google-managed foundation model.", + "id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", + "properties": { + "finetuningAllowed": { + "description": "Whether finetuning is allowed for this base processor version.", + "type": "boolean" + }, + "minTrainLabeledDocuments": { + "description": "The minimum number of labeled documents in the training dataset required for finetuning.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3PropertyMetadata": { "description": "Metadata about a property.", "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata", diff --git a/discovery/domains-v1.json b/discovery/domains-v1.json index 0bff1d5d5b..57eeebcb53 100644 --- a/discovery/domains-v1.json +++ b/discovery/domains-v1.json @@ -965,7 +965,7 @@ } } }, - "revision": "20240610", + "revision": "20240724", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1545,6 +1545,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "HealthCheckTargets", "properties": { + "externalEndpoints": { + "description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", + "items": { + "type": "string" + }, + "type": "array" + }, "internalLoadBalancer": { "description": "Configuration for internal load balancers to be health checked.", "items": { @@ -2020,6 +2027,10 @@ "$ref": "GeoPolicy", "deprecated": true }, + "healthCheck": { + "description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", + "type": "string" + }, "primaryBackup": { "$ref": "PrimaryBackupPolicy" }, diff --git a/discovery/domains-v1alpha2.json b/discovery/domains-v1alpha2.json index f0379bee53..4fe065a424 100644 --- a/discovery/domains-v1alpha2.json +++ b/discovery/domains-v1alpha2.json @@ -965,7 +965,7 @@ } } }, - "revision": "20240610", + "revision": "20240724", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1545,6 +1545,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "HealthCheckTargets", "properties": { + "externalEndpoints": { + "description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", + "items": { + "type": "string" + }, + "type": "array" + }, "internalLoadBalancer": { "description": "Configuration for internal load balancers to be health checked.", "items": { @@ -2020,6 +2027,10 @@ "$ref": "GeoPolicy", "deprecated": true }, + "healthCheck": { + "description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", + "type": "string" + }, "primaryBackup": { "$ref": "PrimaryBackupPolicy" }, diff --git a/discovery/domains-v1beta1.json b/discovery/domains-v1beta1.json index b6410b287b..fd9994fd9a 100644 --- a/discovery/domains-v1beta1.json +++ b/discovery/domains-v1beta1.json @@ -965,7 +965,7 @@ } } }, - "revision": "20240610", + "revision": "20240724", "rootUrl": "https://domains.googleapis.com/", "schemas": { "AuditConfig": { @@ -1545,6 +1545,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "HealthCheckTargets", "properties": { + "externalEndpoints": { + "description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", + "items": { + "type": "string" + }, + "type": "array" + }, "internalLoadBalancer": { "description": "Configuration for internal load balancers to be health checked.", "items": { @@ -2020,6 +2027,10 @@ "$ref": "GeoPolicy", "deprecated": true }, + "healthCheck": { + "description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", + "type": "string" + }, "primaryBackup": { "$ref": "PrimaryBackupPolicy" }, diff --git a/discovery/doubleclickbidmanager-v2.json b/discovery/doubleclickbidmanager-v2.json index 847c074268..fbeb27346e 100644 --- a/discovery/doubleclickbidmanager-v2.json +++ b/discovery/doubleclickbidmanager-v2.json @@ -107,7 +107,7 @@ "queries": { "methods": { "create": { - "description": "Creates a query.", + "description": "Creates a new query.", "flatPath": "queries", "httpMethod": "POST", "id": "doubleclickbidmanager.queries.create", @@ -125,7 +125,7 @@ ] }, "delete": { - "description": "Deletes a query as well as the associated reports.", + "description": "Deletes an existing query as well as its generated reports.", "flatPath": "queries/{queryId}", "httpMethod": "DELETE", "id": "doubleclickbidmanager.queries.delete", @@ -134,7 +134,7 @@ ], "parameters": { "queryId": { - "description": "Required. ID of query to delete.", + "description": "Required. The ID of the query to delete.", "format": "int64", "location": "path", "required": true, @@ -156,7 +156,7 @@ ], "parameters": { "queryId": { - "description": "Required. ID of query to retrieve.", + "description": "Required. The ID of the query to retrieve.", "format": "int64", "location": "path", "required": true, @@ -179,7 +179,7 @@ "parameterOrder": [], "parameters": { "orderBy": { - "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"metadata.title desc\". Sorting is only supported for the following fields: * `queryId` * `metadata.title`", + "description": "Field to sort the list by. Accepts the following values: * `queryId` (default) * `metadata.title` The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `queryId desc`.", "location": "query", "type": "string" }, @@ -190,7 +190,7 @@ "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous list call. Provide this to retrieve the subsequent page of queries.", + "description": "A token identifying which page of results the server should return. Typically, this is the value of nextPageToken, returned from the previous call to the `queries.list` method. If unspecified, the first page of results is returned.", "location": "query", "type": "string" } @@ -204,7 +204,7 @@ ] }, "run": { - "description": "Runs a stored query to generate a report.", + "description": "Runs an existing query to generate a report.", "flatPath": "queries/{queryId}:run", "httpMethod": "POST", "id": "doubleclickbidmanager.queries.run", @@ -213,14 +213,14 @@ ], "parameters": { "queryId": { - "description": "Required. ID of query to run.", + "description": "Required. The ID of the query to run.", "format": "int64", "location": "path", "required": true, "type": "string" }, "synchronous": { - "description": "Whether the query should be run synchronously. When true, this method will not return until the query has finished running. When false or not specified, this method will return immediately.", + "description": "Whether the query should be run synchronously. When `true`, the request won't return until the resulting report has finished running. This parameter is `false` by default. Setting this parameter to `true` is **not recommended**.", "location": "query", "type": "boolean" } @@ -251,14 +251,14 @@ ], "parameters": { "queryId": { - "description": "Required. ID of the query the report is associated with.", + "description": "Required. The ID of the query that generated the report.", "format": "int64", "location": "path", "required": true, "type": "string" }, "reportId": { - "description": "Required. ID of the report to retrieve.", + "description": "Required. The ID of the query to retrieve.", "format": "int64", "location": "path", "required": true, @@ -274,7 +274,7 @@ ] }, "list": { - "description": "Lists reports associated with a query.", + "description": "Lists reports generated by the provided query.", "flatPath": "queries/{queryId}/reports", "httpMethod": "GET", "id": "doubleclickbidmanager.queries.reports.list", @@ -283,7 +283,7 @@ ], "parameters": { "orderBy": { - "description": "Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a \" desc\" suffix. For example \"key.reportId desc\". Sorting is only supported for the following fields: * `key.reportId`", + "description": "Field to sort the list by. Accepts the following values: * `key.reportId` (default) The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `key.reportId desc`.", "location": "query", "type": "string" }, @@ -294,12 +294,12 @@ "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous list call. Provide this to retrieve the subsequent page of reports.", + "description": "A token identifying which page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to the `queries.reports.list` method. If unspecified, the first page of results is returned.", "location": "query", "type": "string" }, "queryId": { - "description": "Required. ID of the query with which the reports are associated.", + "description": "Required. The ID of the query that generated the reports.", "format": "int64", "location": "path", "required": true, @@ -319,23 +319,23 @@ } } }, - "revision": "20240424", + "revision": "20240731", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "DataRange": { - "description": "Report data range.", + "description": "The date range to be reported on.", "id": "DataRange", "properties": { "customEndDate": { "$ref": "Date", - "description": "The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise." + "description": "If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise." }, "customStartDate": { "$ref": "Date", - "description": "The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise." + "description": "If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise." }, "range": { - "description": "Report data range used to generate the report.", + "description": "The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range.", "enum": [ "RANGE_UNSPECIFIED", "CUSTOM_DATES", @@ -359,7 +359,7 @@ ], "enumDescriptions": [ "Default value when range is not specified or is unknown in this version.", - "Custom range specified by custom_start_date and custom_end_date fields.", + "Custom date range.", "Current day.", "Previous day.", "All days, including the current day, since the most recent Sunday.", @@ -406,15 +406,15 @@ "type": "object" }, "FilterPair": { - "description": "Filter used to match traffic data in your report.", + "description": "Represents a single filter rule.", "id": "FilterPair", "properties": { "type": { - "description": "Filter type.", + "description": "The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value.", "type": "string" }, "value": { - "description": "Filter value.", + "description": "The identifying value to filter by, such as a relevant resource ID.", "type": "string" } }, @@ -424,11 +424,11 @@ "id": "ListQueriesResponse", "properties": { "nextPageToken": { - "description": "A token, which can be sent as page_token to retrieve the next page of queries. If this field is omitted, there are no subsequent pages.", + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `queries.list` method to retrieve the next page of results.", "type": "string" }, "queries": { - "description": "The list of queries.", + "description": "The list of queries. This field will be absent if empty.", "items": { "$ref": "Query" }, @@ -441,11 +441,11 @@ "id": "ListReportsResponse", "properties": { "nextPageToken": { - "description": "A token, which can be sent as page_token to retrieve the next page of reports. If this field is omitted, there are no subsequent pages.", + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `queries.reports.list` method to retrieve the next page of results.", "type": "string" }, "reports": { - "description": "Retrieved reports.", + "description": "The list of reports. This field will be absent if empty.", "items": { "$ref": "Report" }, @@ -455,36 +455,36 @@ "type": "object" }, "Options": { - "description": "Additional query options.", + "description": "Report parameter options.", "id": "Options", "properties": { "includeOnlyTargetedUserLists": { - "description": "Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items.", + "description": "Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters.", "type": "boolean" } }, "type": "object" }, "Parameters": { - "description": "Parameters of a query or report.", + "description": "Parameters of a generated report.", "id": "Parameters", "properties": { "filters": { - "description": "Filters used to match traffic data in your report.", + "description": "Filters to limit the scope of reported data.", "items": { "$ref": "FilterPair" }, "type": "array" }, "groupBys": { - "description": "Data is grouped by the filters listed in this field.", + "description": "Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values.", "items": { "type": "string" }, "type": "array" }, "metrics": { - "description": "Metrics to include as columns in your report.", + "description": "Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values.", "items": { "type": "string" }, @@ -492,10 +492,10 @@ }, "options": { "$ref": "Options", - "description": "Additional query options." + "description": "Additional report parameter options." }, "type": { - "description": "The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used.", + "description": "The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used.", "enum": [ "REPORT_TYPE_UNSPECIFIED", "STANDARD", @@ -506,7 +506,9 @@ "GRP", "YOUTUBE_PROGRAMMATIC_GUARANTEED", "REACH", - "UNIQUE_REACH_AUDIENCE" + "UNIQUE_REACH_AUDIENCE", + "FULL_PATH", + "PATH_ATTRIBUTION" ], "enumDeprecated": [ false, @@ -518,7 +520,9 @@ false, false, false, - false + false, + true, + true ], "enumDescriptions": [ "Default value when report type is not specified or is unknown in this version.", @@ -530,7 +534,9 @@ "GRP report.", "YouTube Programmatic Guaranteed report.", "Reach report.", - "Unique Reach Audience report." + "Unique Reach Audience report.", + "Full Path report.", + "Path Attribution report." ], "type": "string" } @@ -538,40 +544,40 @@ "type": "object" }, "Query": { - "description": "Represents a query.", + "description": "A single query used to generate a report.", "id": "Query", "properties": { "metadata": { "$ref": "QueryMetadata", - "description": "Query metadata." + "description": "The metadata of the query." }, "params": { "$ref": "Parameters", - "description": "Query parameters." + "description": "The parameters of the report generated by the query." }, "queryId": { - "description": "Output only. Query ID.", + "description": "Output only. The unique ID of the query.", "format": "int64", "readOnly": true, "type": "string" }, "schedule": { "$ref": "QuerySchedule", - "description": "Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation." + "description": "When and how often the query is scheduled to run. If the frequency field is set to `ONE_TIME`, the query will only run when queries.run is called." } }, "type": "object" }, "QueryMetadata": { - "description": "Query metadata.", + "description": "The metadata of the query.", "id": "QueryMetadata", "properties": { "dataRange": { "$ref": "DataRange", - "description": "Range of report data. All reports will be based on the same time zone as used by the advertiser." + "description": "The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser." }, "format": { - "description": "Format of the generated report.", + "description": "The format of the report generated by the query.", "enum": [ "FORMAT_UNSPECIFIED", "CSV", @@ -585,33 +591,33 @@ "type": "string" }, "sendNotification": { - "description": "Whether to send an email notification when a report is ready. Defaults to false.", + "description": "Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default.", "type": "boolean" }, "shareEmailAddress": { - "description": "List of email addresses which are sent email notifications when the report is finished. Separate from send_notification.", + "description": "List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface.", "items": { "type": "string" }, "type": "array" }, "title": { - "description": "Query title. It is used to name the reports generated from this query.", + "description": "The display name of the query. This value will be used in the file name of reports generated by the query.", "type": "string" } }, "type": "object" }, "QuerySchedule": { - "description": "Information on when and how frequently to run a query.", + "description": "Settings on when and how frequently to run a query.", "id": "QuerySchedule", "properties": { "endDate": { "$ref": "Date", - "description": "Date to periodically run the query until. Not applicable to `ONE_TIME` frequency." + "description": "The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored." }, "frequency": { - "description": "How often the query is run.", + "description": "How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called.", "enum": [ "FREQUENCY_UNSPECIFIED", "ONE_TIME", @@ -624,58 +630,58 @@ ], "enumDescriptions": [ "Default value when frequency is not specified or is unknown in this version.", - "Only once.", + "Only when the query is run manually.", "Once a day.", "Once a week.", "Twice a month.", "Once a month.", - "Once a quarter", + "Once a quarter.", "Once a year." ], "type": "string" }, "nextRunTimezoneCode": { - "description": "Canonical timezone code for report generation time. Defaults to `America/New_York`.", + "description": "The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`.", "type": "string" }, "startDate": { "$ref": "Date", - "description": "When to start running the query. Not applicable to `ONE_TIME` frequency." + "description": "The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored." } }, "type": "object" }, "Report": { - "description": "Represents a report.", + "description": "A single report generated by its parent report.", "id": "Report", "properties": { "key": { "$ref": "ReportKey", - "description": "Key used to identify a report." + "description": "The key information identifying the report." }, "metadata": { "$ref": "ReportMetadata", - "description": "Report metadata." + "description": "The metadata of the report." }, "params": { "$ref": "Parameters", - "description": "Report parameters." + "description": "The parameters of the report." } }, "type": "object" }, "ReportKey": { - "description": "Key used to identify a report.", + "description": "Identifying information of a report.", "id": "ReportKey", "properties": { "queryId": { - "description": "Output only. Query ID.", + "description": "Output only. The unique ID of the query that generated the report.", "format": "int64", "readOnly": true, "type": "string" }, "reportId": { - "description": "Output only. Report ID.", + "description": "Output only. The unique ID of the report.", "format": "int64", "readOnly": true, "type": "string" @@ -684,41 +690,41 @@ "type": "object" }, "ReportMetadata": { - "description": "Report metadata.", + "description": "The metadata of a report.", "id": "ReportMetadata", "properties": { "googleCloudStoragePath": { - "description": "Output only. The path to the location in Google Cloud Storage where the report is stored.", + "description": "Output only. The location of the generated report file in Google Cloud Storage. This field will be absent if status.state is not `DONE`.", "readOnly": true, "type": "string" }, "reportDataEndDate": { "$ref": "Date", - "description": "The ending time for the data that is shown in the report." + "description": "The end date of the report data date range." }, "reportDataStartDate": { "$ref": "Date", - "description": "The starting time for the data that is shown in the report." + "description": "The start date of the report data date range." }, "status": { "$ref": "ReportStatus", - "description": "Report status." + "description": "The status of the report." } }, "type": "object" }, "ReportStatus": { - "description": "Report status.", + "description": "The status of a report.", "id": "ReportStatus", "properties": { "finishTime": { - "description": "Output only. The time when this report either completed successfully or failed.", + "description": "Output only. The timestamp of when report generation finished successfully or in failure. This field will not be set unless state is `DONE` or `FAILED`.", "format": "google-datetime", "readOnly": true, "type": "string" }, "format": { - "description": "The file type of the report.", + "description": "The format of the generated report file.", "enum": [ "FORMAT_UNSPECIFIED", "CSV", @@ -732,7 +738,7 @@ "type": "string" }, "state": { - "description": "Output only. The state of the report.", + "description": "Output only. The state of the report generation.", "enum": [ "STATE_UNSPECIFIED", "QUEUED", @@ -754,12 +760,12 @@ "type": "object" }, "RunQueryRequest": { - "description": "Request to run a stored query to generate a report.", + "description": "Details specifying how to run a query.", "id": "RunQueryRequest", "properties": { "dataRange": { "$ref": "DataRange", - "description": "Report data range used to generate the report. If unspecified, the original parent query's data range is used." + "description": "The date range used by the query to generate the report. If unspecified, the query's original data_range is used." } }, "type": "object" diff --git a/discovery/drive-v2.json b/discovery/drive-v2.json index a20c3a4c3c..289c4ec6f9 100644 --- a/discovery/drive-v2.json +++ b/discovery/drive-v2.json @@ -1495,7 +1495,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", - "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files.", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -2380,7 +2380,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", - "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files.", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -3869,7 +3869,7 @@ } } }, - "revision": "20240522", + "revision": "20240730", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -5614,10 +5614,10 @@ "description": "Output only. User that shared the item with the current user, if available." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests.", "properties": { "targetId": { - "description": "The ID of the file that this shortcut points to.", + "description": "The ID of the file that this shortcut points to. Can only be set on `files.insert` requests.", "type": "string" }, "targetMimeType": { @@ -5659,7 +5659,7 @@ "type": "object" }, "thumbnailLink": { - "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.", + "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.", "type": "string" }, "thumbnailVersion": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index a225c08a5b..384488a061 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -1253,7 +1253,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", - "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -1612,7 +1612,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", - "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -2247,7 +2247,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", - "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", + "description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -2523,7 +2523,7 @@ } } }, - "revision": "20240521", + "revision": "20240730", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3851,10 +3851,10 @@ "description": "Output only. The user who shared the file with the requesting user, if applicable." }, "shortcutDetails": { - "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`.", + "description": "Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.", "properties": { "targetId": { - "description": "The ID of the file that this shortcut points to.", + "description": "The ID of the file that this shortcut points to. Can only be set on `files.create` requests.", "type": "string" }, "targetMimeType": { @@ -3890,7 +3890,7 @@ "type": "string" }, "thumbnailLink": { - "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.", + "description": "Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.", "type": "string" }, "thumbnailVersion": { diff --git a/discovery/essentialcontacts-v1.json b/discovery/essentialcontacts-v1.json index b133e0eeb5..55545d3737 100644 --- a/discovery/essentialcontacts-v1.json +++ b/discovery/essentialcontacts-v1.json @@ -850,7 +850,7 @@ } } }, - "revision": "20221220", + "revision": "20240707", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { @@ -923,7 +923,7 @@ "type": "string" }, "validationState": { - "description": "The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", + "description": "Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", "enum": [ "VALIDATION_STATE_UNSPECIFIED", "VALID", @@ -934,6 +934,7 @@ "The contact is marked as valid. This is usually done manually by the contact admin. All new contacts begin in the valid state.", "The contact is considered invalid. This may become the state if the contact's email is found to be unreachable." ], + "readOnly": true, "type": "string" } }, diff --git a/discovery/file-v1.json b/discovery/file-v1.json index e6e834b277..020f642b7e 100644 --- a/discovery/file-v1.json +++ b/discovery/file-v1.json @@ -902,7 +902,7 @@ } } }, - "revision": "20240619", + "revision": "20240716", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1118,15 +1118,6 @@ }, "type": "array" }, - "performanceConfig": { - "$ref": "PerformanceConfig", - "description": "Optional. Used to configure performance." - }, - "performanceLimits": { - "$ref": "PerformanceLimits", - "description": "Output only. Used for getting performance limits.", - "readOnly": true - }, "sourceBackup": { "description": "The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.", "type": "string" @@ -1134,18 +1125,6 @@ }, "type": "object" }, - "FixedIOPS": { - "description": "Fixed IOPS parameters.", - "id": "FixedIOPS", - "properties": { - "maxReadIops": { - "description": "Required. Maximum raw read IOPS.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", @@ -1421,18 +1400,6 @@ }, "type": "object" }, - "IOPSPerGB": { - "description": "IOPS per capacity parameters.", - "id": "IOPSPerGB", - "properties": { - "maxReadIopsPerGb": { - "description": "Required. Maximum read IOPS per GB.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "Instance": { "description": "A Filestore instance.", "id": "Instance", @@ -1971,56 +1938,6 @@ }, "type": "object" }, - "PerformanceConfig": { - "description": "Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation.", - "id": "PerformanceConfig", - "properties": { - "fixedIops": { - "$ref": "FixedIOPS", - "description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." - }, - "iopsByCapacity": { - "description": "Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation.", - "type": "boolean" - }, - "iopsPerGb": { - "$ref": "IOPSPerGB", - "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." - } - }, - "type": "object" - }, - "PerformanceLimits": { - "description": "The enforced performance limits, calculated from the instance's performance configuration.", - "id": "PerformanceLimits", - "properties": { - "maxReadIops": { - "description": "Output only. The max read IOPS.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "maxReadThroughput": { - "description": "Output only. The max read throughput.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "maxWriteIops": { - "description": "Output only. The max write IOPS.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "maxWriteThroughput": { - "description": "Output only. The max write throughput.", - "format": "int64", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", diff --git a/discovery/file-v1beta1.json b/discovery/file-v1beta1.json index 6c63bca5f3..1beeeb63c7 100644 --- a/discovery/file-v1beta1.json +++ b/discovery/file-v1beta1.json @@ -1069,7 +1069,7 @@ } } }, - "revision": "20240619", + "revision": "20240716", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1098,6 +1098,21 @@ "readOnly": true, "type": "string" }, + "fileSystemProtocol": { + "description": "Output only. The file system protocol of the source Filestore instance that this backup is created from.", + "enum": [ + "FILE_PROTOCOL_UNSPECIFIED", + "NFS_V3", + "NFS_V4_1" + ], + "enumDescriptions": [ + "FILE_PROTOCOL_UNSPECIFIED serves a \"not set\" default value when a FileProtocol is a separate field in a message.", + "NFS 3.0.", + "NFS 4.1." + ], + "readOnly": true, + "type": "string" + }, "kmsKeyName": { "description": "Immutable. KMS key name used for data encryption.", "type": "string" @@ -1296,15 +1311,6 @@ }, "type": "array" }, - "performanceConfig": { - "$ref": "PerformanceConfig", - "description": "Optional. Used to configure performance." - }, - "performanceLimits": { - "$ref": "PerformanceLimits", - "description": "Output only. Used for getting performance limits.", - "readOnly": true - }, "sourceBackup": { "description": "The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.", "type": "string" @@ -1312,18 +1318,6 @@ }, "type": "object" }, - "FixedIOPS": { - "description": "Fixed IOPS parameters.", - "id": "FixedIOPS", - "properties": { - "maxReadIops": { - "description": "Required. Maximum raw read IOPS.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", @@ -1599,18 +1593,6 @@ }, "type": "object" }, - "IOPSPerGB": { - "description": "IOPS per capacity parameters.", - "id": "IOPSPerGB", - "properties": { - "maxReadIopsPerGb": { - "description": "Required. Maximum read IOPS per GB.", - "format": "int64", - "type": "string" - } - }, - "type": "object" - }, "Instance": { "description": "A Filestore instance.", "id": "Instance", @@ -2254,56 +2236,6 @@ }, "type": "object" }, - "PerformanceConfig": { - "description": "Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation.", - "id": "PerformanceConfig", - "properties": { - "fixedIops": { - "$ref": "FixedIOPS", - "description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." - }, - "iopsByCapacity": { - "description": "Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation.", - "type": "boolean" - }, - "iopsPerGb": { - "$ref": "IOPSPerGB", - "description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." - } - }, - "type": "object" - }, - "PerformanceLimits": { - "description": "The enforced performance limits, calculated from the instance's performance configuration.", - "id": "PerformanceLimits", - "properties": { - "maxReadIops": { - "description": "Output only. The max read IOPS.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "maxReadThroughput": { - "description": "Output only. The max read throughput.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "maxWriteIops": { - "description": "Output only. The max write IOPS.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "maxWriteThroughput": { - "description": "Output only. The max write throughput.", - "format": "int64", - "readOnly": true, - "type": "string" - } - }, - "type": "object" - }, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", diff --git a/discovery/firebaseappcheck-v1.json b/discovery/firebaseappcheck-v1.json index 293b915c4e..af417cfe54 100644 --- a/discovery/firebaseappcheck-v1.json +++ b/discovery/firebaseappcheck-v1.json @@ -1458,12 +1458,210 @@ "https://www.googleapis.com/auth/firebase" ] } + }, + "resources": { + "resourcePolicies": { + "methods": { + "batchUpdate": { + "description": "Atomically updates the specified ResourcePolicy configurations.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies:batchUpdate", + "httpMethod": "POST", + "id": "firebaseappcheck.projects.services.resourcePolicies.batchUpdate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent service name, in the format ``` projects/{project_number}/services/{service_id} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/resourcePolicies:batchUpdate", + "request": { + "$ref": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "create": { + "description": "Creates the specified ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies", + "httpMethod": "POST", + "id": "firebaseappcheck.projects.services.resourcePolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/resourcePolicies", + "request": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "delete": { + "description": "Deletes the specified ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}", + "httpMethod": "DELETE", + "id": "firebaseappcheck.projects.services.resourcePolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ```", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "get": { + "description": "Gets the requested ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.services.resourcePolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "list": { + "description": "Lists all ResourcePolicy configurations for the specified project and service.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies", + "httpMethod": "GET", + "id": "firebaseappcheck.projects.services.resourcePolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = \"//oauth2.googleapis.com/projects/12345/oauthClients/\"` * `enforcement_mode = ENFORCED AND target_resource = \"//oauth2.googleapis.com/projects/12345/oauthClients/\"`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/resourcePolicies", + "response": { + "$ref": "GoogleFirebaseAppcheckV1ListResourcePoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + }, + "patch": { + "description": "Updates the specified ResourcePolicy configuration.", + "flatPath": "v1/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}", + "httpMethod": "PATCH", + "id": "firebaseappcheck.projects.services.resourcePolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.", + "location": "path", + "pattern": "^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "response": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } + } } } } } }, - "revision": "20240528", + "revision": "20240708", "rootUrl": "https://firebaseappcheck.googleapis.com/", "schemas": { "GoogleFirebaseAppcheckV1AppAttestConfig": { @@ -1583,6 +1781,39 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest": { + "description": "Request message for the BatchUpdateResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest", + "properties": { + "requests": { + "description": "Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest" + }, + "type": "array" + }, + "updateMask": { + "description": "Optional. A comma-separated list of names of fields in the ResourcePolicy objects to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, + "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse": { + "description": "Response message for the BatchUpdateResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse", + "properties": { + "resourcePolicies": { + "description": "ResourcePolicy objects after the updates have been applied.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1BatchUpdateServicesRequest": { "description": "Request message for the BatchUpdateServices method.", "id": "GoogleFirebaseAppcheckV1BatchUpdateServicesRequest", @@ -1903,6 +2134,24 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1ListResourcePoliciesResponse": { + "description": "Response message for the ListResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1ListResourcePoliciesResponse", + "properties": { + "nextPageToken": { + "description": "If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted.", + "type": "string" + }, + "resourcePolicies": { + "description": "The ResourcePolicy objects retrieved.", + "items": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1ListServicesResponse": { "description": "Response message for the ListServices method.", "id": "GoogleFirebaseAppcheckV1ListServicesResponse", @@ -2027,6 +2276,45 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1ResourcePolicy": { + "description": "App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration.", + "id": "GoogleFirebaseAppcheckV1ResourcePolicy", + "properties": { + "enforcementMode": { + "description": "Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service.", + "enum": [ + "OFF", + "UNENFORCED", + "ENFORCED" + ], + "enumDescriptions": [ + "Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default.", + "Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `UNENFORCED` setting will have no effect and App Check will not work with that service.", + "Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Some services require certain conditions to be met before they will work with App Check, such as requiring you to upgrade to a specific service tier. Until those requirements are met for a service, this `ENFORCED` setting will have no effect and App Check will not work with that service." + ], + "type": "string" + }, + "etag": { + "description": "This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232.", + "type": "string" + }, + "name": { + "description": "Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID.", + "type": "string" + }, + "targetResource": { + "description": "Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number}/oauthClients/{oauth_client_id}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created.", + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this resource policy configuration object was most recently updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1SafetyNetConfig": { "deprecated": true, "description": "An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v11/projects.androidApps.sha/create).", @@ -2069,6 +2357,22 @@ }, "type": "object" }, + "GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest": { + "description": "Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method.", + "id": "GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest", + "properties": { + "resourcePolicy": { + "$ref": "GoogleFirebaseAppcheckV1ResourcePolicy", + "description": "Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)" + }, + "updateMask": { + "description": "Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.", + "format": "google-fieldmask", + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppcheckV1UpdateServiceRequest": { "description": "Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method.", "id": "GoogleFirebaseAppcheckV1UpdateServiceRequest", diff --git a/discovery/firebaseappdistribution-v1alpha.json b/discovery/firebaseappdistribution-v1alpha.json index 49dc142510..daaa28613f 100644 --- a/discovery/firebaseappdistribution-v1alpha.json +++ b/discovery/firebaseappdistribution-v1alpha.json @@ -585,9 +585,24 @@ } } }, - "revision": "20240628", + "revision": "20240726", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { + "AndroidxCrawlerOutputPoint": { + "description": "Point for describing bounding boxes tap locations Top left is 0,0", + "id": "AndroidxCrawlerOutputPoint", + "properties": { + "xCoordinate": { + "format": "int32", + "type": "integer" + }, + "yCoordinate": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1Release": { "description": "A release of a Firebase app.", "id": "GoogleFirebaseAppdistroV1Release", @@ -708,16 +723,16 @@ "steps": { "description": "Required. Steps to be accomplished by the AI", "items": { - "$ref": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep" + "$ref": "GoogleFirebaseAppdistroV1alphaAiStep" }, "type": "array" } }, "type": "object" }, - "GoogleFirebaseAppdistroV1alphaAiInstructionsStep": { + "GoogleFirebaseAppdistroV1alphaAiStep": { "description": "A step to be accomplished by the AI", - "id": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep", + "id": "GoogleFirebaseAppdistroV1alphaAiStep", "properties": { "assertion": { "description": "An assertion to be checked by the AI", @@ -730,6 +745,44 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaAiStepResult": { + "description": "Captures the results of an AiStep", + "id": "GoogleFirebaseAppdistroV1alphaAiStepResult", + "properties": { + "assertionDetails": { + "$ref": "GoogleFirebaseAppdistroV1alphaAssertionDetails", + "description": "Output only. Details for an assertion step.", + "readOnly": true + }, + "goalDetails": { + "$ref": "GoogleFirebaseAppdistroV1alphaGoalDetails", + "description": "Output only. Details for a goal step.", + "readOnly": true + }, + "state": { + "description": "Output only. The current state of the step", + "enum": [ + "STEP_STATE_UNSPECIFIED", + "IN_PROGRESS", + "PASSED", + "FAILED" + ], + "enumDescriptions": [ + "Step state unspecified", + "The step is in progress", + "The step has completed successfully", + "The step has failed" + ], + "readOnly": true, + "type": "string" + }, + "step": { + "$ref": "GoogleFirebaseAppdistroV1alphaAiStep", + "description": "Required. The step performed by the AI" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaApp": { "id": "GoogleFirebaseAppdistroV1alphaApp", "properties": { @@ -799,6 +852,28 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaAssertionDetails": { + "description": "Details for an assertion step.", + "id": "GoogleFirebaseAppdistroV1alphaAssertionDetails", + "properties": { + "explanation": { + "description": "Output only. An explanation justifying the assertion result.", + "readOnly": true, + "type": "string" + }, + "result": { + "description": "Output only. The result of the assertion.", + "readOnly": true, + "type": "boolean" + }, + "screenshot": { + "$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", + "description": "Output only. The screenshot used in the context of this assertion.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest": { "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest", "properties": { @@ -814,10 +889,38 @@ "properties": {}, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaDeviceAction": { + "description": "A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc.", + "id": "GoogleFirebaseAppdistroV1alphaDeviceAction", + "properties": { + "description": { + "description": "Output only. A short description of the high level action taken by the AI agent.", + "readOnly": true, + "type": "string" + }, + "deviceInteractions": { + "description": "Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc.", + "items": { + "$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteraction" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaDeviceExecution": { "description": "The results of running an automated test on a particular device.", "id": "GoogleFirebaseAppdistroV1alphaDeviceExecution", "properties": { + "aiStepResults": { + "description": "Output only. Results of the AI steps if passed in", + "items": { + "$ref": "GoogleFirebaseAppdistroV1alphaAiStepResult" + }, + "readOnly": true, + "type": "array" + }, "appCrash": { "$ref": "GoogleFirebaseAppdistroV1alphaAppCrash", "description": "Output only. An app crash, if any occurred during the test.", @@ -839,14 +942,16 @@ "CRASHED", "NOT_INSTALLED", "UNABLE_TO_CRAWL", - "DEVICE_OUT_OF_MEMORY" + "DEVICE_OUT_OF_MEMORY", + "FAILED_AI_STEP" ], "enumDescriptions": [ "Reason unspecified.", "The app crashed during the test.", "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.", "If the app could not be crawled (possibly because the app did not start).", - "If the device ran out of memory during the test." + "If the device ran out of memory during the test.", + "At least one AI step failed." ], "readOnly": true, "type": "string" @@ -925,6 +1030,68 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaDeviceInteraction": { + "description": "An interaction with the device, such as a tap, text entry, wait, etc.", + "id": "GoogleFirebaseAppdistroV1alphaDeviceInteraction", + "properties": { + "screenshot": { + "$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", + "description": "Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.", + "readOnly": true + }, + "swipe": { + "$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe", + "description": "Output only. A swipe action.", + "readOnly": true + }, + "tap": { + "$ref": "AndroidxCrawlerOutputPoint", + "description": "Output only. A tap action.", + "readOnly": true + }, + "textInput": { + "description": "Output only. Text entered for a text entry action.", + "readOnly": true, + "type": "string" + }, + "wait": { + "$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteractionWait", + "description": "Output only. A wait action.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe": { + "description": "A swipe action.", + "id": "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe", + "properties": { + "end": { + "$ref": "AndroidxCrawlerOutputPoint", + "description": "Output only. The end point of the swipe.", + "readOnly": true + }, + "start": { + "$ref": "AndroidxCrawlerOutputPoint", + "description": "Output only. The start point of the swipe.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleFirebaseAppdistroV1alphaDeviceInteractionWait": { + "description": "A wait action.", + "id": "GoogleFirebaseAppdistroV1alphaDeviceInteractionWait", + "properties": { + "duration": { + "description": "Output only. The duration of the wait.", + "format": "google-duration", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest": { "id": "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest", "properties": { @@ -1069,6 +1236,43 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaGoalAction": { + "description": "An action taken by the AI agent while attempting to accomplish a goal.", + "id": "GoogleFirebaseAppdistroV1alphaGoalAction", + "properties": { + "deviceAction": { + "$ref": "GoogleFirebaseAppdistroV1alphaDeviceAction", + "description": "Output only. A high level action taken by the AI on the device.", + "readOnly": true + }, + "explanation": { + "description": "Output only. An explanation justifying why the action was taken.", + "readOnly": true, + "type": "string" + }, + "terminalAction": { + "$ref": "GoogleFirebaseAppdistroV1alphaTerminalAction", + "description": "Output only. An action taken by the AI to end the goal.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleFirebaseAppdistroV1alphaGoalDetails": { + "description": "Details for a goal step.", + "id": "GoogleFirebaseAppdistroV1alphaGoalDetails", + "properties": { + "goalActions": { + "description": "Output only. The actions taken by the AI while attempting to accomplish the goal.", + "items": { + "$ref": "GoogleFirebaseAppdistroV1alphaGoalAction" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaJwt": { "id": "GoogleFirebaseAppdistroV1alphaJwt", "properties": { @@ -1212,7 +1416,7 @@ "properties": { "aiInstructions": { "$ref": "GoogleFirebaseAppdistroV1alphaAiInstructions", - "description": "Optional. Input only. Instructions for AI driven test. Input only." + "description": "Optional. Instructions for AI driven test." }, "createTime": { "description": "Output only. Timestamp when the test was run.", @@ -1283,6 +1487,57 @@ }, "type": "object" }, + "GoogleFirebaseAppdistroV1alphaScreenshot": { + "description": "A device screenshot taken during a test.", + "id": "GoogleFirebaseAppdistroV1alphaScreenshot", + "properties": { + "height": { + "description": "Output only. The height of the screenshot, in pixels.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "uri": { + "description": "Output only. The URI of the screenshot.", + "readOnly": true, + "type": "string" + }, + "width": { + "description": "Output only. The width of the screenshot, in pixels.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "GoogleFirebaseAppdistroV1alphaTerminalAction": { + "description": "An action taken by the AI to end the goal.", + "id": "GoogleFirebaseAppdistroV1alphaTerminalAction", + "properties": { + "reason": { + "description": "Output only. The reason why this goal was ended.", + "enum": [ + "REASON_UNSPECIFIED", + "GOAL_IMPOSSIBLE", + "GOAL_COMPLETE" + ], + "enumDescriptions": [ + "Reason unspecified.", + "The goal was impossible to accomplish.", + "The goal was completed successfully." + ], + "readOnly": true, + "type": "string" + }, + "screenshot": { + "$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", + "description": "Output only. The screenshot used in the context of this terminal action.", + "readOnly": true + } + }, + "type": "object" + }, "GoogleFirebaseAppdistroV1alphaTestConfig": { "description": "Configuration for automated tests", "id": "GoogleFirebaseAppdistroV1alphaTestConfig", diff --git a/discovery/firebaseml-v2beta.json b/discovery/firebaseml-v2beta.json index 7da414ba59..ab61e73651 100644 --- a/discovery/firebaseml-v2beta.json +++ b/discovery/firebaseml-v2beta.json @@ -151,7 +151,7 @@ ], "parameters": { "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, @@ -179,7 +179,7 @@ ], "parameters": { "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project}/locations/{location}/publishers/*/models/*` Tuned model endpoint format: `projects/{project}/locations/{location}/endpoints/{endpoint}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/publishers/[^/]+/models/[^/]+$", "required": true, @@ -206,7 +206,7 @@ } } }, - "revision": "20240625", + "revision": "20240813", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -251,6 +251,12 @@ "description": "A response candidate generated from the model.", "id": "GoogleCloudAiplatformV1beta1Candidate", "properties": { + "avgLogprobs": { + "description": "Output only. Average log probability score of the candidate.", + "format": "double", + "readOnly": true, + "type": "number" + }, "citationMetadata": { "$ref": "GoogleCloudAiplatformV1beta1CitationMetadata", "description": "Output only. Source attribution of the generated content.", @@ -282,14 +288,14 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", - "Natural stop point of the model or provided stop sequence.", - "The maximum number of tokens as specified in the request was reached.", - "The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", - "The token generation was stopped as the response was flagged for unauthorized citations.", - "All other reasons that stopped the token generation", - "The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", - "The token generation was stopped as the response was flagged for the prohibited contents.", - "The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", + "Token generation reached a natural stopping point or a configured stop sequence.", + "Token generation reached the configured maximum output tokens.", + "Token generation stopped because the content potentially contains safety violations. NOTE: When streaming, content is empty if content filters blocks the output.", + "Token generation stopped because the content potentially contains copyright violations.", + "All other reasons that stopped the token generation.", + "Token generation stopped because the content contains forbidden terms.", + "Token generation stopped for potentially containing prohibited content.", + "Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid." ], "readOnly": true, @@ -394,22 +400,33 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { - "description": "Required. Input content.", + "description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { - "description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", + "description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { - "description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", + "description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" + }, + "systemInstruction": { + "$ref": "GoogleCloudAiplatformV1beta1Content", + "description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." + }, + "tools": { + "description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1Tool" + }, + "type": "array" } }, "type": "object" @@ -486,9 +503,9 @@ ], "enumDescriptions": [ "Unspecified function calling mode. This value should not be used.", - "Default model behavior, model decides to predict either a function call or a natural language repspose.", - "Model is constrained to always predicting a function call only. If \"allowed_function_names\" are set, the predicted function call will be limited to any one of \"allowed_function_names\", else the predicted function call will be any one of the provided \"function_declarations\".", - "Model will not predict any function call. Model behavior is same as when not passing any function declarations." + "Default model behavior, model decides to predict either function calls or natural language response.", + "Model is constrained to always predicting function calls only. If \"allowed_function_names\" are set, the predicted function calls will be limited to any one of \"allowed_function_names\", else the predicted function calls will be any one of the provided \"function_declarations\".", + "Model will not predict any function calls. Model behavior is same as when not passing any function declarations." ], "type": "string" } @@ -654,7 +671,7 @@ "type": "integer" }, "promptTokenCount": { - "description": "Number of tokens in the request.", + "description": "Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content.", "format": "int32", "type": "integer" }, @@ -697,6 +714,15 @@ "$ref": "GoogleCloudAiplatformV1beta1Schema", "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." }, + "routingConfig": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", + "description": "Optional. Routing configuration." + }, + "seed": { + "description": "Optional. Seed.", + "format": "int32", + "type": "integer" + }, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -722,72 +748,61 @@ }, "type": "object" }, - "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { - "description": "Tool to retrieve public web data for grounding, powered by Google.", - "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", - "properties": {}, - "type": "object" - }, - "GoogleCloudAiplatformV1beta1GroundingAttribution": { - "description": "Grounding attribution.", - "id": "GoogleCloudAiplatformV1beta1GroundingAttribution", + "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { + "description": "The configuration for routing the request to a specific model.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", "properties": { - "confidenceScore": { - "description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", - "format": "float", - "readOnly": true, - "type": "number" - }, - "retrievedContext": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", - "description": "Optional. Attribution from context retrieved by the retrieval tools." - }, - "segment": { - "$ref": "GoogleCloudAiplatformV1beta1Segment", - "description": "Output only. Segment of the content this attribution belongs to.", - "readOnly": true + "autoMode": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", + "description": "Automated routing." }, - "web": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", - "description": "Optional. Attribution from the web." + "manualMode": { + "$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", + "description": "Manual routing." } }, "type": "object" }, - "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext": { - "description": "Attribution from context retrieved by the retrieval tools.", - "id": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", + "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { + "description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", "properties": { - "title": { - "description": "Output only. Title of the attribution.", - "readOnly": true, - "type": "string" - }, - "uri": { - "description": "Output only. URI reference of the attribution.", - "readOnly": true, + "modelRoutingPreference": { + "description": "The model routing preference.", + "enum": [ + "UNKNOWN", + "PRIORITIZE_QUALITY", + "BALANCED", + "PRIORITIZE_COST" + ], + "enumDescriptions": [ + "Unspecified model routing preference.", + "Prefer higher quality over low cost.", + "Balanced model routing preference.", + "Prefer lower cost over higher quality." + ], "type": "string" } }, "type": "object" }, - "GoogleCloudAiplatformV1beta1GroundingAttributionWeb": { - "description": "Attribution from the web.", - "id": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", + "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { + "description": "When manual routing is set, the specified model will be used directly.", + "id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", "properties": { - "title": { - "description": "Output only. Title of the attribution.", - "readOnly": true, - "type": "string" - }, - "uri": { - "description": "Output only. URI reference of the attribution.", - "readOnly": true, + "modelName": { + "description": "The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'.", "type": "string" } }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { + "description": "Tool to retrieve public web data for grounding, powered by Google.", + "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", @@ -837,13 +852,6 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { - "groundingAttributions": { - "description": "Optional. List of grounding attributions.", - "items": { - "$ref": "GoogleCloudAiplatformV1beta1GroundingAttribution" - }, - "type": "array" - }, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -942,7 +950,8 @@ "id": "GoogleCloudAiplatformV1beta1Retrieval", "properties": { "disableAttribution": { - "description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", + "deprecated": true, + "description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -1296,11 +1305,11 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1VertexAISearch": { - "description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation", + "description": "Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder", "id": "GoogleCloudAiplatformV1beta1VertexAISearch", "properties": { "datastore": { - "description": "Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", + "description": "Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`", "type": "string" } }, diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index 6d38cb8f57..17eee57dd1 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1706,7 +1706,7 @@ } } }, - "revision": "20240617", + "revision": "20240804", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2066,7 +2066,7 @@ "type": "object" }, "DocumentChange": { - "description": "A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. For PipelineQueryTargets, `document` will be in the new pipeline format, For a Listen stream with both QueryTargets and PipelineQueryTargets present, if a document matches both types of queries, then a separate DocumentChange messages will be sent out one for each set.", + "description": "A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.", "id": "DocumentChange", "properties": { "document": { @@ -2388,7 +2388,7 @@ "type": "object" }, "FindNearest": { - "description": "Nearest Neighbors search config.", + "description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", "id": "FindNearest", "properties": { "distanceMeasure": { @@ -2401,9 +2401,9 @@ ], "enumDescriptions": [ "Should not be set.", - "Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more", - "Compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more.", - "Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more." + "Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more. The resulting distance decreases the more similar two vectors are.", + "COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.", + "Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The resulting distance increases the more similar two vectors are." ], "type": "string" }, @@ -2499,7 +2499,7 @@ "type": "string" }, "retention": { - "description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.", + "description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.", "format": "google-duration", "type": "string" }, @@ -2630,17 +2630,23 @@ "properties": {}, "type": "object" }, - "GoogleFirestoreAdminV1DailyRecurrence": { - "description": "Represents a recurring schedule that runs every day. The time zone is UTC.", - "id": "GoogleFirestoreAdminV1DailyRecurrence", + "GoogleFirestoreAdminV1CustomerManagedEncryptionOptions": { + "description": "The configuration options for using CMEK (Customer Managed Encryption Key) encryption.", + "id": "GoogleFirestoreAdminV1CustomerManagedEncryptionOptions", "properties": { - "time": { - "$ref": "TimeOfDay", - "description": "Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise." + "kmsKeyName": { + "description": "Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", + "type": "string" } }, "type": "object" }, + "GoogleFirestoreAdminV1DailyRecurrence": { + "description": "Represents a recurring schedule that runs every day. The time zone is UTC.", + "id": "GoogleFirestoreAdminV1DailyRecurrence", + "properties": {}, + "type": "object" + }, "GoogleFirestoreAdminV1Database": { "description": "A Cloud Firestore Database.", "id": "GoogleFirestoreAdminV1Database", @@ -2787,6 +2793,25 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1EncryptionConfig": { + "description": "Encryption configuration for a new database being created from another source. The source could be a Backup or a DatabaseSnapshot.", + "id": "GoogleFirestoreAdminV1EncryptionConfig", + "properties": { + "customerManagedEncryption": { + "$ref": "GoogleFirestoreAdminV1CustomerManagedEncryptionOptions", + "description": "Use Customer Managed Encryption Keys (CMEK) for encryption." + }, + "googleDefaultEncryption": { + "$ref": "GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions", + "description": "Use Google default encryption." + }, + "useSourceEncryption": { + "$ref": "GoogleFirestoreAdminV1SourceEncryptionOptions", + "description": "The database will use the same encryption configuration as the source." + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1ExportDocumentsMetadata": { "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments.", "id": "GoogleFirestoreAdminV1ExportDocumentsMetadata", @@ -2989,6 +3014,12 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions": { + "description": "The configuration options for using Google default encryption.", + "id": "GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions", + "properties": {}, + "type": "object" + }, "GoogleFirestoreAdminV1ImportDocumentsMetadata": { "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.", "id": "GoogleFirestoreAdminV1ImportDocumentsMetadata", @@ -3461,28 +3492,26 @@ "id": "GoogleFirestoreAdminV1RestoreDatabaseRequest", "properties": { "backup": { - "description": "Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", + "description": "Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", "type": "string" }, "databaseId": { "description": "Required. The ID to use for the database, which will become the final component of the database's resource name. This database id must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. \"(default)\" database id is also valid.", "type": "string" }, - "kmsKeyName": { - "description": "Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.", - "type": "string" - }, - "useBackupEncryption": { - "$ref": "Empty", - "description": "The restored database will use the same encryption configuration as the backup. This is the default option when no `encryption_config` is specified." - }, - "useGoogleDefaultEncryption": { - "$ref": "Empty", - "description": "Use Google default encryption." + "encryptionConfig": { + "$ref": "GoogleFirestoreAdminV1EncryptionConfig", + "description": "Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption." } }, "type": "object" }, + "GoogleFirestoreAdminV1SourceEncryptionOptions": { + "description": "The configuration options for using the same encryption method as the source.", + "id": "GoogleFirestoreAdminV1SourceEncryptionOptions", + "properties": {}, + "type": "object" + }, "GoogleFirestoreAdminV1Stats": { "description": "Backup specific statistics.", "id": "GoogleFirestoreAdminV1Stats", @@ -3602,10 +3631,6 @@ "Sunday" ], "type": "string" - }, - "time": { - "$ref": "TimeOfDay", - "description": "Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise." } }, "type": "object" @@ -4341,33 +4366,6 @@ }, "type": "object" }, - "TimeOfDay": { - "description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", - "id": "TimeOfDay", - "properties": { - "hours": { - "description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", - "format": "int32", - "type": "integer" - }, - "minutes": { - "description": "Minutes of hour of day. Must be from 0 to 59.", - "format": "int32", - "type": "integer" - }, - "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", - "format": "int32", - "type": "integer" - }, - "seconds": { - "description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "TransactionOptions": { "description": "Options for creating a new transaction.", "id": "TransactionOptions", diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 2c91ea009d..393b743fa6 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -950,7 +950,7 @@ } } }, - "revision": "20240617", + "revision": "20240804", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1310,7 +1310,7 @@ "type": "object" }, "DocumentChange": { - "description": "A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. For PipelineQueryTargets, `document` will be in the new pipeline format, For a Listen stream with both QueryTargets and PipelineQueryTargets present, if a document matches both types of queries, then a separate DocumentChange messages will be sent out one for each set.", + "description": "A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.", "id": "DocumentChange", "properties": { "document": { @@ -1632,7 +1632,7 @@ "type": "object" }, "FindNearest": { - "description": "Nearest Neighbors search config.", + "description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", "id": "FindNearest", "properties": { "distanceMeasure": { @@ -1645,9 +1645,9 @@ ], "enumDescriptions": [ "Should not be set.", - "Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more", - "Compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more.", - "Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more." + "Measures the EUCLIDEAN distance between the vectors. See [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn more. The resulting distance decreases the more similar two vectors are.", + "COSINE distance compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude. We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See [Cosine Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn more about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.", + "Similar to cosine but is affected by the magnitude of the vectors. See [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more. The resulting distance increases the more similar two vectors are." ], "type": "string" }, diff --git a/discovery/games-v1.json b/discovery/games-v1.json index f608466bd3..4dded9a557 100644 --- a/discovery/games-v1.json +++ b/discovery/games-v1.json @@ -1469,7 +1469,7 @@ } } }, - "revision": "20240618", + "revision": "20240701", "rootUrl": "https://games.googleapis.com/", "schemas": { "AchievementDefinition": { @@ -2231,12 +2231,9 @@ "description": "The application that this player identifier is for.", "type": "string" }, - "token": { - "description": "Recall token data.", - "items": { - "$ref": "RecallToken" - }, - "type": "array" + "recallToken": { + "$ref": "RecallToken", + "description": "Recall token data." } }, "type": "object" @@ -3314,8 +3311,8 @@ "description": "Recall token data returned from for the RetrieveDeveloperGamesLastPlayerToken RPC", "id": "RetrieveDeveloperGamesLastPlayerTokenResponse", "properties": { - "token": { - "$ref": "RecallToken", + "gamePlayerToken": { + "$ref": "GamePlayerToken", "description": "The recall token associated with the requested PGS Player principal. It can be unset if there is no recall token associated with the requested principal." } }, @@ -3325,7 +3322,7 @@ "description": "A list of recall token data returned from the RetrieveGamesPlayerTokens RPC", "id": "RetrieveGamesPlayerTokensResponse", "properties": { - "applicationRecallTokens": { + "gamePlayerTokens": { "description": "The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response.", "items": { "$ref": "GamePlayerToken" diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index 66250d45a3..6f996cd386 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -1713,7 +1713,7 @@ } } }, - "revision": "20240518", + "revision": "20240626", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2415,7 +2415,7 @@ "id": "GroupKind", "properties": { "resourceGroup": { - "description": "Optional. API group string of a Kubernetes resource, e.g. \"apiextensions.k8s.io\", \"storage.k8s.io\", etc. Note: use empty string for core API group", + "description": "Optional. API group string of a Kubernetes resource, e.g. \"apiextensions.k8s.io\", \"storage.k8s.io\", etc. Note: use empty string for core API group.", "type": "string" }, "resourceKind": { @@ -2651,11 +2651,11 @@ "type": "object" }, "Namespaces": { - "description": "A list of Kubernetes Namespaces", + "description": "A list of Kubernetes Namespaces.", "id": "Namespaces", "properties": { "namespaces": { - "description": "Optional. A list of Kubernetes Namespaces", + "description": "Optional. A list of Kubernetes Namespaces.", "items": { "type": "string" }, @@ -2826,7 +2826,7 @@ }, "filter": { "$ref": "Filter", - "description": "Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified, and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`." + "description": "Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`." }, "labels": { "additionalProperties": { diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index b01203ef50..4cd6f6774a 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -315,6 +315,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/features/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+name}", @@ -392,6 +397,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v1/{+parent}/features", @@ -1146,6 +1156,122 @@ }, "rbacrolebindings": { "methods": { + "create": { + "description": "Creates a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", + "httpMethod": "POST", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "rbacrolebindingId": { + "description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/rbacrolebindings", + "request": { + "$ref": "RBACRoleBinding" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", + "httpMethod": "DELETE", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateMembershipRBACRoleBindingYAML": { + "description": "Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", + "httpMethod": "POST", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.generateMembershipRBACRoleBindingYAML", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "rbacrolebindingId": { + "description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", + "request": { + "$ref": "RBACRoleBinding" + }, + "response": { + "$ref": "GenerateMembershipRBACRoleBindingYAMLResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Returns the details of a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "RBACRoleBinding" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists all Membership RBACRoleBindings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", @@ -1181,6 +1307,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "patch": { + "description": "Updates a Membership RBACRoleBinding.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", + "httpMethod": "PATCH", + "id": "gkehub.projects.locations.memberships.rbacrolebindings.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The fields to be updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "RBACRoleBinding" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -1951,7 +2111,7 @@ } } }, - "revision": "20240623", + "revision": "20240809", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2433,6 +2593,44 @@ }, "type": "object" }, + "CompliancePostureConfig": { + "description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", + "id": "CompliancePostureConfig", + "properties": { + "complianceStandards": { + "description": "List of enabled compliance standards.", + "items": { + "$ref": "ComplianceStandard" + }, + "type": "array" + }, + "mode": { + "description": "Defines the enablement mode for Compliance Posture.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value not specified.", + "Disables Compliance Posture features on the cluster.", + "Enables Compliance Posture features on the cluster." + ], + "type": "string" + } + }, + "type": "object" + }, + "ComplianceStandard": { + "id": "ComplianceStandard", + "properties": { + "standard": { + "description": "Name of the compliance standard.", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementConfigSync": { "description": "Configuration for Config Sync", "id": "ConfigManagementConfigSync", @@ -2545,6 +2743,24 @@ ], "type": "string" }, + "otelCollector": { + "description": "Deployment state of otel-collector", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2563,6 +2779,24 @@ ], "type": "string" }, + "resourceGroupControllerManager": { + "description": "Deployment state of resource-group-controller-manager", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2698,7 +2932,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { - "description": "Version of the deployed admission_webhook pod", + "description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -2713,10 +2947,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, + "otelCollector": { + "description": "Version of the deployed otel-collector pod", + "type": "string" + }, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, + "resourceGroupControllerManager": { + "description": "Version of the deployed resource-group-controller-manager pod", + "type": "string" + }, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -3006,7 +3248,7 @@ }, "policyController": { "$ref": "ConfigManagementPolicyController", - "description": "Policy Controller configuration for the cluster." + "description": "Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead." }, "version": { "description": "Version of ACM installed.", @@ -3355,6 +3597,10 @@ "$ref": "BinaryAuthorizationConfig", "description": "Optional. Enable/Disable binary authorization features for the cluster." }, + "compliancePostureConfig": { + "$ref": "CompliancePostureConfig", + "description": "Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask." + }, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture features for the cluster." @@ -3478,6 +3724,14 @@ "description": "Output only. The Hub-wide Feature state.", "readOnly": true }, + "unreachable": { + "description": "Output only. List of locations that could not be reached while fetching this feature.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "updateTime": { "description": "Output only. When the Feature resource was last updated.", "format": "google-datetime", @@ -3784,6 +4038,17 @@ }, "type": "object" }, + "GenerateMembershipRBACRoleBindingYAMLResponse": { + "description": "Response for GenerateRBACRoleBindingYAML.", + "id": "GenerateMembershipRBACRoleBindingYAMLResponse", + "properties": { + "roleBindingsYaml": { + "description": "a yaml text blob including the RBAC policies.", + "type": "string" + } + }, + "type": "object" + }, "GkeCluster": { "description": "GkeCluster contains information specific to GKE clusters.", "id": "GkeCluster", @@ -6006,7 +6271,7 @@ "type": "string" }, "management": { - "description": "Enables automatic Service Mesh management.", + "description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index f5b2127bf3..6629ba47bd 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -315,6 +315,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/features/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+name}", @@ -392,6 +397,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v1alpha/{+parent}/features", @@ -2175,7 +2185,7 @@ } } }, - "revision": "20240519", + "revision": "20240809", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2807,6 +2817,44 @@ }, "type": "object" }, + "CompliancePostureConfig": { + "description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", + "id": "CompliancePostureConfig", + "properties": { + "complianceStandards": { + "description": "List of enabled compliance standards.", + "items": { + "$ref": "ComplianceStandard" + }, + "type": "array" + }, + "mode": { + "description": "Defines the enablement mode for Compliance Posture.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value not specified.", + "Disables Compliance Posture features on the cluster.", + "Enables Compliance Posture features on the cluster." + ], + "type": "string" + } + }, + "type": "object" + }, + "ComplianceStandard": { + "id": "ComplianceStandard", + "properties": { + "standard": { + "description": "Name of the compliance standard.", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementBinauthzConfig": { "description": "Configuration for Binauthz", "id": "ConfigManagementBinauthzConfig", @@ -2970,6 +3018,24 @@ ], "type": "string" }, + "otelCollector": { + "description": "Deployment state of otel-collector", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2988,6 +3054,24 @@ ], "type": "string" }, + "resourceGroupControllerManager": { + "description": "Deployment state of resource-group-controller-manager", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -3123,7 +3207,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { - "description": "Version of the deployed admission_webhook pod", + "description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -3138,10 +3222,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, + "otelCollector": { + "description": "Version of the deployed otel-collector pod", + "type": "string" + }, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, + "resourceGroupControllerManager": { + "description": "Version of the deployed resource-group-controller-manager pod", + "type": "string" + }, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -3436,7 +3528,7 @@ }, "policyController": { "$ref": "ConfigManagementPolicyController", - "description": "Policy Controller configuration for the cluster." + "description": "Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead." }, "version": { "description": "Version of ACM installed.", @@ -3789,6 +3881,10 @@ "$ref": "BinaryAuthorizationConfig", "description": "Optional. Enable/Disable binary authorization features for the cluster." }, + "compliancePostureConfig": { + "$ref": "CompliancePostureConfig", + "description": "Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask." + }, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture features for the cluster." @@ -3912,6 +4008,14 @@ "description": "Output only. The Hub-wide Feature state.", "readOnly": true }, + "unreachable": { + "description": "Output only. List of locations that could not be reached while fetching this feature.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "updateTime": { "description": "Output only. When the Feature resource was last updated.", "format": "google-datetime", @@ -6690,6 +6794,20 @@ "description": "**Service Mesh**: Spec for a single Membership for the servicemesh feature", "id": "ServiceMeshMembershipSpec", "properties": { + "configApi": { + "description": "Optional. Specifies the API that will be used for configuring the mesh workloads.", + "enum": [ + "CONFIG_API_UNSPECIFIED", + "CONFIG_API_ISTIO", + "CONFIG_API_GATEWAY" + ], + "enumDescriptions": [ + "Unspecified", + "Use the Istio API for configuration.", + "Use the K8s Gateway API for configuration." + ], + "type": "string" + }, "controlPlane": { "deprecated": true, "description": "Deprecated: use `management` instead Enables automatic control plane management.", @@ -6706,6 +6824,7 @@ "type": "string" }, "defaultChannel": { + "deprecated": true, "description": "Determines which release channel to use for default injection and service mesh APIs.", "enum": [ "CHANNEL_UNSPECIFIED", @@ -6722,7 +6841,7 @@ "type": "string" }, "management": { - "description": "Enables automatic Service Mesh management.", + "description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index c2bb2acce8..ded84a3356 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -315,6 +315,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+/features/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+name}", @@ -392,6 +397,11 @@ "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "returnPartialSuccess": { + "description": "Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable.", + "location": "query", + "type": "boolean" } }, "path": "v1beta/{+parent}/features", @@ -2101,7 +2111,7 @@ } } }, - "revision": "20240519", + "revision": "20240809", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2617,6 +2627,44 @@ }, "type": "object" }, + "CompliancePostureConfig": { + "description": "CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.", + "id": "CompliancePostureConfig", + "properties": { + "complianceStandards": { + "description": "List of enabled compliance standards.", + "items": { + "$ref": "ComplianceStandard" + }, + "type": "array" + }, + "mode": { + "description": "Defines the enablement mode for Compliance Posture.", + "enum": [ + "MODE_UNSPECIFIED", + "DISABLED", + "ENABLED" + ], + "enumDescriptions": [ + "Default value not specified.", + "Disables Compliance Posture features on the cluster.", + "Enables Compliance Posture features on the cluster." + ], + "type": "string" + } + }, + "type": "object" + }, + "ComplianceStandard": { + "id": "ComplianceStandard", + "properties": { + "standard": { + "description": "Name of the compliance standard.", + "type": "string" + } + }, + "type": "object" + }, "ConfigManagementBinauthzConfig": { "description": "Configuration for Binauthz", "id": "ConfigManagementBinauthzConfig", @@ -2780,6 +2828,24 @@ ], "type": "string" }, + "otelCollector": { + "description": "Deployment state of otel-collector", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2798,6 +2864,24 @@ ], "type": "string" }, + "resourceGroupControllerManager": { + "description": "Deployment state of resource-group-controller-manager", + "enum": [ + "DEPLOYMENT_STATE_UNSPECIFIED", + "NOT_INSTALLED", + "INSTALLED", + "ERROR", + "PENDING" + ], + "enumDescriptions": [ + "Deployment's state cannot be determined", + "Deployment is not installed", + "Deployment is installed", + "Deployment was attempted to be installed, but has errors", + "Deployment is installing or terminating" + ], + "type": "string" + }, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2933,7 +3017,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { - "description": "Version of the deployed admission_webhook pod", + "description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -2948,10 +3032,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, + "otelCollector": { + "description": "Version of the deployed otel-collector pod", + "type": "string" + }, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, + "resourceGroupControllerManager": { + "description": "Version of the deployed resource-group-controller-manager pod", + "type": "string" + }, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -3246,7 +3338,7 @@ }, "policyController": { "$ref": "ConfigManagementPolicyController", - "description": "Policy Controller configuration for the cluster." + "description": "Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead." }, "version": { "description": "Version of ACM installed.", @@ -3599,6 +3691,10 @@ "$ref": "BinaryAuthorizationConfig", "description": "Optional. Enable/Disable binary authorization features for the cluster." }, + "compliancePostureConfig": { + "$ref": "CompliancePostureConfig", + "description": "Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask." + }, "securityPostureConfig": { "$ref": "SecurityPostureConfig", "description": "Enable/Disable Security Posture features for the cluster." @@ -3722,6 +3818,14 @@ "description": "Output only. The Hub-wide Feature state.", "readOnly": true }, + "unreachable": { + "description": "Output only. List of locations that could not be reached while fetching this feature.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "updateTime": { "description": "Output only. When the Feature resource was last updated.", "format": "google-datetime", @@ -6330,7 +6434,7 @@ "type": "string" }, "management": { - "description": "Enables automatic Service Mesh management.", + "description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/discovery/gkehub-v2beta.json b/discovery/gkehub-v2beta.json new file mode 100644 index 0000000000..a587b00fb0 --- /dev/null +++ b/discovery/gkehub-v2beta.json @@ -0,0 +1,435 @@ +{ + "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://gkehub.googleapis.com/", + "batchPath": "batch", + "canonicalName": "GKE Hub", + "description": "", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", + "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": "gkehub:v2beta", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://gkehub.mtls.googleapis.com/", + "name": "gkehub", + "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": "v2beta/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "gkehub.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v2beta/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "gkehub.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": "v2beta/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "gkehub.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": "v2beta/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "gkehub.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": "v2beta/{+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": "v2beta/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "gkehub.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": "v2beta/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20240809", + "rootUrl": "https://gkehub.googleapis.com/", + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "GoogleRpcStatus": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "GoogleRpcStatus", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "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": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "GKE Hub API", + "version": "v2beta", + "version_module": true +} \ No newline at end of file diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 33c61c42c6..acb0530ef2 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -4109,6 +4109,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "rollback": { + "description": "Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:rollback", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.hl7V2Stores.rollback", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HL7v2 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7V2Stores/{hl7v2_store_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:rollback", + "request": { + "$ref": "RollbackHl7V2MessagesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:setIamPolicy", @@ -4554,7 +4583,7 @@ } } }, - "revision": "20240619", + "revision": "20240731", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5151,7 +5180,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { - "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", + "description": "Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -5678,11 +5707,11 @@ "type": "string" }, "sendFullResource": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.", "type": "boolean" }, "sendPreviousResourceOnDelete": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -5707,7 +5736,7 @@ "type": "string" }, "defaultSearchHandlingStrict": { - "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", + "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -5715,11 +5744,11 @@ "type": "boolean" }, "disableResourceVersioning": { - "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", + "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { - "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", + "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -6045,7 +6074,7 @@ "type": "string" }, "force": { - "description": "If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", + "description": "The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "schemaConfig": { @@ -6743,7 +6772,8 @@ "type": "object" }, "messageType": { - "description": "The message type for this message. MSH-9.1.", + "description": "Output only. The message type for this message. MSH-9.1.", + "readOnly": true, "type": "string" }, "name": { @@ -6757,23 +6787,27 @@ "readOnly": true }, "patientIds": { - "description": "All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", + "description": "Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", "items": { "$ref": "PatientId" }, + "readOnly": true, "type": "array" }, "schematizedData": { "$ref": "SchematizedData", - "description": "The parsed version of the raw message data schematized according to this store's schemas and type definitions." + "description": "Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions.", + "readOnly": true }, "sendFacility": { - "description": "The hospital that this message came from. MSH-4.", + "description": "Output only. The hospital that this message came from. MSH-4.", + "readOnly": true, "type": "string" }, "sendTime": { - "description": "The datetime the sending application sent this message. MSH-7.", + "description": "Output only. The datetime the sending application sent this message. MSH-7.", "format": "google-datetime", + "readOnly": true, "type": "string" } }, @@ -7183,6 +7217,82 @@ }, "type": "object" }, + "RollbackHL7MessagesFilteringFields": { + "description": "Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back.", + "id": "RollbackHL7MessagesFilteringFields", + "properties": { + "operationIds": { + "description": "Optional. A list of operation IDs to roll back.", + "items": { + "format": "uint64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RollbackHl7V2MessagesRequest": { + "description": "Point in time recovery rollback request.", + "id": "RollbackHl7V2MessagesRequest", + "properties": { + "changeType": { + "description": "Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type.", + "enum": [ + "CHANGE_TYPE_UNSPECIFIED", + "ALL", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "When unspecified, revert all transactions", + "All transactions", + "Revert only CREATE transactions", + "Revert only Update transactions", + "Revert only Delete transactions" + ], + "type": "string" + }, + "excludeRollbacks": { + "description": "Optional. Specifies whether to exclude earlier rollbacks.", + "type": "boolean" + }, + "filteringFields": { + "$ref": "RollbackHL7MessagesFilteringFields", + "description": "Optional. Parameters for filtering." + }, + "force": { + "description": "Optional. When enabled, changes will be reverted without explicit confirmation.", + "type": "boolean" + }, + "inputGcsObject": { + "description": "Optional. Cloud storage object containing list of {resourceId} lines, identifying resources to be reverted", + "type": "string" + }, + "resultGcsBucket": { + "description": "Required. Bucket to deposit result", + "type": "string" + }, + "rollbackTime": { + "description": "Required. Times point to rollback to.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RollbackHl7V2MessagesResponse": { + "description": "Final response of rollback HL7v2 messages request.", + "id": "RollbackHl7V2MessagesResponse", + "properties": { + "hl7v2Store": { + "description": "The name of the HL7 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{hl7v2_store_id}\".", + "type": "string" + } + }, + "type": "object" + }, "SchemaConfig": { "description": "Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.", "id": "SchemaConfig", @@ -7709,19 +7819,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { - "description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { - "description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", + "description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { - "description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { - "description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index 2af54bc977..2b0bba11d1 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -5174,6 +5174,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "rollback": { + "description": "Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:rollback", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.hl7V2Stores.rollback", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the HL7v2 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7V2Stores/{hl7v2_store_id}\".", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:rollback", + "request": { + "$ref": "RollbackHl7V2MessagesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:setIamPolicy", @@ -5672,7 +5701,7 @@ } } }, - "revision": "20240619", + "revision": "20240731", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5929,6 +5958,25 @@ }, "type": "object" }, + "ApplyAdminConsentsErrorDetail": { + "description": "Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources.", + "id": "ApplyAdminConsentsErrorDetail", + "properties": { + "consentErrors": { + "description": "The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them.", + "items": { + "$ref": "ConsentErrors" + }, + "type": "array" + }, + "existingOperationId": { + "description": "The currently in progress non-validate-only ApplyAdminConsents operation ID if exist.", + "format": "uint64", + "type": "string" + } + }, + "type": "object" + }, "ApplyAdminConsentsRequest": { "description": "Request to apply the admin Consent resources for the specified FHIR store.", "id": "ApplyAdminConsentsRequest", @@ -6522,7 +6570,7 @@ "description": "Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used." }, "accessEnforced": { - "description": "Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.", + "description": "Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.", "type": "boolean" }, "consentHeaderHandling": { @@ -6551,6 +6599,21 @@ }, "type": "object" }, + "ConsentErrors": { + "description": "The Consent resource name and error.", + "id": "ConsentErrors", + "properties": { + "error": { + "$ref": "Status", + "description": "The error code and message." + }, + "name": { + "description": "The versioned name of the admin Consent resource, in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`.", + "type": "string" + } + }, + "type": "object" + }, "ConsentEvaluation": { "description": "The detailed evaluation of a particular Consent.", "id": "ConsentEvaluation", @@ -6773,7 +6836,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { - "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", + "description": "Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -7610,11 +7673,11 @@ "type": "string" }, "sendFullResource": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", "type": "boolean" }, "sendPreviousResourceOnDelete": { - "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", + "description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -7654,7 +7717,7 @@ "description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources." }, "defaultSearchHandlingStrict": { - "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", + "description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -7662,15 +7725,15 @@ "type": "boolean" }, "disableResourceVersioning": { - "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", + "description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableHistoryModifications": { - "description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error.", + "description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { - "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", + "description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -9573,6 +9636,82 @@ }, "type": "object" }, + "RollbackHL7MessagesFilteringFields": { + "description": "Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back.", + "id": "RollbackHL7MessagesFilteringFields", + "properties": { + "operationIds": { + "description": "Optional. A list of operation IDs to roll back.", + "items": { + "format": "uint64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RollbackHl7V2MessagesRequest": { + "description": "Point in time recovery rollback request.", + "id": "RollbackHl7V2MessagesRequest", + "properties": { + "changeType": { + "description": "Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type.", + "enum": [ + "CHANGE_TYPE_UNSPECIFIED", + "ALL", + "CREATE", + "UPDATE", + "DELETE" + ], + "enumDescriptions": [ + "When unspecified, revert all transactions", + "All transactions", + "Revert only CREATE transactions", + "Revert only Update transactions", + "Revert only Delete transactions" + ], + "type": "string" + }, + "excludeRollbacks": { + "description": "Optional. Specifies whether to exclude earlier rollbacks.", + "type": "boolean" + }, + "filteringFields": { + "$ref": "RollbackHL7MessagesFilteringFields", + "description": "Optional. Parameters for filtering." + }, + "force": { + "description": "Optional. When enabled, changes will be reverted without explicit confirmation.", + "type": "boolean" + }, + "inputGcsObject": { + "description": "Optional. Cloud storage object containing list of {resourceId} lines, identifying resources to be reverted", + "type": "string" + }, + "resultGcsBucket": { + "description": "Required. Bucket to deposit result", + "type": "string" + }, + "rollbackTime": { + "description": "Required. Times point to rollback to.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "RollbackHl7V2MessagesResponse": { + "description": "Final response of rollback FHIR resources request.", + "id": "RollbackHl7V2MessagesResponse", + "properties": { + "hl7v2Store": { + "description": "The name of the HL7 store to rollback, in the format of \"projects/{project_id}/locations/{location_id}/datasets/{dataset_id} /hl7v2Stores/{fhir_store_id}\".", + "type": "string" + } + }, + "type": "object" + }, "SchemaConfig": { "description": "Configuration for the FHIR BigQuery schema. Determines how the server generates the schema.", "id": "SchemaConfig", @@ -10227,19 +10366,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { - "description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { - "description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", + "description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { - "description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { - "description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", + "description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/discovery/iam-v1.json b/discovery/iam-v1.json index d8bcb47d5f..322707bf2a 100644 --- a/discovery/iam-v1.json +++ b/discovery/iam-v1.json @@ -988,7 +988,7 @@ ] }, "delete": { - "description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.", + "description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](https://cloud.google.com/iam/help/limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.", "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", "httpMethod": "DELETE", "id": "iam.organizations.roles.delete", @@ -2288,7 +2288,7 @@ ] }, "delete": { - "description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.", + "description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](https://cloud.google.com/iam/help/limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.", "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", "httpMethod": "DELETE", "id": "iam.projects.roles.delete", @@ -3056,34 +3056,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Patches a ServiceAccountKey.", - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:patch", - "httpMethod": "POST", - "id": "iam.projects.serviceAccounts.keys.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.", - "location": "path", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:patch", - "request": { - "$ref": "PatchServiceAccountKeyRequest" - }, - "response": { - "$ref": "ServiceAccountKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "upload": { "description": "Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload", @@ -3216,7 +3188,7 @@ } } }, - "revision": "20240621", + "revision": "20240725", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4271,22 +4243,6 @@ }, "type": "object" }, - "PatchServiceAccountKeyRequest": { - "description": "The service account key patch request.", - "id": "PatchServiceAccountKeyRequest", - "properties": { - "serviceAccountKey": { - "$ref": "ServiceAccountKey", - "description": "Required. The service account key to update." - }, - "updateMask": { - "description": "Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description", - "format": "google-fieldmask", - "type": "string" - } - }, - "type": "object" - }, "PatchServiceAccountRequest": { "description": "The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.", "id": "PatchServiceAccountRequest", @@ -4462,7 +4418,7 @@ "type": "string" }, "pageSize": { - "description": "Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.", + "description": "Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 2,000.", "format": "int32", "type": "integer" }, @@ -4691,19 +4647,6 @@ "description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.", "id": "ServiceAccountKey", "properties": { - "contact": { - "description": "Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.", - "type": "string" - }, - "creator": { - "description": "Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.", - "readOnly": true, - "type": "string" - }, - "description": { - "description": "Optional. A user provided description of this service account key.", - "type": "string" - }, "disableReason": { "description": "Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.", "enum": [ diff --git a/discovery/index.json b/discovery/index.json index 1e9be76212..190031688c 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -1,6851 +1,6896 @@ { - "kind": "discovery#directoryList", "discoveryVersion": "v1", "items": [ { - "kind": "discovery#directoryItem", - "id": "abusiveexperiencereport:v1", - "name": "abusiveexperiencereport", - "version": "v1", - "title": "Abusive Experience Report API", "description": "Views Abusive Experience Report data, and gets a list of sites that have a significant number of abusive experiences.", "discoveryRestUrl": "https://abusiveexperiencereport.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/abusive-experience-report/", "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://developers.google.com/abusive-experience-report/", - "preferred": true + "id": "abusiveexperiencereport:v1", + "kind": "discovery#directoryItem", + "name": "abusiveexperiencereport", + "preferred": true, + "title": "Abusive Experience Report API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "acceleratedmobilepageurl:v1", - "name": "acceleratedmobilepageurl", - "version": "v1", - "title": "Accelerated Mobile Pages (AMP) URL API", "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).", "discoveryRestUrl": "https://acceleratedmobilepageurl.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/amp/cache/", "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://developers.google.com/amp/cache/", - "preferred": true + "id": "acceleratedmobilepageurl:v1", + "kind": "discovery#directoryItem", + "name": "acceleratedmobilepageurl", + "preferred": true, + "title": "Accelerated Mobile Pages (AMP) URL API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "accessapproval:v1", - "name": "accessapproval", - "version": "v1", - "title": "Access Approval API", "description": "An API for controlling access to data by Google personnel.", "discoveryRestUrl": "https://accessapproval.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/assured-workloads/access-approval/docs", "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/assured-workloads/access-approval/docs", - "preferred": true + "id": "accessapproval:v1", + "kind": "discovery#directoryItem", + "name": "accessapproval", + "preferred": true, + "title": "Access Approval API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "accesscontextmanager:v1", - "name": "accesscontextmanager", - "version": "v1", - "title": "Access Context Manager API", "description": "An API for setting attribute based access control to requests to Google Cloud services. *Warning:* Do not mix *v1alpha* and *v1* API usage in the same access policy. The v1alpha API supports new Access Context Manager features, which may have different attributes or behaviors that are not supported by v1. The practice of mixed API usage within a policy may result in the inability to update that policy, including any access levels or service perimeters belonging to it. It is not recommended to use both v1 and v1alpha for modifying policies with critical service perimeters. Modifications using v1alpha should be limited to policies with non-production/non-critical service perimeters.", "discoveryRestUrl": "https://accesscontextmanager.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/access-context-manager/docs/reference/rest/", - "preferred": true - }, - { - "kind": "discovery#directoryItem", - "id": "acmedns:v1", - "name": "acmedns", - "version": "v1", - "title": "ACME DNS API", - "description": "Google Domains ACME DNS API that allows users to complete ACME DNS-01 challenges for a domain.", - "discoveryRestUrl": "https://acmedns.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://developers.google.com/domains/acme-dns/", - "preferred": true + "id": "accesscontextmanager:v1", + "kind": "discovery#directoryItem", + "name": "accesscontextmanager", + "preferred": true, + "title": "Access Context Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "addressvalidation:v1", - "name": "addressvalidation", - "version": "v1", - "title": "Address Validation API", "description": "The Address Validation API allows developers to verify the accuracy of addresses. Given an address, it returns information about the correctness of the components of the parsed address, a geocode, and a verdict on the deliverability of the parsed address.", "discoveryRestUrl": "https://addressvalidation.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/addressvalidation", "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://developers.google.com/maps/documentation/addressvalidation", - "preferred": true + "id": "addressvalidation:v1", + "kind": "discovery#directoryItem", + "name": "addressvalidation", + "preferred": true, + "title": "Address Validation API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "adexchangebuyer2:v2beta1", - "name": "adexchangebuyer2", - "version": "v2beta1", - "title": "Ad Exchange Buyer API II", "description": "Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.", "discoveryRestUrl": "https://adexchangebuyer.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/reference/rest/", "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://developers.google.com/authorized-buyers/apis/reference/rest/", - "preferred": true + "id": "adexchangebuyer2:v2beta1", + "kind": "discovery#directoryItem", + "name": "adexchangebuyer2", + "preferred": true, + "title": "Ad Exchange Buyer API II", + "version": "v2beta1" }, { - "kind": "discovery#directoryItem", - "id": "adexperiencereport:v1", - "name": "adexperiencereport", - "version": "v1", - "title": "Ad Experience Report API", "description": "Views Ad Experience Report data, and gets a list of sites that have a significant number of annoying ads.", "discoveryRestUrl": "https://adexperiencereport.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/ad-experience-report/", "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://developers.google.com/ad-experience-report/", - "preferred": true + "id": "adexperiencereport:v1", + "kind": "discovery#directoryItem", + "name": "adexperiencereport", + "preferred": true, + "title": "Ad Experience Report API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "admin:datatransfer_v1", - "name": "admin", - "version": "datatransfer_v1", - "title": "Admin SDK API", "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=datatransfer_v1", + "documentationLink": "https://developers.google.com/admin-sdk/", "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://developers.google.com/admin-sdk/", - "preferred": false - }, - { + "id": "admin:datatransfer_v1", "kind": "discovery#directoryItem", - "id": "admin:directory_v1", "name": "admin", - "version": "directory_v1", + "preferred": false, "title": "Admin SDK API", + "version": "datatransfer_v1" + }, + { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=directory_v1", + "documentationLink": "https://developers.google.com/admin-sdk/", "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://developers.google.com/admin-sdk/", - "preferred": false - }, - { + "id": "admin:directory_v1", "kind": "discovery#directoryItem", - "id": "admin:reports_v1", "name": "admin", - "version": "reports_v1", + "preferred": false, "title": "Admin SDK API", + "version": "directory_v1" + }, + { "description": "Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.", "discoveryRestUrl": "https://admin.googleapis.com/$discovery/rest?version=reports_v1", + "documentationLink": "https://developers.google.com/admin-sdk/", "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://developers.google.com/admin-sdk/", - "preferred": true + "id": "admin:reports_v1", + "kind": "discovery#directoryItem", + "name": "admin", + "preferred": true, + "title": "Admin SDK API", + "version": "reports_v1" }, { - "kind": "discovery#directoryItem", - "id": "admob:v1beta", - "name": "admob", - "version": "v1beta", - "title": "AdMob API", "description": "The AdMob API allows publishers to programmatically get information about their AdMob account.", "discoveryRestUrl": "https://admob.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://developers.google.com/admob/api/", "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://developers.google.com/admob/api/", - "preferred": false - }, - { + "id": "admob:v1beta", "kind": "discovery#directoryItem", - "id": "admob:v1", "name": "admob", - "version": "v1", + "preferred": false, "title": "AdMob API", + "version": "v1beta" + }, + { "description": "The AdMob API allows publishers to programmatically get information about their AdMob account.", "discoveryRestUrl": "https://admob.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/admob/api/", "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://developers.google.com/admob/api/", - "preferred": true + "id": "admob:v1", + "kind": "discovery#directoryItem", + "name": "admob", + "preferred": true, + "title": "AdMob API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "adsense:v2", - "name": "adsense", - "version": "v2", - "title": "AdSense Management API", "description": "The AdSense Management API allows publishers to access their inventory and run earnings and performance reports.", "discoveryRestUrl": "https://adsense.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/adsense/management/", "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://developers.google.com/adsense/management/", - "preferred": true + "id": "adsense:v2", + "kind": "discovery#directoryItem", + "name": "adsense", + "preferred": true, + "title": "AdSense Management API", + "version": "v2" }, { - "kind": "discovery#directoryItem", + "description": "The AdSense Host API gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.", + "discoveryRestUrl": "https://adsensehost.googleapis.com/$discovery/rest?version=v4.1", + "documentationLink": "https://developers.google.com/adsense/host/index", + "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" + }, "id": "adsensehost:v4.1", + "kind": "discovery#directoryItem", "name": "adsensehost", - "version": "v4.1", + "preferred": true, "title": "AdSense Host API", - "description": "The AdSense Host API gives AdSense Hosts access to report generation, ad code generation, and publisher management capabilities.", - "discoveryRestUrl": "https://adsensehost.googleapis.com/$discovery/rest?version=v4.1", + "version": "v4.1" + }, + { + "description": "", + "discoveryRestUrl": "https://adsenseplatform.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/adsense/platforms/", "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://developers.google.com/adsense/host/index", - "preferred": true + "id": "adsenseplatform:v1alpha", + "kind": "discovery#directoryItem", + "name": "adsenseplatform", + "preferred": false, + "title": "AdSense Platform API", + "version": "v1alpha" }, { + "description": "", + "discoveryRestUrl": "https://adsenseplatform.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/adsense/platforms/", + "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" + }, + "id": "adsenseplatform:v1", "kind": "discovery#directoryItem", - "id": "advisorynotifications:v1", - "name": "advisorynotifications", - "version": "v1", - "title": "Advisory Notifications API", + "name": "adsenseplatform", + "preferred": true, + "title": "AdSense Platform API", + "version": "v1" + }, + { "description": "An API for accessing Advisory Notifications in Google Cloud", "discoveryRestUrl": "https://advisorynotifications.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/advisory-notifications", "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/advisory-notifications", - "preferred": true + "id": "advisorynotifications:v1", + "kind": "discovery#directoryItem", + "name": "advisorynotifications", + "preferred": true, + "title": "Advisory Notifications API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "aiplatform:v1beta1", - "name": "aiplatform", - "version": "v1beta1", - "title": "Vertex AI API", "description": "Train high-quality custom machine learning models with minimal machine learning expertise and effort.", "discoveryRestUrl": "https://aiplatform.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/vertex-ai/", "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/vertex-ai/", - "preferred": false - }, - { + "id": "aiplatform:v1beta1", "kind": "discovery#directoryItem", - "id": "aiplatform:v1", "name": "aiplatform", - "version": "v1", + "preferred": false, "title": "Vertex AI API", + "version": "v1beta1" + }, + { "description": "Train high-quality custom machine learning models with minimal machine learning expertise and effort.", "discoveryRestUrl": "https://aiplatform.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/vertex-ai/", "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/vertex-ai/", - "preferred": true + "id": "aiplatform:v1", + "kind": "discovery#directoryItem", + "name": "aiplatform", + "preferred": true, + "title": "Vertex AI API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "airquality:v1", - "name": "airquality", - "version": "v1", - "title": "Air Quality API", "description": "The Air Quality API.", "discoveryRestUrl": "https://airquality.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/air-quality", "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://developers.google.com/maps/documentation/air-quality", - "preferred": true + "id": "airquality:v1", + "kind": "discovery#directoryItem", + "name": "airquality", + "preferred": true, + "title": "Air Quality API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "alertcenter:v1beta1", - "name": "alertcenter", - "version": "v1beta1", - "title": "Google Workspace Alert Center API", "description": "Manages alerts on issues affecting your domain. Note: The current version of this API (v1beta1) is available to all Google Workspace customers.", "discoveryRestUrl": "https://alertcenter.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://developers.google.com/admin-sdk/alertcenter/", "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://developers.google.com/admin-sdk/alertcenter/", - "preferred": true + "id": "alertcenter:v1beta1", + "kind": "discovery#directoryItem", + "name": "alertcenter", + "preferred": true, + "title": "Google Workspace Alert Center API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "alloydb:v1alpha", - "name": "alloydb", - "version": "v1alpha", - "title": "AlloyDB API", "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.", "discoveryRestUrl": "https://alloydb.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/alloydb/", "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/alloydb/", - "preferred": false - }, - { + "id": "alloydb:v1alpha", "kind": "discovery#directoryItem", - "id": "alloydb:v1beta", "name": "alloydb", - "version": "v1beta", + "preferred": false, "title": "AlloyDB API", + "version": "v1alpha" + }, + { "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.", "discoveryRestUrl": "https://alloydb.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/alloydb/", "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/alloydb/", - "preferred": false - }, - { + "id": "alloydb:v1beta", "kind": "discovery#directoryItem", - "id": "alloydb:v1", "name": "alloydb", - "version": "v1", + "preferred": false, "title": "AlloyDB API", + "version": "v1beta" + }, + { "description": "AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance. AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.", "discoveryRestUrl": "https://alloydb.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/alloydb/", "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/alloydb/", - "preferred": true + "id": "alloydb:v1", + "kind": "discovery#directoryItem", + "name": "alloydb", + "preferred": true, + "title": "AlloyDB API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "analytics:v3", - "name": "analytics", - "version": "v3", - "title": "Google Analytics API", "description": "The Analytics API provides access to Analytics configuration and report data.", "discoveryRestUrl": "https://analytics.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "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": "http://code.google.com/apis/analytics/docs/mgmt/home.html", - "preferred": true + "id": "analytics:v3", + "kind": "discovery#directoryItem", + "name": "analytics", + "preferred": true, + "title": "Google Analytics API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "analyticsadmin:v1alpha", - "name": "analyticsadmin", - "version": "v1alpha", - "title": "Google Analytics Admin API", "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryRestUrl": "https://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "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": "http://code.google.com/apis/analytics/docs/mgmt/home.html", - "preferred": false - }, - { + "id": "analyticsadmin:v1alpha", "kind": "discovery#directoryItem", - "id": "analyticsadmin:v1beta", "name": "analyticsadmin", - "version": "v1beta", + "preferred": false, "title": "Google Analytics Admin API", + "version": "v1alpha" + }, + { "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryRestUrl": "https://analyticsadmin.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "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": "http://code.google.com/apis/analytics/docs/mgmt/home.html", - "preferred": true + "id": "analyticsadmin:v1beta", + "kind": "discovery#directoryItem", + "name": "analyticsadmin", + "preferred": true, + "title": "Google Analytics Admin API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "analyticsdata:v1beta", - "name": "analyticsdata", - "version": "v1beta", - "title": "Google Analytics Data API", "description": "Accesses report data in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "discoveryRestUrl": "https://analyticsdata.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://developers.google.com/analytics/devguides/reporting/data/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://developers.google.com/analytics/devguides/reporting/data/v1/", - "preferred": true + "id": "analyticsdata:v1beta", + "kind": "discovery#directoryItem", + "name": "analyticsdata", + "preferred": true, + "title": "Google Analytics Data API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "analyticshub:v1beta1", - "name": "analyticshub", - "version": "v1beta1", - "title": "Analytics Hub API", "description": "Exchange data and analytics assets securely and efficiently.", "discoveryRestUrl": "https://analyticshub.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", "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/bigquery/docs/analytics-hub-introduction", - "preferred": false - }, - { + "id": "analyticshub:v1beta1", "kind": "discovery#directoryItem", - "id": "analyticshub:v1", "name": "analyticshub", - "version": "v1", + "preferred": false, "title": "Analytics Hub API", + "version": "v1beta1" + }, + { "description": "Exchange data and analytics assets securely and efficiently.", "discoveryRestUrl": "https://analyticshub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/analytics-hub-introduction", "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/bigquery/docs/analytics-hub-introduction", - "preferred": true + "id": "analyticshub:v1", + "kind": "discovery#directoryItem", + "name": "analyticshub", + "preferred": true, + "title": "Analytics Hub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "analyticsreporting:v4", - "name": "analyticsreporting", - "version": "v4", - "title": "Analytics Reporting API", "description": "Accesses Analytics report data.", "discoveryRestUrl": "https://analyticsreporting.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/", "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://developers.google.com/analytics/devguides/reporting/core/v4/", - "preferred": true + "id": "analyticsreporting:v4", + "kind": "discovery#directoryItem", + "name": "analyticsreporting", + "preferred": true, + "title": "Analytics Reporting API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "androiddeviceprovisioning:v1", - "name": "androiddeviceprovisioning", - "version": "v1", - "title": "Android Device Provisioning Partner API", "description": "Automates Android zero-touch enrollment for device resellers, customers, and EMMs.", "discoveryRestUrl": "https://androiddeviceprovisioning.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/zero-touch/", "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://developers.google.com/zero-touch/", - "preferred": true + "id": "androiddeviceprovisioning:v1", + "kind": "discovery#directoryItem", + "name": "androiddeviceprovisioning", + "preferred": true, + "title": "Android Device Provisioning Partner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "androidenterprise:v1", - "name": "androidenterprise", - "version": "v1", - "title": "Google Play EMM API", "description": "Manages the deployment of apps to Android Enterprise devices.", "discoveryRestUrl": "https://androidenterprise.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" }, - "preferred": true + "id": "androidenterprise:v1", + "kind": "discovery#directoryItem", + "name": "androidenterprise", + "preferred": true, + "title": "Google Play EMM API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "androidmanagement:v1", - "name": "androidmanagement", - "version": "v1", - "title": "Android Management API", "description": "The Android Management API provides remote enterprise management of Android devices and apps.", "discoveryRestUrl": "https://androidmanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/android/management", "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://developers.google.com/android/management", - "preferred": true + "id": "androidmanagement:v1", + "kind": "discovery#directoryItem", + "name": "androidmanagement", + "preferred": true, + "title": "Android Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "androidpublisher:v3", - "name": "androidpublisher", - "version": "v3", - "title": "Google Play Android Developer API", "description": "Lets Android application developers access their Google Play accounts. At a high level, the expected workflow is to \"insert\" an Edit, make changes as necessary, and then \"commit\" it.", "discoveryRestUrl": "https://androidpublisher.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/android-publisher", "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://developers.google.com/android-publisher", - "preferred": true + "id": "androidpublisher:v3", + "kind": "discovery#directoryItem", + "name": "androidpublisher", + "preferred": true, + "title": "Google Play Android Developer API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "apigateway:v1beta", - "name": "apigateway", - "version": "v1beta", - "title": "API Gateway API", "description": "", "discoveryRestUrl": "https://apigateway.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/api-gateway/docs", "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/api-gateway/docs", - "preferred": false - }, - { + "id": "apigateway:v1beta", "kind": "discovery#directoryItem", - "id": "apigateway:v1", "name": "apigateway", - "version": "v1", + "preferred": false, "title": "API Gateway API", + "version": "v1beta" + }, + { "description": "", "discoveryRestUrl": "https://apigateway.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/api-gateway/docs", "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/api-gateway/docs", - "preferred": true + "id": "apigateway:v1", + "kind": "discovery#directoryItem", + "name": "apigateway", + "preferred": true, + "title": "API Gateway API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apigee:v1", - "name": "apigee", - "version": "v1", - "title": "Apigee API", "description": "Use the Apigee API to programmatically develop and manage APIs with a set of RESTful operations. Develop and secure API proxies, deploy and undeploy API proxy revisions, monitor APIs, configure environments, manage users, and more. Note: This product is available as a free trial for a time period of 60 days.", "discoveryRestUrl": "https://apigee.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee-api-management/", "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/apigee-api-management/", - "preferred": true + "id": "apigee:v1", + "kind": "discovery#directoryItem", + "name": "apigee", + "preferred": true, + "title": "Apigee API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apigeeregistry:v1", - "name": "apigeeregistry", - "version": "v1", - "title": "Apigee Registry API", "description": "", "discoveryRestUrl": "https://apigeeregistry.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee/docs/api-hub/what-is-api-hub", "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/apigee/docs/api-hub/what-is-api-hub", - "preferred": true + "id": "apigeeregistry:v1", + "kind": "discovery#directoryItem", + "name": "apigeeregistry", + "preferred": true, + "title": "Apigee Registry API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apikeys:v2", - "name": "apikeys", - "version": "v2", - "title": "API Keys API", "description": "Manages the API keys associated with developer projects.", "discoveryRestUrl": "https://apikeys.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/api-keys/docs", "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/api-keys/docs", - "preferred": true + "id": "apikeys:v2", + "kind": "discovery#directoryItem", + "name": "apikeys", + "preferred": true, + "title": "API Keys API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "apim:v1alpha", - "name": "apim", - "version": "v1alpha", - "title": "API Management API", "description": "Enables users to discover shadow APIs in existing Google Cloud infrastructure.", "discoveryRestUrl": "https://apim.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/apigee/", "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/apigee/", - "preferred": true + "id": "apim:v1alpha", + "kind": "discovery#directoryItem", + "name": "apim", + "preferred": true, + "title": "API Management API", + "version": "v1alpha" }, { - "kind": "discovery#directoryItem", - "id": "appengine:v1alpha", - "name": "appengine", - "version": "v1alpha", - "title": "App Engine Admin API", "description": "Provisions and manages developers' App Engine applications.", "discoveryRestUrl": "https://appengine.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "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/appengine/docs/admin-api/", - "preferred": false - }, - { + "id": "appengine:v1alpha", "kind": "discovery#directoryItem", - "id": "appengine:v1beta", "name": "appengine", - "version": "v1beta", + "preferred": false, "title": "App Engine Admin API", + "version": "v1alpha" + }, + { "description": "Provisions and manages developers' App Engine applications.", "discoveryRestUrl": "https://appengine.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "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/appengine/docs/admin-api/", - "preferred": false - }, - { + "id": "appengine:v1beta", "kind": "discovery#directoryItem", - "id": "appengine:v1", "name": "appengine", - "version": "v1", + "preferred": false, "title": "App Engine Admin API", + "version": "v1beta" + }, + { "description": "Provisions and manages developers' App Engine applications.", "discoveryRestUrl": "https://appengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "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/appengine/docs/admin-api/", - "preferred": true + "id": "appengine:v1", + "kind": "discovery#directoryItem", + "name": "appengine", + "preferred": true, + "title": "App Engine Admin API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "apphub:v1alpha", - "name": "apphub", - "version": "v1alpha", - "title": "App Hub API", "description": "", "discoveryRestUrl": "https://apphub.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/app-hub/docs/", "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/app-hub/docs/", - "preferred": false - }, - { + "id": "apphub:v1alpha", "kind": "discovery#directoryItem", - "id": "apphub:v1", "name": "apphub", - "version": "v1", + "preferred": false, "title": "App Hub API", + "version": "v1alpha" + }, + { "description": "", "discoveryRestUrl": "https://apphub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/app-hub/docs/", "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/app-hub/docs/", - "preferred": true + "id": "apphub:v1", + "kind": "discovery#directoryItem", + "name": "apphub", + "preferred": true, + "title": "App Hub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "area120tables:v1alpha1", - "name": "area120tables", - "version": "v1alpha1", - "title": "Area120 Tables API", "description": "", "discoveryRestUrl": "https://area120tables.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://support.google.com/area120-tables/answer/10011390", "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://support.google.com/area120-tables/answer/10011390", - "preferred": true + "id": "area120tables:v1alpha1", + "kind": "discovery#directoryItem", + "name": "area120tables", + "preferred": true, + "title": "Area120 Tables API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "artifactregistry:v1beta1", - "name": "artifactregistry", - "version": "v1beta1", - "title": "Artifact Registry API", "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", "discoveryRestUrl": "https://artifactregistry.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/artifacts/docs/", "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/artifacts/docs/", - "preferred": false - }, - { + "id": "artifactregistry:v1beta1", "kind": "discovery#directoryItem", - "id": "artifactregistry:v1beta2", "name": "artifactregistry", - "version": "v1beta2", + "preferred": false, "title": "Artifact Registry API", + "version": "v1beta1" + }, + { "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", "discoveryRestUrl": "https://artifactregistry.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/artifacts/docs/", "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/artifacts/docs/", - "preferred": false - }, - { + "id": "artifactregistry:v1beta2", "kind": "discovery#directoryItem", - "id": "artifactregistry:v1", "name": "artifactregistry", - "version": "v1", + "preferred": false, "title": "Artifact Registry API", + "version": "v1beta2" + }, + { "description": "Store and manage build artifacts in a scalable and integrated service built on Google infrastructure.", "discoveryRestUrl": "https://artifactregistry.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/artifacts/docs/", "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/artifacts/docs/", - "preferred": true + "id": "artifactregistry:v1", + "kind": "discovery#directoryItem", + "name": "artifactregistry", + "preferred": true, + "title": "Artifact Registry API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "assuredworkloads:v1beta1", - "name": "assuredworkloads", - "version": "v1beta1", - "title": "Assured Workloads API", "description": "", "discoveryRestUrl": "https://assuredworkloads.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/learnmoreurl", "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/learnmoreurl", - "preferred": false - }, - { + "id": "assuredworkloads:v1beta1", "kind": "discovery#directoryItem", - "id": "assuredworkloads:v1", "name": "assuredworkloads", - "version": "v1", + "preferred": false, "title": "Assured Workloads API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://assuredworkloads.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/learnmoreurl", "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/learnmoreurl", - "preferred": true + "id": "assuredworkloads:v1", + "kind": "discovery#directoryItem", + "name": "assuredworkloads", + "preferred": true, + "title": "Assured Workloads API", + "version": "v1" }, { + "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", + "discoveryRestUrl": "https://authorizedbuyersmarketplace.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", + "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" + }, + "id": "authorizedbuyersmarketplace:v1alpha", "kind": "discovery#directoryItem", - "id": "authorizedbuyersmarketplace:v1", "name": "authorizedbuyersmarketplace", - "version": "v1", + "preferred": false, "title": "Authorized Buyers Marketplace API", + "version": "v1alpha" + }, + { "description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", "discoveryRestUrl": "https://authorizedbuyersmarketplace.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", "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://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", - "preferred": true + "id": "authorizedbuyersmarketplace:v1", + "kind": "discovery#directoryItem", + "name": "authorizedbuyersmarketplace", + "preferred": true, + "title": "Authorized Buyers Marketplace API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "backupdr:v1", - "name": "backupdr", - "version": "v1", - "title": "Backup and DR Service API", "description": "", "discoveryRestUrl": "https://backupdr.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/backup-disaster-recovery", "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/backup-disaster-recovery", - "preferred": true + "id": "backupdr:v1", + "kind": "discovery#directoryItem", + "name": "backupdr", + "preferred": true, + "title": "Backup and DR Service API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "baremetalsolution:v2", - "name": "baremetalsolution", - "version": "v2", - "title": "Bare Metal Solution API", "description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.", "discoveryRestUrl": "https://baremetalsolution.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/bare-metal", "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/bare-metal", - "preferred": true + "id": "baremetalsolution:v2", + "kind": "discovery#directoryItem", + "name": "baremetalsolution", + "preferred": true, + "title": "Bare Metal Solution API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "batch:v1", - "name": "batch", - "version": "v1", - "title": "Batch API", "description": "An API to manage the running of Batch resources on Google Cloud Platform.", "discoveryRestUrl": "https://batch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/batch/", "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/batch/", - "preferred": true + "id": "batch:v1", + "kind": "discovery#directoryItem", + "name": "batch", + "preferred": true, + "title": "Batch API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "beyondcorp:v1alpha", - "name": "beyondcorp", - "version": "v1alpha", - "title": "BeyondCorp API", "description": "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.", "discoveryRestUrl": "https://beyondcorp.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": false - }, - { + "id": "beyondcorp:v1alpha", "kind": "discovery#directoryItem", - "id": "beyondcorp:v1", "name": "beyondcorp", - "version": "v1", + "preferred": false, "title": "BeyondCorp API", + "version": "v1alpha" + }, + { "description": "Beyondcorp Enterprise provides identity and context aware access controls for enterprise resources and enables zero-trust access. Using the Beyondcorp Enterprise APIs, enterprises can set up multi-cloud and on-prem connectivity solutions.", "discoveryRestUrl": "https://beyondcorp.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": true + "id": "beyondcorp:v1", + "kind": "discovery#directoryItem", + "name": "beyondcorp", + "preferred": true, + "title": "BeyondCorp API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "biglake:v1", - "name": "biglake", - "version": "v1", - "title": "BigLake API", "description": "The BigLake API provides access to BigLake Metastore, a serverless, fully managed, and highly available metastore for open-source data that can be used for querying Apache Iceberg tables in BigQuery.", "discoveryRestUrl": "https://biglake.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/", "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/bigquery/", - "preferred": true + "id": "biglake:v1", + "kind": "discovery#directoryItem", + "name": "biglake", + "preferred": true, + "title": "BigLake API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigquery:v2", - "name": "bigquery", - "version": "v2", - "title": "BigQuery API", "description": "A data platform for customers to create, manage, share and query data.", "discoveryRestUrl": "https://bigquery.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/bigquery/", "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/bigquery/", - "preferred": true + "id": "bigquery:v2", + "kind": "discovery#directoryItem", + "name": "bigquery", + "preferred": true, + "title": "BigQuery API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "bigqueryconnection:v1beta1", - "name": "bigqueryconnection", - "version": "v1beta1", - "title": "BigQuery Connection API", "description": "Allows users to manage BigQuery connections to external data sources.", "discoveryRestUrl": "https://bigqueryconnection.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/bigquery/docs/connections-api-intro", "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/bigquery/docs/connections-api-intro", - "preferred": false - }, - { + "id": "bigqueryconnection:v1beta1", "kind": "discovery#directoryItem", - "id": "bigqueryconnection:v1", "name": "bigqueryconnection", - "version": "v1", + "preferred": false, "title": "BigQuery Connection API", + "version": "v1beta1" + }, + { "description": "Allows users to manage BigQuery connections to external data sources.", "discoveryRestUrl": "https://bigqueryconnection.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/connections-api-intro", "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/bigquery/docs/connections-api-intro", - "preferred": true + "id": "bigqueryconnection:v1", + "kind": "discovery#directoryItem", + "name": "bigqueryconnection", + "preferred": true, + "title": "BigQuery Connection API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigquerydatapolicy:v1", - "name": "bigquerydatapolicy", - "version": "v1", - "title": "BigQuery Data Policy API", "description": "Allows users to manage BigQuery data policies.", "discoveryRestUrl": "https://bigquerydatapolicy.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/docs/column-data-masking", "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/bigquery/docs/column-data-masking", - "preferred": true + "id": "bigquerydatapolicy:v1", + "kind": "discovery#directoryItem", + "name": "bigquerydatapolicy", + "preferred": true, + "title": "BigQuery Data Policy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigquerydatatransfer:v1", - "name": "bigquerydatatransfer", - "version": "v1", - "title": "BigQuery Data Transfer API", "description": "Schedule queries or transfer external data from SaaS applications to Google BigQuery on a regular basis.", "discoveryRestUrl": "https://bigquerydatatransfer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery-transfer/", "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/bigquery-transfer/", - "preferred": true + "id": "bigquerydatatransfer:v1", + "kind": "discovery#directoryItem", + "name": "bigquerydatatransfer", + "preferred": true, + "title": "BigQuery Data Transfer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigqueryreservation:v1", - "name": "bigqueryreservation", - "version": "v1", - "title": "BigQuery Reservation API", "description": "A service to modify your BigQuery flat-rate reservations.", "discoveryRestUrl": "https://bigqueryreservation.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/bigquery/", "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/bigquery/", - "preferred": true + "id": "bigqueryreservation:v1", + "kind": "discovery#directoryItem", + "name": "bigqueryreservation", + "preferred": true, + "title": "BigQuery Reservation API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "bigtableadmin:v2", - "name": "bigtableadmin", - "version": "v2", - "title": "Cloud Bigtable Admin API", "description": "Administer your Cloud Bigtable tables and instances.", "discoveryRestUrl": "https://bigtableadmin.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/bigtable/", "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/bigtable/", - "preferred": true + "id": "bigtableadmin:v2", + "kind": "discovery#directoryItem", + "name": "bigtableadmin", + "preferred": true, + "title": "Cloud Bigtable Admin API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "billingbudgets:v1beta1", - "name": "billingbudgets", - "version": "v1beta1", - "title": "Cloud Billing Budget API", "description": "The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.", "discoveryRestUrl": "https://billingbudgets.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview", "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/billing/docs/how-to/budget-api-overview", - "preferred": false - }, - { + "id": "billingbudgets:v1beta1", "kind": "discovery#directoryItem", - "id": "billingbudgets:v1", "name": "billingbudgets", - "version": "v1", + "preferred": false, "title": "Cloud Billing Budget API", + "version": "v1beta1" + }, + { "description": "The Cloud Billing Budget API stores Cloud Billing budgets, which define a budget plan and the rules to execute as spend is tracked against that plan.", "discoveryRestUrl": "https://billingbudgets.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/billing/docs/how-to/budget-api-overview", "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/billing/docs/how-to/budget-api-overview", - "preferred": true + "id": "billingbudgets:v1", + "kind": "discovery#directoryItem", + "name": "billingbudgets", + "preferred": true, + "title": "Cloud Billing Budget API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "binaryauthorization:v1beta1", - "name": "binaryauthorization", - "version": "v1beta1", - "title": "Binary Authorization API", "description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run.", "discoveryRestUrl": "https://binaryauthorization.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/binary-authorization/", "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/binary-authorization/", - "preferred": false - }, - { + "id": "binaryauthorization:v1beta1", "kind": "discovery#directoryItem", - "id": "binaryauthorization:v1", "name": "binaryauthorization", - "version": "v1", + "preferred": false, "title": "Binary Authorization API", + "version": "v1beta1" + }, + { "description": "The management interface for Binary Authorization, a service that provides policy-based deployment validation and control for images deployed to Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, and Cloud Run.", "discoveryRestUrl": "https://binaryauthorization.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/binary-authorization/", "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/binary-authorization/", - "preferred": true + "id": "binaryauthorization:v1", + "kind": "discovery#directoryItem", + "name": "binaryauthorization", + "preferred": true, + "title": "Binary Authorization API", + "version": "v1" }, { - "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", + "documentationLink": "https://cloud.google.com/blockchain-node-engine", "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 + "id": "blockchainnodeengine:v1", + "kind": "discovery#directoryItem", + "name": "blockchainnodeengine", + "preferred": true, + "title": "Blockchain Node Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "blogger:v2", - "name": "blogger", - "version": "v2", - "title": "Blogger API", "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", "discoveryRestUrl": "https://blogger.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", "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://developers.google.com/blogger/docs/3.0/getting_started", - "preferred": false - }, - { + }, + "id": "blogger:v2", "kind": "discovery#directoryItem", - "id": "blogger:v3", "name": "blogger", - "version": "v3", + "preferred": false, "title": "Blogger API", + "version": "v2" + }, + { "description": "The Blogger API provides access to posts, comments and pages of a Blogger blog.", "discoveryRestUrl": "https://blogger.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/blogger/docs/3.0/getting_started", "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://developers.google.com/blogger/docs/3.0/getting_started", - "preferred": true + "id": "blogger:v3", + "kind": "discovery#directoryItem", + "name": "blogger", + "preferred": true, + "title": "Blogger API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "books:v1", - "name": "books", - "version": "v1", - "title": "Books API", "description": "The Google Books API allows clients to access the Google Books repository.", "discoveryRestUrl": "https://books.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://code.google.com/apis/books/docs/v1/getting_started.html", "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://code.google.com/apis/books/docs/v1/getting_started.html", - "preferred": true + "id": "books:v1", + "kind": "discovery#directoryItem", + "name": "books", + "preferred": true, + "title": "Books API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "businessprofileperformance:v1", - "name": "businessprofileperformance", - "version": "v1", - "title": "Business Profile Performance API", "description": "The Business Profile Performance API allows merchants to fetch performance reports about their business profile on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://businessprofileperformance.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "businessprofileperformance:v1", + "kind": "discovery#directoryItem", + "name": "businessprofileperformance", + "preferred": true, + "title": "Business Profile Performance API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "calendar:v3", - "name": "calendar", - "version": "v3", - "title": "Google Calendar API", "description": "The Google Calendar API lets you manage your calendars and events.", "discoveryRestUrl": "https://calendar-json.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "http://code.google.com/apis/calendar/v3/", "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": "http://code.google.com/apis/calendar/v3/", - "preferred": true + "id": "calendar:v3", + "kind": "discovery#directoryItem", + "name": "calendar", + "preferred": true, + "title": "Google Calendar API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "certificatemanager:v1", - "name": "certificatemanager", - "version": "v1", - "title": "Certificate Manager API", "description": "", "discoveryRestUrl": "https://certificatemanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/certificate-manager", "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/certificate-manager", - "preferred": true + "id": "certificatemanager:v1", + "kind": "discovery#directoryItem", + "name": "certificatemanager", + "preferred": true, + "title": "Certificate Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "chat:v1", - "name": "chat", - "version": "v1", - "title": "Google Chat API", "description": "The Google Chat API lets you build Chat apps to integrate your services with Google Chat and manage Chat resources such as spaces, members, and messages.", "discoveryRestUrl": "https://chat.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/hangouts/chat", "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://developers.google.com/hangouts/chat", - "preferred": true + "id": "chat:v1", + "kind": "discovery#directoryItem", + "name": "chat", + "preferred": true, + "title": "Google Chat API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "checks:v1alpha", - "name": "checks", - "version": "v1alpha", - "title": "Checks API", "description": "The Checks API contains powerful and easy-to-use privacy and compliance APIs that interact with the Checks product and its underlying technology.", "discoveryRestUrl": "https://checks.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/checks", "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://developers.google.com/checks", - "preferred": true + "id": "checks:v1alpha", + "kind": "discovery#directoryItem", + "name": "checks", + "preferred": true, + "title": "Checks API", + "version": "v1alpha" }, { - "kind": "discovery#directoryItem", - "id": "chromemanagement:v1", - "name": "chromemanagement", - "version": "v1", - "title": "Chrome Management API", "description": "The Chrome Management API is a suite of services that allows Chrome administrators to view, manage and gain insights on their Chrome OS and Chrome Browser devices.", "discoveryRestUrl": "https://chromemanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://developers.google.com/chrome/management/", "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": "http://developers.google.com/chrome/management/", - "preferred": true + "id": "chromemanagement:v1", + "kind": "discovery#directoryItem", + "name": "chromemanagement", + "preferred": true, + "title": "Chrome Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "chromepolicy:v1", - "name": "chromepolicy", - "version": "v1", - "title": "Chrome Policy API", "description": "The Chrome Policy API is a suite of services that allows Chrome administrators to control the policies applied to their managed Chrome OS devices and Chrome browsers.", "discoveryRestUrl": "https://chromepolicy.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://developers.google.com/chrome/policy", "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": "http://developers.google.com/chrome/policy", - "preferred": true + "id": "chromepolicy:v1", + "kind": "discovery#directoryItem", + "name": "chromepolicy", + "preferred": true, + "title": "Chrome Policy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "chromeuxreport:v1", - "name": "chromeuxreport", - "version": "v1", - "title": "Chrome UX Report API", "description": "The Chrome UX Report API lets you view real user experience data for millions of websites.", "discoveryRestUrl": "https://chromeuxreport.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/web/tools/chrome-user-experience-report/api/reference", "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://developers.google.com/web/tools/chrome-user-experience-report/api/reference", - "preferred": true + "id": "chromeuxreport:v1", + "kind": "discovery#directoryItem", + "name": "chromeuxreport", + "preferred": true, + "title": "Chrome UX Report API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "civicinfo:v2", - "name": "civicinfo", - "version": "v2", - "title": "Google Civic Information API", "description": "Provides polling places, early vote locations, contest data, election officials, and government representatives for U.S. residential addresses.", "discoveryRestUrl": "https://civicinfo.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/civic-information/", "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://developers.google.com/civic-information/", - "preferred": true + "id": "civicinfo:v2", + "kind": "discovery#directoryItem", + "name": "civicinfo", + "preferred": true, + "title": "Google Civic Information API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "classroom:v1", - "name": "classroom", - "version": "v1", - "title": "Google Classroom API", "description": "Manages classes, rosters, and invitations in Google Classroom.", "discoveryRestUrl": "https://classroom.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/classroom", "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://developers.google.com/classroom", - "preferred": true + "id": "classroom:v1", + "kind": "discovery#directoryItem", + "name": "classroom", + "preferred": true, + "title": "Google Classroom API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudasset:v1p1beta1", - "name": "cloudasset", - "version": "v1p1beta1", - "title": "Cloud Asset API", "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "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/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1p1beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1p5beta1", "name": "cloudasset", - "version": "v1p5beta1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1p1beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1p5beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "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/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1p5beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1p7beta1", "name": "cloudasset", - "version": "v1p7beta1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1p5beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1p7beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "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/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1p7beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1beta1", "name": "cloudasset", - "version": "v1beta1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1p7beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "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/asset-inventory/docs/quickstart", - "preferred": false - }, - { + "id": "cloudasset:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudasset:v1", "name": "cloudasset", - "version": "v1", + "preferred": false, "title": "Cloud Asset API", + "version": "v1beta1" + }, + { "description": "The Cloud Asset API manages the history and inventory of Google Cloud resources.", "discoveryRestUrl": "https://cloudasset.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/asset-inventory/docs/quickstart", "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/asset-inventory/docs/quickstart", - "preferred": true + "id": "cloudasset:v1", + "kind": "discovery#directoryItem", + "name": "cloudasset", + "preferred": true, + "title": "Cloud Asset API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudbilling:v1beta", - "name": "cloudbilling", - "version": "v1beta", - "title": "Cloud Billing API", "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", "discoveryRestUrl": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/billing/docs/apis", "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/billing/docs/apis", - "preferred": false - }, - { + "id": "cloudbilling:v1beta", "kind": "discovery#directoryItem", - "id": "cloudbilling:v1", "name": "cloudbilling", - "version": "v1", + "preferred": false, "title": "Cloud Billing API", + "version": "v1beta" + }, + { "description": "Allows developers to manage billing for their Google Cloud Platform projects programmatically.", "discoveryRestUrl": "https://cloudbilling.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/billing/docs/apis", "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/billing/docs/apis", - "preferred": true + "id": "cloudbilling:v1", + "kind": "discovery#directoryItem", + "name": "cloudbilling", + "preferred": true, + "title": "Cloud Billing API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudbuild:v1", - "name": "cloudbuild", - "version": "v1", - "title": "Cloud Build API", "description": "Creates and manages builds on Google Cloud Platform.", "discoveryRestUrl": "https://cloudbuild.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/cloud-build/docs/", "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/cloud-build/docs/", - "preferred": false - }, - { + "id": "cloudbuild:v1", "kind": "discovery#directoryItem", - "id": "cloudbuild:v2", "name": "cloudbuild", - "version": "v2", + "preferred": false, "title": "Cloud Build API", + "version": "v1" + }, + { "description": "Creates and manages builds on Google Cloud Platform.", "discoveryRestUrl": "https://cloudbuild.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/cloud-build/docs/", "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/cloud-build/docs/", - "preferred": true + "id": "cloudbuild:v2", + "kind": "discovery#directoryItem", + "name": "cloudbuild", + "preferred": true, + "title": "Cloud Build API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudchannel:v1", - "name": "cloudchannel", - "version": "v1", - "title": "Cloud Channel API", "description": "The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.", "discoveryRestUrl": "https://cloudchannel.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/channel", "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/channel", - "preferred": true + "id": "cloudchannel:v1", + "kind": "discovery#directoryItem", + "name": "cloudchannel", + "preferred": true, + "title": "Cloud Channel API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudcontrolspartner:v1beta", - "name": "cloudcontrolspartner", - "version": "v1beta", - "title": "Cloud Controls Partner API", "description": "Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.", "discoveryRestUrl": "https://cloudcontrolspartner.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", "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/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", - "preferred": false - }, - { + "id": "cloudcontrolspartner:v1beta", "kind": "discovery#directoryItem", - "id": "cloudcontrolspartner:v1", "name": "cloudcontrolspartner", - "version": "v1", + "preferred": false, "title": "Cloud Controls Partner API", + "version": "v1beta" + }, + { "description": "Provides insights about your customers and their Assured Workloads based on your Sovereign Controls by Partners offering.", "discoveryRestUrl": "https://cloudcontrolspartner.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", "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/sovereign-controls-by-partners/docs/sovereign-partners/reference/rest", - "preferred": true + "id": "cloudcontrolspartner:v1", + "kind": "discovery#directoryItem", + "name": "cloudcontrolspartner", + "preferred": true, + "title": "Cloud Controls Partner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "clouddeploy:v1", - "name": "clouddeploy", - "version": "v1", - "title": "Cloud Deploy API", "description": "", "discoveryRestUrl": "https://clouddeploy.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/deploy/", "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/deploy/", - "preferred": true + "id": "clouddeploy:v1", + "kind": "discovery#directoryItem", + "name": "clouddeploy", + "preferred": true, + "title": "Cloud Deploy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "clouderrorreporting:v1beta1", - "name": "clouderrorreporting", - "version": "v1beta1", - "title": "Error Reporting API", "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.", "discoveryRestUrl": "https://clouderrorreporting.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/error-reporting/", "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/error-reporting/", - "preferred": true + "id": "clouderrorreporting:v1beta1", + "kind": "discovery#directoryItem", + "name": "clouderrorreporting", + "preferred": true, + "title": "Error Reporting API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "cloudfunctions:v2alpha", - "name": "cloudfunctions", - "version": "v2alpha", - "title": "Cloud Functions API", "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2alpha", + "documentationLink": "https://cloud.google.com/functions", "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/functions", - "preferred": false - }, - { + }, + "id": "cloudfunctions:v2alpha", "kind": "discovery#directoryItem", - "id": "cloudfunctions:v2beta", "name": "cloudfunctions", - "version": "v2beta", + "preferred": false, "title": "Cloud Functions API", + "version": "v2alpha" + }, + { "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/functions", "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/functions", - "preferred": false - }, - { + "id": "cloudfunctions:v2beta", "kind": "discovery#directoryItem", - "id": "cloudfunctions:v1", "name": "cloudfunctions", - "version": "v1", + "preferred": false, "title": "Cloud Functions API", + "version": "v2beta" + }, + { "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/functions", "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/functions", - "preferred": false - }, - { + "id": "cloudfunctions:v1", "kind": "discovery#directoryItem", - "id": "cloudfunctions:v2", "name": "cloudfunctions", - "version": "v2", + "preferred": false, "title": "Cloud Functions API", + "version": "v1" + }, + { "description": "Manages lightweight user-provided functions executed in response to events.", "discoveryRestUrl": "https://cloudfunctions.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/functions", "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/functions", - "preferred": true + "id": "cloudfunctions:v2", + "kind": "discovery#directoryItem", + "name": "cloudfunctions", + "preferred": true, + "title": "Cloud Functions API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudidentity:v1beta1", - "name": "cloudidentity", - "version": "v1beta1", - "title": "Cloud Identity API", "description": "API for provisioning and managing identity resources.", "discoveryRestUrl": "https://cloudidentity.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/identity/", "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/identity/", - "preferred": false - }, - { + "id": "cloudidentity:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudidentity:v1", "name": "cloudidentity", - "version": "v1", + "preferred": false, "title": "Cloud Identity API", + "version": "v1beta1" + }, + { "description": "API for provisioning and managing identity resources.", "discoveryRestUrl": "https://cloudidentity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/identity/", "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/identity/", - "preferred": true + "id": "cloudidentity:v1", + "kind": "discovery#directoryItem", + "name": "cloudidentity", + "preferred": true, + "title": "Cloud Identity API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudkms:v1", - "name": "cloudkms", - "version": "v1", - "title": "Cloud Key Management Service (KMS) API", "description": "Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.", "discoveryRestUrl": "https://cloudkms.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kms/", "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/kms/", - "preferred": true + "id": "cloudkms:v1", + "kind": "discovery#directoryItem", + "name": "cloudkms", + "preferred": true, + "title": "Cloud Key Management Service (KMS) API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudprofiler:v2", - "name": "cloudprofiler", - "version": "v2", - "title": "Cloud Profiler API", "description": "Manages continuous profiling information.", "discoveryRestUrl": "https://cloudprofiler.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/profiler/", "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/profiler/", - "preferred": true + "id": "cloudprofiler:v2", + "kind": "discovery#directoryItem", + "name": "cloudprofiler", + "preferred": true, + "title": "Cloud Profiler API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v1beta1", - "name": "cloudresourcemanager", - "version": "v1beta1", - "title": "Cloud Resource Manager API", "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/resource-manager", "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/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v2beta1", "name": "cloudresourcemanager", - "version": "v2beta1", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v1beta1" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://cloud.google.com/resource-manager", "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/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v2beta1", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v1", "name": "cloudresourcemanager", - "version": "v1", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v2beta1" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/resource-manager", "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/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v1", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v2", "name": "cloudresourcemanager", - "version": "v2", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v1" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/resource-manager", "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/resource-manager", - "preferred": false - }, - { + "id": "cloudresourcemanager:v2", "kind": "discovery#directoryItem", - "id": "cloudresourcemanager:v3", "name": "cloudresourcemanager", - "version": "v3", + "preferred": false, "title": "Cloud Resource Manager API", + "version": "v2" + }, + { "description": "Creates, reads, and updates metadata for Google Cloud Platform resource containers.", "discoveryRestUrl": "https://cloudresourcemanager.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/resource-manager", "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/resource-manager", - "preferred": true + "id": "cloudresourcemanager:v3", + "kind": "discovery#directoryItem", + "name": "cloudresourcemanager", + "preferred": true, + "title": "Cloud Resource Manager API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "cloudscheduler:v1beta1", - "name": "cloudscheduler", - "version": "v1beta1", - "title": "Cloud Scheduler API", "description": "Creates and manages jobs run on a regular recurring schedule.", "discoveryRestUrl": "https://cloudscheduler.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/scheduler/", "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/scheduler/", - "preferred": false - }, - { + "id": "cloudscheduler:v1beta1", "kind": "discovery#directoryItem", - "id": "cloudscheduler:v1", "name": "cloudscheduler", - "version": "v1", + "preferred": false, "title": "Cloud Scheduler API", + "version": "v1beta1" + }, + { "description": "Creates and manages jobs run on a regular recurring schedule.", "discoveryRestUrl": "https://cloudscheduler.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/scheduler/", "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/scheduler/", - "preferred": true + "id": "cloudscheduler:v1", + "kind": "discovery#directoryItem", + "name": "cloudscheduler", + "preferred": true, + "title": "Cloud Scheduler API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudsearch:v1", - "name": "cloudsearch", - "version": "v1", - "title": "Cloud Search API", "description": "Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.", "discoveryRestUrl": "https://cloudsearch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/cloud-search/docs/guides/", "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://developers.google.com/cloud-search/docs/guides/", - "preferred": true + "id": "cloudsearch:v1", + "kind": "discovery#directoryItem", + "name": "cloudsearch", + "preferred": true, + "title": "Cloud Search API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudshell:v1", - "name": "cloudshell", - "version": "v1", - "title": "Cloud Shell API", "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.", "discoveryRestUrl": "https://cloudshell.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/shell/docs/", "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/shell/docs/", - "preferred": true + "id": "cloudshell:v1", + "kind": "discovery#directoryItem", + "name": "cloudshell", + "preferred": true, + "title": "Cloud Shell API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "cloudsupport:v2beta", - "name": "cloudsupport", - "version": "v2beta", - "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=v2beta", + "documentationLink": "https://cloud.google.com/support/docs/apis", "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": false - }, - { + "id": "cloudsupport:v2beta", "kind": "discovery#directoryItem", - "id": "cloudsupport:v2", "name": "cloudsupport", - "version": "v2", + "preferred": false, "title": "Google Cloud Support API", + "version": "v2beta" + }, + { "description": "Manages Google Cloud technical support cases for Customer Care support offerings.", "discoveryRestUrl": "https://cloudsupport.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/support/docs/apis", "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 + "id": "cloudsupport:v2", + "kind": "discovery#directoryItem", + "name": "cloudsupport", + "preferred": true, + "title": "Google Cloud Support API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudtasks:v2beta2", - "name": "cloudtasks", - "version": "v2beta2", - "title": "Cloud Tasks API", "description": "Manages the execution of large numbers of distributed requests.", "discoveryRestUrl": "https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta2", + "documentationLink": "https://cloud.google.com/tasks/", "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/tasks/", - "preferred": false - }, - { + "id": "cloudtasks:v2beta2", "kind": "discovery#directoryItem", - "id": "cloudtasks:v2beta3", "name": "cloudtasks", - "version": "v2beta3", + "preferred": false, "title": "Cloud Tasks API", + "version": "v2beta2" + }, + { "description": "Manages the execution of large numbers of distributed requests.", "discoveryRestUrl": "https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta3", + "documentationLink": "https://cloud.google.com/tasks/", "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/tasks/", - "preferred": false - }, - { + "id": "cloudtasks:v2beta3", "kind": "discovery#directoryItem", - "id": "cloudtasks:v2", "name": "cloudtasks", - "version": "v2", + "preferred": false, "title": "Cloud Tasks API", + "version": "v2beta3" + }, + { "description": "Manages the execution of large numbers of distributed requests.", "discoveryRestUrl": "https://cloudtasks.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/tasks/", "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/tasks/", - "preferred": true + "id": "cloudtasks:v2", + "kind": "discovery#directoryItem", + "name": "cloudtasks", + "preferred": true, + "title": "Cloud Tasks API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "cloudtrace:v2beta1", - "name": "cloudtrace", - "version": "v2beta1", - "title": "Cloud Trace API", "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.", "discoveryRestUrl": "https://cloudtrace.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://cloud.google.com/trace", "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/trace", - "preferred": false - }, - { + "id": "cloudtrace:v2beta1", "kind": "discovery#directoryItem", - "id": "cloudtrace:v1", "name": "cloudtrace", - "version": "v1", + "preferred": false, "title": "Cloud Trace API", + "version": "v2beta1" + }, + { "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.", "discoveryRestUrl": "https://cloudtrace.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/trace", "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/trace", - "preferred": false - }, - { + "id": "cloudtrace:v1", "kind": "discovery#directoryItem", - "id": "cloudtrace:v2", "name": "cloudtrace", - "version": "v2", + "preferred": false, "title": "Cloud Trace API", + "version": "v1" + }, + { "description": "Sends application trace data to Cloud Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Cloud Trace API directly. If you are looking to instrument your application for Cloud Trace, we recommend using OpenTelemetry.", "discoveryRestUrl": "https://cloudtrace.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/trace", "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/trace", - "preferred": true + "id": "cloudtrace:v2", + "kind": "discovery#directoryItem", + "name": "cloudtrace", + "preferred": true, + "title": "Cloud Trace API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "composer:v1beta1", - "name": "composer", - "version": "v1beta1", - "title": "Cloud Composer API", "description": "Manages Apache Airflow environments on Google Cloud Platform.", "discoveryRestUrl": "https://composer.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/composer/", "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/composer/", - "preferred": false - }, - { + "id": "composer:v1beta1", "kind": "discovery#directoryItem", - "id": "composer:v1", "name": "composer", - "version": "v1", + "preferred": false, "title": "Cloud Composer API", + "version": "v1beta1" + }, + { "description": "Manages Apache Airflow environments on Google Cloud Platform.", "discoveryRestUrl": "https://composer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/composer/", "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/composer/", - "preferred": true + "id": "composer:v1", + "kind": "discovery#directoryItem", + "name": "composer", + "preferred": true, + "title": "Cloud Composer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "compute:alpha", - "name": "compute", - "version": "alpha", - "title": "Compute Engine API", "description": "Creates and runs virtual machines on Google Cloud Platform.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/alpha/rest", "discoveryLink": "./apis/compute/alpha/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/alpha/rest", + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" }, - "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "preferred": false - }, - { + "id": "compute:alpha", "kind": "discovery#directoryItem", - "id": "compute:beta", "name": "compute", - "version": "beta", + "preferred": false, "title": "Compute Engine API", + "version": "alpha" + }, + { "description": "Creates and runs virtual machines on Google Cloud Platform.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/beta/rest", "discoveryLink": "./apis/compute/beta/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/beta/rest", + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" }, - "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "preferred": false - }, - { + "id": "compute:beta", "kind": "discovery#directoryItem", - "id": "compute:v1", "name": "compute", - "version": "v1", + "preferred": false, "title": "Compute Engine API", + "version": "beta" + }, + { "description": "Creates and runs virtual machines on Google Cloud Platform.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest", "discoveryLink": "./apis/compute/v1/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/compute/v1/rest", + "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", "icons": { "x16": "https://www.google.com/images/icons/product/compute_engine-16.png", "x32": "https://www.google.com/images/icons/product/compute_engine-32.png" }, - "documentationLink": "https://developers.google.com/compute/docs/reference/latest/", - "preferred": true + "id": "compute:v1", + "kind": "discovery#directoryItem", + "name": "compute", + "preferred": true, + "title": "Compute Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "config:v1", - "name": "config", - "version": "v1", - "title": "Infrastructure Manager API", "description": "Creates and manages Google Cloud Platform resources and infrastructure.", "discoveryRestUrl": "https://config.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/infrastructure-manager/docs", "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/infrastructure-manager/docs", - "preferred": true + "id": "config:v1", + "kind": "discovery#directoryItem", + "name": "config", + "preferred": true, + "title": "Infrastructure Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "connectors:v1", - "name": "connectors", - "version": "v1", - "title": "Connectors API", "description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.", "discoveryRestUrl": "https://connectors.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", "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/apigee/docs/api-platform/connectors/about-connectors", - "preferred": false - }, - { + "id": "connectors:v1", "kind": "discovery#directoryItem", - "id": "connectors:v2", "name": "connectors", - "version": "v2", + "preferred": false, "title": "Connectors API", + "version": "v1" + }, + { "description": "Enables users to create and manage connections to Google Cloud services and third-party business applications using the Connectors interface.", "discoveryRestUrl": "https://connectors.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/apigee/docs/api-platform/connectors/about-connectors", "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/apigee/docs/api-platform/connectors/about-connectors", - "preferred": true + "id": "connectors:v2", + "kind": "discovery#directoryItem", + "name": "connectors", + "preferred": true, + "title": "Connectors API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "contactcenteraiplatform:v1alpha1", - "name": "contactcenteraiplatform", - "version": "v1alpha1", - "title": "Contact Center AI Platform API", "description": "", "discoveryRestUrl": "https://contactcenteraiplatform.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/solutions/contact-center-ai-platform", "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/solutions/contact-center-ai-platform", - "preferred": true + "id": "contactcenteraiplatform:v1alpha1", + "kind": "discovery#directoryItem", + "name": "contactcenteraiplatform", + "preferred": true, + "title": "Contact Center AI Platform API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "contactcenterinsights:v1", - "name": "contactcenterinsights", - "version": "v1", - "title": "Contact Center AI Insights API", "description": "", "discoveryRestUrl": "https://contactcenterinsights.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/contact-center/insights/docs", "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/contact-center/insights/docs", - "preferred": true + "id": "contactcenterinsights:v1", + "kind": "discovery#directoryItem", + "name": "contactcenterinsights", + "preferred": true, + "title": "Contact Center AI Insights API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "container:v1beta1", - "name": "container", - "version": "v1beta1", - "title": "Kubernetes Engine API", "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryRestUrl": "https://container.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/", "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/container-engine/", - "preferred": false - }, - { + "id": "container:v1beta1", "kind": "discovery#directoryItem", - "id": "container:v1", "name": "container", - "version": "v1", + "preferred": false, "title": "Kubernetes Engine API", + "version": "v1beta1" + }, + { "description": "Builds and manages container-based applications, powered by the open source Kubernetes technology.", "discoveryRestUrl": "https://container.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/", "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/container-engine/", - "preferred": true + "id": "container:v1", + "kind": "discovery#directoryItem", + "name": "container", + "preferred": true, + "title": "Kubernetes Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "containeranalysis:v1alpha1", - "name": "containeranalysis", - "version": "v1alpha1", - "title": "Container Analysis API", "description": "This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.", "discoveryRestUrl": "https://containeranalysis.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "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/container-analysis/api/reference/rest/", - "preferred": false - }, - { + "id": "containeranalysis:v1alpha1", "kind": "discovery#directoryItem", - "id": "containeranalysis:v1beta1", "name": "containeranalysis", - "version": "v1beta1", + "preferred": false, "title": "Container Analysis API", + "version": "v1alpha1" + }, + { "description": "This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.", "discoveryRestUrl": "https://containeranalysis.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "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/container-analysis/api/reference/rest/", - "preferred": false - }, - { + "id": "containeranalysis:v1beta1", "kind": "discovery#directoryItem", - "id": "containeranalysis:v1", "name": "containeranalysis", - "version": "v1", + "preferred": false, "title": "Container Analysis API", + "version": "v1beta1" + }, + { "description": "This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. In addition, the Container Analysis API is an implementation of the Grafeas API, which enables storing, querying, and retrieval of critical metadata about all of your software artifacts.", "discoveryRestUrl": "https://containeranalysis.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "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/container-analysis/api/reference/rest/", - "preferred": true + "id": "containeranalysis:v1", + "kind": "discovery#directoryItem", + "name": "containeranalysis", + "preferred": true, + "title": "Container Analysis API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "content:v2.1", - "name": "content", - "version": "v2.1", - "title": "Content API for Shopping", "description": "Manage your product listings and accounts for Google Shopping", "discoveryRestUrl": "https://shoppingcontent.googleapis.com/$discovery/rest?version=v2.1", + "documentationLink": "https://developers.google.com/shopping-content/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://developers.google.com/shopping-content/v2/", - "preferred": true + "id": "content:v2.1", + "kind": "discovery#directoryItem", + "name": "content", + "preferred": true, + "title": "Content API for Shopping", + "version": "v2.1" }, { - "kind": "discovery#directoryItem", - "id": "contentwarehouse:v1", - "name": "contentwarehouse", - "version": "v1", - "title": "Document AI Warehouse API", "description": "", "discoveryRestUrl": "https://contentwarehouse.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/document-warehouse", "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/document-warehouse", - "preferred": true + "id": "contentwarehouse:v1", + "kind": "discovery#directoryItem", + "name": "contentwarehouse", + "preferred": true, + "title": "Document AI Warehouse API", + "version": "v1" }, { + "description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.", + "discoveryRestUrl": "https://css.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview", + "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" + }, + "id": "css:v1", "kind": "discovery#directoryItem", - "id": "customsearch:v1", - "name": "customsearch", - "version": "v1", - "title": "Custom Search API", + "name": "css", + "preferred": true, + "title": "CSS API", + "version": "v1" + }, + { "description": "Searches over a website or collection of websites", "discoveryRestUrl": "https://customsearch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/custom-search/v1/introduction", "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://developers.google.com/custom-search/v1/introduction", - "preferred": true + "id": "customsearch:v1", + "kind": "discovery#directoryItem", + "name": "customsearch", + "preferred": true, + "title": "Custom Search API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datacatalog:v1beta1", - "name": "datacatalog", - "version": "v1beta1", - "title": "Google Cloud Data Catalog API", "description": "A fully managed and highly scalable data discovery and metadata management service.", "discoveryRestUrl": "https://datacatalog.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/data-catalog/docs/", "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/data-catalog/docs/", - "preferred": false - }, - { + "id": "datacatalog:v1beta1", "kind": "discovery#directoryItem", - "id": "datacatalog:v1", "name": "datacatalog", - "version": "v1", + "preferred": false, "title": "Google Cloud Data Catalog API", + "version": "v1beta1" + }, + { "description": "A fully managed and highly scalable data discovery and metadata management service.", "discoveryRestUrl": "https://datacatalog.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/data-catalog/docs/", "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/data-catalog/docs/", - "preferred": true + "id": "datacatalog:v1", + "kind": "discovery#directoryItem", + "name": "datacatalog", + "preferred": true, + "title": "Google Cloud Data Catalog API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataflow:v1b3", - "name": "dataflow", - "version": "v1b3", - "title": "Dataflow API", "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.", "discoveryRestUrl": "https://dataflow.googleapis.com/$discovery/rest?version=v1b3", + "documentationLink": "https://cloud.google.com/dataflow", "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/dataflow", - "preferred": true + "id": "dataflow:v1b3", + "kind": "discovery#directoryItem", + "name": "dataflow", + "preferred": true, + "title": "Dataflow API", + "version": "v1b3" }, { - "kind": "discovery#directoryItem", - "id": "dataform:v1beta1", - "name": "dataform", - "version": "v1beta1", - "title": "Dataform API", "description": "Service to develop, version control, and operationalize SQL pipelines in BigQuery.", "discoveryRestUrl": "https://dataform.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/dataform/docs", "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/dataform/docs", - "preferred": true + "id": "dataform:v1beta1", + "kind": "discovery#directoryItem", + "name": "dataform", + "preferred": true, + "title": "Dataform API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "datafusion:v1beta1", - "name": "datafusion", - "version": "v1beta1", - "title": "Cloud Data Fusion API", "description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.", "discoveryRestUrl": "https://datafusion.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/data-fusion/docs", "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/data-fusion/docs", - "preferred": false - }, - { + "id": "datafusion:v1beta1", "kind": "discovery#directoryItem", - "id": "datafusion:v1", "name": "datafusion", - "version": "v1", + "preferred": false, "title": "Cloud Data Fusion API", + "version": "v1beta1" + }, + { "description": "Cloud Data Fusion is a fully-managed, cloud native, enterprise data integration service for quickly building and managing data pipelines. It provides a graphical interface to increase time efficiency and reduce complexity, and allows business users, developers, and data scientists to easily and reliably build scalable data integration solutions to cleanse, prepare, blend, transfer and transform data without having to wrestle with infrastructure.", "discoveryRestUrl": "https://datafusion.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/data-fusion/docs", "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/data-fusion/docs", - "preferred": true + "id": "datafusion:v1", + "kind": "discovery#directoryItem", + "name": "datafusion", + "preferred": true, + "title": "Cloud Data Fusion API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datalabeling:v1beta1", - "name": "datalabeling", - "version": "v1beta1", - "title": "Data Labeling API", "description": "Public API for Google Cloud AI Data Labeling Service.", "discoveryRestUrl": "https://datalabeling.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/data-labeling/docs/", "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/data-labeling/docs/", - "preferred": true + "id": "datalabeling:v1beta1", + "kind": "discovery#directoryItem", + "name": "datalabeling", + "preferred": true, + "title": "Data Labeling API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "datalineage:v1", - "name": "datalineage", - "version": "v1", - "title": "Data Lineage API", "description": "", "discoveryRestUrl": "https://datalineage.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/data-catalog", "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/data-catalog", - "preferred": true + "id": "datalineage:v1", + "kind": "discovery#directoryItem", + "name": "datalineage", + "preferred": true, + "title": "Data Lineage API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datamigration:v1beta1", - "name": "datamigration", - "version": "v1beta1", - "title": "Database Migration API", "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", "discoveryRestUrl": "https://datamigration.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/database-migration/", "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/database-migration/", - "preferred": false - }, - { + "id": "datamigration:v1beta1", "kind": "discovery#directoryItem", - "id": "datamigration:v1", "name": "datamigration", - "version": "v1", + "preferred": false, "title": "Database Migration API", + "version": "v1beta1" + }, + { "description": "Manage Cloud Database Migration Service resources on Google Cloud Platform.", "discoveryRestUrl": "https://datamigration.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/database-migration/", "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/database-migration/", - "preferred": true + "id": "datamigration:v1", + "kind": "discovery#directoryItem", + "name": "datamigration", + "preferred": true, + "title": "Database Migration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datapipelines:v1", - "name": "datapipelines", - "version": "v1", - "title": "Data pipelines API", "description": "Data Pipelines provides an interface for creating, updating, and managing recurring Data Analytics jobs.", "discoveryRestUrl": "https://datapipelines.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataflow/docs/guides/data-pipelines", "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/dataflow/docs/guides/data-pipelines", - "preferred": true + "id": "datapipelines:v1", + "kind": "discovery#directoryItem", + "name": "datapipelines", + "preferred": true, + "title": "Data pipelines API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataplex:v1", - "name": "dataplex", - "version": "v1", - "title": "Cloud Dataplex API", "description": "Dataplex API is used to manage the lifecycle of data lakes.", "discoveryRestUrl": "https://dataplex.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataplex/docs", "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/dataplex/docs", - "preferred": true + "id": "dataplex:v1", + "kind": "discovery#directoryItem", + "name": "dataplex", + "preferred": true, + "title": "Cloud Dataplex API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataportability:v1beta", - "name": "dataportability", - "version": "v1beta", - "title": "Data Portability API", "description": "The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.", "discoveryRestUrl": "https://dataportability.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://developers.google.com/data-portability", "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://developers.google.com/data-portability", - "preferred": false - }, - { + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "dataportability:v1beta", "kind": "discovery#directoryItem", - "id": "dataportability:v1", "name": "dataportability", - "version": "v1", + "preferred": false, "title": "Data Portability API", + "version": "v1beta" + }, + { "description": "The Data Portability API lets you build applications that request authorization from a user to move a copy of data from Google services into your application. This enables data portability and facilitates switching services.", "discoveryRestUrl": "https://dataportability.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/data-portability", "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://developers.google.com/data-portability", - "preferred": true + "id": "dataportability:v1", + "kind": "discovery#directoryItem", + "name": "dataportability", + "preferred": true, + "title": "Data Portability API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dataproc:v1", - "name": "dataproc", - "version": "v1", - "title": "Cloud Dataproc API", "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", "discoveryRestUrl": "https://dataproc.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataproc/", "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/dataproc/", - "preferred": true + "id": "dataproc:v1", + "kind": "discovery#directoryItem", + "name": "dataproc", + "preferred": true, + "title": "Cloud Dataproc API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datastore:v1beta1", - "name": "datastore", - "version": "v1beta1", - "title": "Cloud Datastore API", "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.", "discoveryRestUrl": "https://datastore.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/datastore/", "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/datastore/", - "preferred": false - }, - { + "id": "datastore:v1beta1", "kind": "discovery#directoryItem", - "id": "datastore:v1beta3", "name": "datastore", - "version": "v1beta3", + "preferred": false, "title": "Cloud Datastore API", + "version": "v1beta1" + }, + { "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.", "discoveryRestUrl": "https://datastore.googleapis.com/$discovery/rest?version=v1beta3", + "documentationLink": "https://cloud.google.com/datastore/", "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/datastore/", - "preferred": false - }, - { + "id": "datastore:v1beta3", "kind": "discovery#directoryItem", - "id": "datastore:v1", "name": "datastore", - "version": "v1", + "preferred": false, "title": "Cloud Datastore API", + "version": "v1beta3" + }, + { "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.", "discoveryRestUrl": "https://datastore.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/datastore/", "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/datastore/", - "preferred": true + "id": "datastore:v1", + "kind": "discovery#directoryItem", + "name": "datastore", + "preferred": true, + "title": "Cloud Datastore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "datastream:v1alpha1", - "name": "datastream", - "version": "v1alpha1", - "title": "Datastream API", "description": "", "discoveryRestUrl": "https://datastream.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/datastream/", "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/datastream/", - "preferred": false - }, - { + "id": "datastream:v1alpha1", "kind": "discovery#directoryItem", - "id": "datastream:v1", "name": "datastream", - "version": "v1", + "preferred": false, "title": "Datastream API", + "version": "v1alpha1" + }, + { "description": "", "discoveryRestUrl": "https://datastream.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/datastream/", "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/datastream/", - "preferred": true + "id": "datastream:v1", + "kind": "discovery#directoryItem", + "name": "datastream", + "preferred": true, + "title": "Datastream API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "deploymentmanager:alpha", - "name": "deploymentmanager", - "version": "alpha", - "title": "Cloud Deployment Manager V2 API", "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryRestUrl": "https://deploymentmanager.googleapis.com/$discovery/rest?version=alpha", + "documentationLink": "https://cloud.google.com/deployment-manager", "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/deployment-manager", - "preferred": false - }, - { + "id": "deploymentmanager:alpha", "kind": "discovery#directoryItem", - "id": "deploymentmanager:v2beta", "name": "deploymentmanager", - "version": "v2beta", + "preferred": false, "title": "Cloud Deployment Manager V2 API", + "version": "alpha" + }, + { "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryRestUrl": "https://deploymentmanager.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/deployment-manager", "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/deployment-manager", - "preferred": false - }, - { + "id": "deploymentmanager:v2beta", "kind": "discovery#directoryItem", - "id": "deploymentmanager:v2", "name": "deploymentmanager", - "version": "v2", + "preferred": false, "title": "Cloud Deployment Manager V2 API", + "version": "v2beta" + }, + { "description": "The Google Cloud Deployment Manager v2 API provides services for configuring, deploying, and viewing Google Cloud services and APIs via templates which specify deployments of Cloud resources.", "discoveryRestUrl": "https://deploymentmanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/deployment-manager", "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/deployment-manager", - "preferred": true + "id": "deploymentmanager:v2", + "kind": "discovery#directoryItem", + "name": "deploymentmanager", + "preferred": true, + "title": "Cloud Deployment Manager V2 API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "developerconnect:v1", - "name": "developerconnect", - "version": "v1", - "title": "Developer Connect API", "description": "Connect third-party source code management to Google", "discoveryRestUrl": "https://developerconnect.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://cloud.google.com/developer-connect/docs/overview", "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": "http://cloud.google.com/developer-connect/docs/overview", - "preferred": true + "id": "developerconnect:v1", + "kind": "discovery#directoryItem", + "name": "developerconnect", + "preferred": true, + "title": "Developer Connect API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "dfareporting:v3.5", - "name": "dfareporting", - "version": "v3.5", - "title": "Campaign Manager 360 API", "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", "discoveryRestUrl": "https://dfareporting.googleapis.com/$discovery/rest?version=v3.5", + "documentationLink": "https://developers.google.com/doubleclick-advertisers/", "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://developers.google.com/doubleclick-advertisers/", - "preferred": false - }, - { + "id": "dfareporting:v3.5", "kind": "discovery#directoryItem", - "id": "dfareporting:v4", "name": "dfareporting", - "version": "v4", + "preferred": false, "title": "Campaign Manager 360 API", + "version": "v3.5" + }, + { "description": "Build applications to efficiently manage large or complex trafficking, reporting, and attribution workflows for Campaign Manager 360.", "discoveryRestUrl": "https://dfareporting.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/doubleclick-advertisers/", "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://developers.google.com/doubleclick-advertisers/", - "preferred": true + "id": "dfareporting:v4", + "kind": "discovery#directoryItem", + "name": "dfareporting", + "preferred": true, + "title": "Campaign Manager 360 API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "dialogflow:v2beta1", - "name": "dialogflow", - "version": "v2beta1", - "title": "Dialogflow API", "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v2beta1", + "documentationLink": "https://cloud.google.com/dialogflow/", "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/dialogflow/", - "preferred": false - }, - { + "id": "dialogflow:v2beta1", "kind": "discovery#directoryItem", - "id": "dialogflow:v3beta1", "name": "dialogflow", - "version": "v3beta1", + "preferred": false, "title": "Dialogflow API", + "version": "v2beta1" + }, + { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v3beta1", + "documentationLink": "https://cloud.google.com/dialogflow/", "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/dialogflow/", - "preferred": false - }, - { + "id": "dialogflow:v3beta1", "kind": "discovery#directoryItem", - "id": "dialogflow:v2", "name": "dialogflow", - "version": "v2", + "preferred": false, "title": "Dialogflow API", + "version": "v3beta1" + }, + { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/dialogflow/", "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/dialogflow/", - "preferred": false - }, - { + "id": "dialogflow:v2", "kind": "discovery#directoryItem", - "id": "dialogflow:v3", "name": "dialogflow", - "version": "v3", + "preferred": false, "title": "Dialogflow API", + "version": "v2" + }, + { "description": "Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).", "discoveryRestUrl": "https://dialogflow.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/dialogflow/", "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/dialogflow/", - "preferred": true + "id": "dialogflow:v3", + "kind": "discovery#directoryItem", + "name": "dialogflow", + "preferred": true, + "title": "Dialogflow API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "digitalassetlinks:v1", - "name": "digitalassetlinks", - "version": "v1", - "title": "Digital Asset Links API", "description": "Discovers relationships between online assets such as websites or mobile apps.", "discoveryRestUrl": "https://digitalassetlinks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/digital-asset-links/", "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://developers.google.com/digital-asset-links/", - "preferred": true + "id": "digitalassetlinks:v1", + "kind": "discovery#directoryItem", + "name": "digitalassetlinks", + "preferred": true, + "title": "Digital Asset Links API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "discovery:v1", - "name": "discovery", - "version": "v1", - "title": "API Discovery Service", "description": "Google API Discovery Service allows service consumers to list the discovery metadata of all public APIs managed by the API Platform.", "discoveryRestUrl": "https://discovery.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/discovery", "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://developers.google.com/discovery", - "preferred": true + "id": "discovery:v1", + "kind": "discovery#directoryItem", + "name": "discovery", + "preferred": true, + "title": "API Discovery Service", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "discoveryengine:v1alpha", - "name": "discoveryengine", - "version": "v1alpha", - "title": "Discovery Engine API", "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/discovery-engine/docs", "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/discovery-engine/docs", - "preferred": false - }, - { + "id": "discoveryengine:v1alpha", "kind": "discovery#directoryItem", - "id": "discoveryengine:v1beta", "name": "discoveryengine", - "version": "v1beta", + "preferred": false, "title": "Discovery Engine API", + "version": "v1alpha" + }, + { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/discovery-engine/docs", "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/discovery-engine/docs", - "preferred": false - }, - { + "id": "discoveryengine:v1beta", "kind": "discovery#directoryItem", - "id": "discoveryengine:v1", "name": "discoveryengine", - "version": "v1", + "preferred": false, "title": "Discovery Engine API", + "version": "v1beta" + }, + { "description": "Discovery Engine API.", "discoveryRestUrl": "https://discoveryengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/discovery-engine/docs", "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/discovery-engine/docs", - "preferred": true + "id": "discoveryengine:v1", + "kind": "discovery#directoryItem", + "name": "discoveryengine", + "preferred": true, + "title": "Discovery Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "displayvideo:v2", - "name": "displayvideo", - "version": "v2", - "title": "Display & Video 360 API", "description": "Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.", "discoveryRestUrl": "https://displayvideo.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/display-video/", "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://developers.google.com/display-video/", - "preferred": false - }, - { + "id": "displayvideo:v2", "kind": "discovery#directoryItem", - "id": "displayvideo:v3", "name": "displayvideo", - "version": "v3", + "preferred": false, "title": "Display & Video 360 API", + "version": "v2" + }, + { "description": "Display & Video 360 API allows users to automate complex Display & Video 360 workflows, such as creating insertion orders and setting targeting options for individual line items.", "discoveryRestUrl": "https://displayvideo.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/display-video/", "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://developers.google.com/display-video/", - "preferred": true + "id": "displayvideo:v3", + "kind": "discovery#directoryItem", + "name": "displayvideo", + "preferred": true, + "title": "Display & Video 360 API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "dlp:v2", - "name": "dlp", - "version": "v2", - "title": "Sensitive Data Protection (DLP)", "description": "Discover and protect your sensitive data. A fully managed service designed to help you discover, classify, and protect your valuable data assets with ease.", "discoveryRestUrl": "https://dlp.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/sensitive-data-protection/docs/", "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/sensitive-data-protection/docs/", - "preferred": true + "id": "dlp:v2", + "kind": "discovery#directoryItem", + "name": "dlp", + "preferred": true, + "title": "Sensitive Data Protection (DLP)", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "dns:v1beta2", - "name": "dns", - "version": "v1beta2", - "title": "Cloud DNS API", "description": "", "discoveryRestUrl": "https://dns.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/dns/docs", "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/dns/docs", - "preferred": false - }, - { + "id": "dns:v1beta2", "kind": "discovery#directoryItem", - "id": "dns:v1", "name": "dns", - "version": "v1", + "preferred": false, "title": "Cloud DNS API", + "version": "v1beta2" + }, + { "description": "", "discoveryRestUrl": "https://dns.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dns/docs", "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/dns/docs", - "preferred": true + "id": "dns:v1", + "kind": "discovery#directoryItem", + "name": "dns", + "preferred": true, + "title": "Cloud DNS API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "docs:v1", - "name": "docs", - "version": "v1", - "title": "Google Docs API", "description": "Reads and writes Google Docs documents.", "discoveryRestUrl": "https://docs.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/docs/", "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://developers.google.com/docs/", - "preferred": true + "id": "docs:v1", + "kind": "discovery#directoryItem", + "name": "docs", + "preferred": true, + "title": "Google Docs API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "documentai:v1beta2", - "name": "documentai", - "version": "v1beta2", - "title": "Cloud Document AI API", "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/document-ai/docs/", "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/document-ai/docs/", - "preferred": false - }, - { + "id": "documentai:v1beta2", "kind": "discovery#directoryItem", - "id": "documentai:v1beta3", "name": "documentai", - "version": "v1beta3", + "preferred": false, "title": "Cloud Document AI API", + "version": "v1beta2" + }, + { "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1beta3", + "documentationLink": "https://cloud.google.com/document-ai/docs/", "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/document-ai/docs/", - "preferred": false - }, - { + "id": "documentai:v1beta3", "kind": "discovery#directoryItem", - "id": "documentai:v1", "name": "documentai", - "version": "v1", + "preferred": false, "title": "Cloud Document AI API", + "version": "v1beta3" + }, + { "description": "Service to parse structured information from unstructured or semi-structured documents using state-of-the-art Google AI such as natural language, computer vision, translation, and AutoML.", "discoveryRestUrl": "https://documentai.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/document-ai/docs/", "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/document-ai/docs/", - "preferred": true + "id": "documentai:v1", + "kind": "discovery#directoryItem", + "name": "documentai", + "preferred": true, + "title": "Cloud Document AI API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "domains:v1alpha2", - "name": "domains", - "version": "v1alpha2", - "title": "Cloud Domains API", "description": "Enables management and configuration of domain names.", "discoveryRestUrl": "https://domains.googleapis.com/$discovery/rest?version=v1alpha2", + "documentationLink": "https://cloud.google.com/domains/", "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/domains/", - "preferred": false - }, - { + "id": "domains:v1alpha2", "kind": "discovery#directoryItem", - "id": "domains:v1beta1", "name": "domains", - "version": "v1beta1", + "preferred": false, "title": "Cloud Domains API", + "version": "v1alpha2" + }, + { "description": "Enables management and configuration of domain names.", "discoveryRestUrl": "https://domains.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/domains/", "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/domains/", - "preferred": false - }, - { + "id": "domains:v1beta1", "kind": "discovery#directoryItem", - "id": "domains:v1", "name": "domains", - "version": "v1", + "preferred": false, "title": "Cloud Domains API", + "version": "v1beta1" + }, + { "description": "Enables management and configuration of domain names.", "discoveryRestUrl": "https://domains.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/domains/", - "preferred": true - }, - { - "kind": "discovery#directoryItem", - "id": "domainsrdap:v1", - "name": "domainsrdap", - "version": "v1", - "title": "Domains RDAP API", - "description": "Read-only public API that lets users search for information about domain names.", - "discoveryRestUrl": "https://domainsrdap.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://developers.google.com/domains/rdap/", - "preferred": true + "id": "domains:v1", + "kind": "discovery#directoryItem", + "name": "domains", + "preferred": true, + "title": "Cloud Domains API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "doubleclickbidmanager:v2", - "name": "doubleclickbidmanager", - "version": "v2", - "title": "DoubleClick Bid Manager API", "description": "DoubleClick Bid Manager API allows users to manage and create campaigns and reports.", "discoveryRestUrl": "https://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/bid-manager/", "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://developers.google.com/bid-manager/", - "preferred": true + "id": "doubleclickbidmanager:v2", + "kind": "discovery#directoryItem", + "name": "doubleclickbidmanager", + "preferred": true, + "title": "DoubleClick Bid Manager API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "doubleclicksearch:v2", - "name": "doubleclicksearch", - "version": "v2", - "title": "Search Ads 360 API", "description": "The Search Ads 360 API allows developers to automate uploading conversions and downloading reports from Search Ads 360.", "discoveryRestUrl": "https://doubleclicksearch.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/search-ads", "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://developers.google.com/search-ads", - "preferred": true + "id": "doubleclicksearch:v2", + "kind": "discovery#directoryItem", + "name": "doubleclicksearch", + "preferred": true, + "title": "Search Ads 360 API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "drive:v2", - "name": "drive", - "version": "v2", - "title": "Drive API", "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v2/rest", "discoveryLink": "./apis/drive/v2/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v2/rest", + "documentationLink": "https://developers.google.com/drive/", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" }, - "documentationLink": "https://developers.google.com/drive/", - "preferred": false - }, - { + "id": "drive:v2", "kind": "discovery#directoryItem", - "id": "drive:v3", "name": "drive", - "version": "v3", + "preferred": false, "title": "Drive API", + "version": "v2" + }, + { "description": "Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v3/rest", "discoveryLink": "./apis/drive/v3/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/drive/v3/rest", + "documentationLink": "https://developers.google.com/drive/", "icons": { "x16": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_16.png", "x32": "https://ssl.gstatic.com/docs/doclist/images/drive_icon_32.png" }, - "documentationLink": "https://developers.google.com/drive/", - "preferred": true + "id": "drive:v3", + "kind": "discovery#directoryItem", + "name": "drive", + "preferred": true, + "title": "Drive API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "driveactivity:v2", - "name": "driveactivity", - "version": "v2", - "title": "Drive Activity API", "description": "Provides a historical view of activity in Google Drive.", "discoveryRestUrl": "https://driveactivity.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/drive/activity/", "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://developers.google.com/drive/activity/", - "preferred": true + "id": "driveactivity:v2", + "kind": "discovery#directoryItem", + "name": "driveactivity", + "preferred": true, + "title": "Drive Activity API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "drivelabels:v2beta", - "name": "drivelabels", - "version": "v2beta", - "title": "Drive Labels API", "description": "An API for managing Drive Labels", "discoveryRestUrl": "https://drivelabels.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://developers.google.com/drive/labels", "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://developers.google.com/drive/labels", - "preferred": false - }, - { + "id": "drivelabels:v2beta", "kind": "discovery#directoryItem", - "id": "drivelabels:v2", "name": "drivelabels", - "version": "v2", + "preferred": false, "title": "Drive Labels API", + "version": "v2beta" + }, + { "description": "An API for managing Drive Labels", "discoveryRestUrl": "https://drivelabels.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/drive/labels", "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://developers.google.com/drive/labels", - "preferred": true + "id": "drivelabels:v2", + "kind": "discovery#directoryItem", + "name": "drivelabels", + "preferred": true, + "title": "Drive Labels API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "essentialcontacts:v1", - "name": "essentialcontacts", - "version": "v1", - "title": "Essential Contacts API", "description": "", "discoveryRestUrl": "https://essentialcontacts.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/essentialcontacts/docs/", "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/essentialcontacts/docs/", - "preferred": true + "id": "essentialcontacts:v1", + "kind": "discovery#directoryItem", + "name": "essentialcontacts", + "preferred": true, + "title": "Essential Contacts API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "eventarc:v1", - "name": "eventarc", - "version": "v1", - "title": "Eventarc API", "description": "Build event-driven applications on Google Cloud Platform.", "discoveryRestUrl": "https://eventarc.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/eventarc", "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/eventarc", - "preferred": true + "id": "eventarc:v1", + "kind": "discovery#directoryItem", + "name": "eventarc", + "preferred": true, + "title": "Eventarc API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "factchecktools:v1alpha1", - "name": "factchecktools", - "version": "v1alpha1", - "title": "Fact Check Tools API", "description": "", "discoveryRestUrl": "https://factchecktools.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/fact-check/tools/api/", "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://developers.google.com/fact-check/tools/api/", - "preferred": true + "id": "factchecktools:v1alpha1", + "kind": "discovery#directoryItem", + "name": "factchecktools", + "preferred": true, + "title": "Fact Check Tools API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "fcm:v1", - "name": "fcm", - "version": "v1", - "title": "Firebase Cloud Messaging API", "description": "FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost.", "discoveryRestUrl": "https://fcm.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/cloud-messaging", "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://firebase.google.com/docs/cloud-messaging", - "preferred": true + "id": "fcm:v1", + "kind": "discovery#directoryItem", + "name": "fcm", + "preferred": true, + "title": "Firebase Cloud Messaging API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "fcmdata:v1beta1", - "name": "fcmdata", - "version": "v1beta1", - "title": "Firebase Cloud Messaging Data API", "description": "Provides additional information about Firebase Cloud Messaging (FCM) message sends and deliveries.", "discoveryRestUrl": "https://fcmdata.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://firebase.google.com/docs/cloud-messaging", "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://firebase.google.com/docs/cloud-messaging", - "preferred": true + "id": "fcmdata:v1beta1", + "kind": "discovery#directoryItem", + "name": "fcmdata", + "preferred": true, + "title": "Firebase Cloud Messaging Data API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "file:v1beta1", - "name": "file", - "version": "v1beta1", - "title": "Cloud Filestore API", "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "discoveryRestUrl": "https://file.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/filestore/", "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/filestore/", - "preferred": false - }, - { + "id": "file:v1beta1", "kind": "discovery#directoryItem", - "id": "file:v1", "name": "file", - "version": "v1", + "preferred": false, "title": "Cloud Filestore API", + "version": "v1beta1" + }, + { "description": "The Cloud Filestore API is used for creating and managing cloud file servers.", "discoveryRestUrl": "https://file.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/filestore/", "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/filestore/", - "preferred": true + "id": "file:v1", + "kind": "discovery#directoryItem", + "name": "file", + "preferred": true, + "title": "Cloud Filestore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebase:v1beta1", - "name": "firebase", - "version": "v1beta1", - "title": "Firebase Management API", "description": "The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.", "discoveryRestUrl": "https://firebase.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://firebase.google.com", "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://firebase.google.com", - "preferred": true + "id": "firebase:v1beta1", + "kind": "discovery#directoryItem", + "name": "firebase", + "preferred": true, + "title": "Firebase Management API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "firebaseappcheck:v1beta", - "name": "firebaseappcheck", - "version": "v1beta", - "title": "Firebase App Check API", "description": "Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.", "discoveryRestUrl": "https://firebaseappcheck.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/app-check", "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://firebase.google.com/docs/app-check", - "preferred": false - }, - { + "id": "firebaseappcheck:v1beta", "kind": "discovery#directoryItem", - "id": "firebaseappcheck:v1", "name": "firebaseappcheck", - "version": "v1", + "preferred": false, "title": "Firebase App Check API", + "version": "v1beta" + }, + { "description": "Firebase App Check works alongside other Firebase services to help protect your backend resources from abuse, such as billing fraud or phishing.", "discoveryRestUrl": "https://firebaseappcheck.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/app-check", "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://firebase.google.com/docs/app-check", - "preferred": true + "id": "firebaseappcheck:v1", + "kind": "discovery#directoryItem", + "name": "firebaseappcheck", + "preferred": true, + "title": "Firebase App Check API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebaseappdistribution:v1alpha", - "name": "firebaseappdistribution", - "version": "v1alpha", - "title": "Firebase App Distribution API", "description": "", "discoveryRestUrl": "https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://firebase.google.com/products/app-distribution", "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://firebase.google.com/products/app-distribution", - "preferred": false - }, - { + "id": "firebaseappdistribution:v1alpha", "kind": "discovery#directoryItem", - "id": "firebaseappdistribution:v1", "name": "firebaseappdistribution", - "version": "v1", + "preferred": false, "title": "Firebase App Distribution API", + "version": "v1alpha" + }, + { "description": "", "discoveryRestUrl": "https://firebaseappdistribution.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/products/app-distribution", "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://firebase.google.com/products/app-distribution", - "preferred": true + "id": "firebaseappdistribution:v1", + "kind": "discovery#directoryItem", + "name": "firebaseappdistribution", + "preferred": true, + "title": "Firebase App Distribution API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebasedatabase:v1beta", - "name": "firebasedatabase", - "version": "v1beta", - "title": "Firebase Realtime Database API", "description": "The Firebase Realtime Database API enables programmatic provisioning and management of Realtime Database instances.", "discoveryRestUrl": "https://firebasedatabase.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/reference/rest/database/database-management/rest/", "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://firebase.google.com/docs/reference/rest/database/database-management/rest/", - "preferred": true + "id": "firebasedatabase:v1beta", + "kind": "discovery#directoryItem", + "name": "firebasedatabase", + "preferred": true, + "title": "Firebase Realtime Database API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "firebasedynamiclinks:v1", - "name": "firebasedynamiclinks", - "version": "v1", - "title": "Firebase Dynamic Links API", "description": "Programmatically creates and manages Firebase Dynamic Links.", "discoveryRestUrl": "https://firebasedynamiclinks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/dynamic-links/", "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://firebase.google.com/docs/dynamic-links/", - "preferred": true + "id": "firebasedynamiclinks:v1", + "kind": "discovery#directoryItem", + "name": "firebasedynamiclinks", + "preferred": true, + "title": "Firebase Dynamic Links API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebasehosting:v1beta1", - "name": "firebasehosting", - "version": "v1beta1", - "title": "Firebase Hosting API", "description": "The Firebase Hosting REST API enables programmatic and customizable management and deployments to your Firebase-hosted sites. Use this REST API to create and manage channels and sites as well as to deploy new or updated hosting configurations and content files.", "discoveryRestUrl": "https://firebasehosting.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://firebase.google.com/docs/hosting/", "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://firebase.google.com/docs/hosting/", - "preferred": false - }, - { + "id": "firebasehosting:v1beta1", "kind": "discovery#directoryItem", - "id": "firebasehosting:v1", "name": "firebasehosting", - "version": "v1", + "preferred": false, "title": "Firebase Hosting API", + "version": "v1beta1" + }, + { "description": "The Firebase Hosting REST API enables programmatic and customizable management and deployments to your Firebase-hosted sites. Use this REST API to create and manage channels and sites as well as to deploy new or updated hosting configurations and content files.", "discoveryRestUrl": "https://firebasehosting.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/hosting/", "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://firebase.google.com/docs/hosting/", - "preferred": true + "id": "firebasehosting:v1", + "kind": "discovery#directoryItem", + "name": "firebasehosting", + "preferred": true, + "title": "Firebase Hosting API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebaseml:v1beta2", - "name": "firebaseml", - "version": "v1beta2", - "title": "Firebase ML API", "description": "Access custom machine learning models hosted via Firebase ML.", "discoveryRestUrl": "https://firebaseml.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://firebase.google.com", "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://firebase.google.com", - "preferred": false - }, - { + "id": "firebaseml:v1beta2", "kind": "discovery#directoryItem", - "id": "firebaseml:v2beta", "name": "firebaseml", - "version": "v2beta", + "preferred": false, "title": "Firebase ML API", + "version": "v1beta2" + }, + { "description": "Access custom machine learning models hosted via Firebase ML.", "discoveryRestUrl": "https://firebaseml.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://firebase.google.com", "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://firebase.google.com", - "preferred": false - }, - { + "id": "firebaseml:v2beta", "kind": "discovery#directoryItem", - "id": "firebaseml:v1", "name": "firebaseml", - "version": "v1", + "preferred": false, "title": "Firebase ML API", + "version": "v2beta" + }, + { "description": "Access custom machine learning models hosted via Firebase ML.", "discoveryRestUrl": "https://firebaseml.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com", "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://firebase.google.com", - "preferred": true + "id": "firebaseml:v1", + "kind": "discovery#directoryItem", + "name": "firebaseml", + "preferred": true, + "title": "Firebase ML API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebaserules:v1", - "name": "firebaserules", - "version": "v1", - "title": "Firebase Rules API", "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.", "discoveryRestUrl": "https://firebaserules.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/storage/security", "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://firebase.google.com/docs/storage/security", - "preferred": true + "id": "firebaserules:v1", + "kind": "discovery#directoryItem", + "name": "firebaserules", + "preferred": true, + "title": "Firebase Rules API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "firebasestorage:v1beta", - "name": "firebasestorage", - "version": "v1beta", - "title": "Cloud Storage for Firebase API", "description": "The Cloud Storage for Firebase API enables programmatic management of Cloud Storage buckets for use in Firebase projects", "discoveryRestUrl": "https://firebasestorage.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://firebase.google.com/docs/storage", "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://firebase.google.com/docs/storage", - "preferred": true + "id": "firebasestorage:v1beta", + "kind": "discovery#directoryItem", + "name": "firebasestorage", + "preferred": true, + "title": "Cloud Storage for Firebase API", + "version": "v1beta" }, { - "kind": "discovery#directoryItem", - "id": "firestore:v1beta1", - "name": "firestore", - "version": "v1beta1", - "title": "Cloud Firestore API", "description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.", "discoveryRestUrl": "https://firestore.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/firestore", "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/firestore", - "preferred": false - }, - { + "id": "firestore:v1beta1", "kind": "discovery#directoryItem", - "id": "firestore:v1beta2", "name": "firestore", - "version": "v1beta2", + "preferred": false, "title": "Cloud Firestore API", + "version": "v1beta1" + }, + { "description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.", "discoveryRestUrl": "https://firestore.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/firestore", "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/firestore", - "preferred": false - }, - { + "id": "firestore:v1beta2", "kind": "discovery#directoryItem", - "id": "firestore:v1", "name": "firestore", - "version": "v1", + "preferred": false, "title": "Cloud Firestore API", + "version": "v1beta2" + }, + { "description": "Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.", "discoveryRestUrl": "https://firestore.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/firestore", "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/firestore", - "preferred": true + "id": "firestore:v1", + "kind": "discovery#directoryItem", + "name": "firestore", + "preferred": true, + "title": "Cloud Firestore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "fitness:v1", - "name": "fitness", - "version": "v1", - "title": "Fitness API", "description": "The Fitness API for managing users' fitness tracking data.", "discoveryRestUrl": "https://fitness.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/fit/rest/v1/get-started", "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://developers.google.com/fit/rest/v1/get-started", - "preferred": true + "id": "fitness:v1", + "kind": "discovery#directoryItem", + "name": "fitness", + "preferred": true, + "title": "Fitness API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "forms:v1", - "name": "forms", - "version": "v1", - "title": "Google Forms API", "description": "Reads and writes Google Forms and responses.", "discoveryRestUrl": "https://forms.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/forms/api", "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://developers.google.com/forms/api", - "preferred": true + "id": "forms:v1", + "kind": "discovery#directoryItem", + "name": "forms", + "preferred": true, + "title": "Google Forms API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "games:v1", - "name": "games", - "version": "v1", - "title": "Google Play Game Services", "description": "The Google Play games service allows developers to enhance games with social leaderboards, achievements, game state, sign-in with Google, and more.", "discoveryRestUrl": "https://games.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/games/", "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://developers.google.com/games/", - "preferred": true + "id": "games:v1", + "kind": "discovery#directoryItem", + "name": "games", + "preferred": true, + "title": "Google Play Game Services", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gamesConfiguration:v1configuration", - "name": "gamesConfiguration", - "version": "v1configuration", - "title": "Google Play Game Services Publishing API", "description": "The Google Play Game Services Publishing API allows developers to configure their games in Game Services.", "discoveryRestUrl": "https://gamesconfiguration.googleapis.com/$discovery/rest?version=v1configuration", + "documentationLink": "https://developers.google.com/games/", "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://developers.google.com/games/", - "preferred": true + "id": "gamesConfiguration:v1configuration", + "kind": "discovery#directoryItem", + "name": "gamesConfiguration", + "preferred": true, + "title": "Google Play Game Services Publishing API", + "version": "v1configuration" }, { - "kind": "discovery#directoryItem", - "id": "gamesManagement:v1management", - "name": "gamesManagement", - "version": "v1management", - "title": "Google Play Game Management", "description": "The Google Play Game Management API allows developers to manage resources from the Google Play Game service.", "discoveryRestUrl": "https://gamesmanagement.googleapis.com/$discovery/rest?version=v1management", + "documentationLink": "https://developers.google.com/games/", "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://developers.google.com/games/", - "preferred": true + "id": "gamesManagement:v1management", + "kind": "discovery#directoryItem", + "name": "gamesManagement", + "preferred": true, + "title": "Google Play Game Management", + "version": "v1management" }, { - "kind": "discovery#directoryItem", - "id": "gkebackup:v1", - "name": "gkebackup", - "version": "v1", - "title": "Backup for GKE API", "description": "Backup for GKE is a managed Kubernetes workload backup and restore service for GKE clusters.", "discoveryRestUrl": "https://gkebackup.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke", "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/kubernetes-engine/docs/add-on/backup-for-gke", - "preferred": true + "id": "gkebackup:v1", + "kind": "discovery#directoryItem", + "name": "gkebackup", + "preferred": true, + "title": "Backup for GKE API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gkehub:v1alpha", - "name": "gkehub", - "version": "v1alpha", - "title": "GKE Hub API", "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "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/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v1alpha", "kind": "discovery#directoryItem", - "id": "gkehub:v2alpha", "name": "gkehub", - "version": "v2alpha", + "preferred": false, "title": "GKE Hub API", + "version": "v1alpha" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v2alpha", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "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/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v2alpha", "kind": "discovery#directoryItem", - "id": "gkehub:v1beta", "name": "gkehub", - "version": "v1beta", + "preferred": false, "title": "GKE Hub API", + "version": "v2alpha" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "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/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false - }, - { + "id": "gkehub:v1beta", "kind": "discovery#directoryItem", - "id": "gkehub:v1beta1", "name": "gkehub", - "version": "v1beta1", + "preferred": false, "title": "GKE Hub API", + "version": "v1beta" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "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/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": false + "id": "gkehub:v1beta1", + "kind": "discovery#directoryItem", + "name": "gkehub", + "preferred": false, + "title": "GKE Hub API", + "version": "v1beta1" }, { + "description": "", + "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", + "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" + }, + "id": "gkehub:v2beta", "kind": "discovery#directoryItem", - "id": "gkehub:v1", "name": "gkehub", - "version": "v1", + "preferred": false, "title": "GKE Hub API", + "version": "v2beta" + }, + { "description": "", "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", "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/anthos/multicluster-management/connect/registering-a-cluster", - "preferred": true + "id": "gkehub:v1", + "kind": "discovery#directoryItem", + "name": "gkehub", + "preferred": false, + "title": "GKE Hub API", + "version": "v1" }, { + "description": "", + "discoveryRestUrl": "https://gkehub.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster", + "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" + }, + "id": "gkehub:v2", "kind": "discovery#directoryItem", - "id": "gkeonprem:v1", - "name": "gkeonprem", - "version": "v1", - "title": "GDC Virtual API", + "name": "gkehub", + "preferred": true, + "title": "GKE Hub API", + "version": "v2" + }, + { "description": "", "discoveryRestUrl": "https://gkeonprem.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/anthos/clusters/docs/on-prem/", "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/anthos/clusters/docs/on-prem/", - "preferred": true + "id": "gkeonprem:v1", + "kind": "discovery#directoryItem", + "name": "gkeonprem", + "preferred": true, + "title": "GDC Virtual API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gmail:v1", - "name": "gmail", - "version": "v1", - "title": "Gmail API", "description": "The Gmail API lets you view and manage Gmail mailbox data like threads, messages, and labels.", "discoveryRestUrl": "https://gmail.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/gmail/api/", "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://developers.google.com/gmail/api/", - "preferred": true + "id": "gmail:v1", + "kind": "discovery#directoryItem", + "name": "gmail", + "preferred": true, + "title": "Gmail API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "gmailpostmastertools:v1beta1", - "name": "gmailpostmastertools", - "version": "v1beta1", - "title": "Gmail Postmaster Tools API", "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryRestUrl": "https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://developers.google.com/gmail/postmaster", "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://developers.google.com/gmail/postmaster", - "preferred": false - }, - { + "id": "gmailpostmastertools:v1beta1", "kind": "discovery#directoryItem", - "id": "gmailpostmastertools:v1", "name": "gmailpostmastertools", - "version": "v1", + "preferred": false, "title": "Gmail Postmaster Tools API", + "version": "v1beta1" + }, + { "description": "The Postmaster Tools API is a RESTful API that provides programmatic access to email traffic metrics (like spam reports, delivery errors etc) otherwise available through the Gmail Postmaster Tools UI currently.", "discoveryRestUrl": "https://gmailpostmastertools.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/gmail/postmaster", "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://developers.google.com/gmail/postmaster", - "preferred": true - }, - { + "id": "gmailpostmastertools:v1", "kind": "discovery#directoryItem", - "id": "groupsmigration:v1", - "name": "groupsmigration", - "version": "v1", - "title": "Groups Migration API", + "name": "gmailpostmastertools", + "preferred": true, + "title": "Gmail Postmaster Tools API", + "version": "v1" + }, + { "description": "The Groups Migration API allows domain administrators to archive emails into Google groups.", "discoveryRestUrl": "https://groupsmigration.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/google-apps/groups-migration/", "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://developers.google.com/google-apps/groups-migration/", - "preferred": true + "id": "groupsmigration:v1", + "kind": "discovery#directoryItem", + "name": "groupsmigration", + "preferred": true, + "title": "Groups Migration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "groupssettings:v1", - "name": "groupssettings", - "version": "v1", - "title": "Groups Settings API", "description": "The Groups Settings API allows domain administrators to view and manage access levels and advanced settings for a group.", "discoveryRestUrl": "https://groupssettings.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/admin-sdk/groups-settings", "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://developers.google.com/admin-sdk/groups-settings", - "preferred": true + "id": "groupssettings:v1", + "kind": "discovery#directoryItem", + "name": "groupssettings", + "preferred": true, + "title": "Groups Settings API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "healthcare:v1beta1", - "name": "healthcare", - "version": "v1beta1", - "title": "Cloud Healthcare API", "description": "Manage, store, and access healthcare data in Google Cloud Platform.", "discoveryRestUrl": "https://healthcare.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/healthcare", "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/healthcare", - "preferred": false - }, - { + "id": "healthcare:v1beta1", "kind": "discovery#directoryItem", - "id": "healthcare:v1", "name": "healthcare", - "version": "v1", + "preferred": false, "title": "Cloud Healthcare API", + "version": "v1beta1" + }, + { "description": "Manage, store, and access healthcare data in Google Cloud Platform.", "discoveryRestUrl": "https://healthcare.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/healthcare", "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/healthcare", - "preferred": true + "id": "healthcare:v1", + "kind": "discovery#directoryItem", + "name": "healthcare", + "preferred": true, + "title": "Cloud Healthcare API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "homegraph:v1", - "name": "homegraph", - "version": "v1", - "title": "HomeGraph API", "description": "", "discoveryRestUrl": "https://homegraph.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.home.google.com/cloud-to-cloud/get-started", "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://developers.home.google.com/cloud-to-cloud/get-started", - "preferred": true + "id": "homegraph:v1", + "kind": "discovery#directoryItem", + "name": "homegraph", + "preferred": true, + "title": "HomeGraph API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "iam:v2beta", - "name": "iam", - "version": "v2beta", - "title": "Identity and Access Management (IAM) API", "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.", "discoveryRestUrl": "https://iam.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/iam/", "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/iam/", - "preferred": false - }, - { + "id": "iam:v2beta", "kind": "discovery#directoryItem", - "id": "iam:v1", "name": "iam", - "version": "v1", + "preferred": false, "title": "Identity and Access Management (IAM) API", + "version": "v2beta" + }, + { "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.", "discoveryRestUrl": "https://iam.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/", "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/iam/", - "preferred": false - }, - { + "id": "iam:v1", "kind": "discovery#directoryItem", - "id": "iam:v2", "name": "iam", - "version": "v2", + "preferred": false, "title": "Identity and Access Management (IAM) API", + "version": "v1" + }, + { "description": "Manages identity and access control for Google Cloud resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls. Enabling this API also enables the IAM Service Account Credentials API (iamcredentials.googleapis.com). However, disabling this API doesn't disable the IAM Service Account Credentials API.", "discoveryRestUrl": "https://iam.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/iam/", "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/iam/", - "preferred": true + "id": "iam:v2", + "kind": "discovery#directoryItem", + "name": "iam", + "preferred": true, + "title": "Identity and Access Management (IAM) API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "iamcredentials:v1", - "name": "iamcredentials", - "version": "v1", - "title": "IAM Service Account Credentials API", "description": "Creates short-lived credentials for impersonating IAM service accounts. Disabling this API also disables the IAM API (iam.googleapis.com). However, enabling this API doesn't enable the IAM API.", "discoveryRestUrl": "https://iamcredentials.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials", "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/iam/docs/creating-short-lived-service-account-credentials", - "preferred": true + "id": "iamcredentials:v1", + "kind": "discovery#directoryItem", + "name": "iamcredentials", + "preferred": true, + "title": "IAM Service Account Credentials API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "iap:v1beta1", - "name": "iap", - "version": "v1beta1", - "title": "Cloud Identity-Aware Proxy API", "description": "Controls access to cloud applications running on Google Cloud Platform.", "discoveryRestUrl": "https://iap.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/iap", "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/iap", - "preferred": false - }, - { + "id": "iap:v1beta1", "kind": "discovery#directoryItem", - "id": "iap:v1", "name": "iap", - "version": "v1", + "preferred": false, "title": "Cloud Identity-Aware Proxy API", + "version": "v1beta1" + }, + { "description": "Controls access to cloud applications running on Google Cloud Platform.", "discoveryRestUrl": "https://iap.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iap", "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/iap", - "preferred": true + "id": "iap:v1", + "kind": "discovery#directoryItem", + "name": "iap", + "preferred": true, + "title": "Cloud Identity-Aware Proxy API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "identitytoolkit:v1", - "name": "identitytoolkit", - "version": "v1", - "title": "Identity Toolkit API", "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryRestUrl": "https://identitytoolkit.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/identity-platform", "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/identity-platform", - "preferred": false - }, - { + "id": "identitytoolkit:v1", "kind": "discovery#directoryItem", - "id": "identitytoolkit:v2", "name": "identitytoolkit", - "version": "v2", + "preferred": false, "title": "Identity Toolkit API", + "version": "v1" + }, + { "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryRestUrl": "https://identitytoolkit.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/identity-platform", "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/identity-platform", - "preferred": false - }, - { + "id": "identitytoolkit:v2", "kind": "discovery#directoryItem", - "id": "identitytoolkit:v3", "name": "identitytoolkit", - "version": "v3", + "preferred": false, "title": "Identity Toolkit API", + "version": "v2" + }, + { "description": "The Google Identity Toolkit API lets you use open standards to verify a user's identity.", "discoveryRestUrl": "https://identitytoolkit.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/identity-platform", "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/identity-platform", - "preferred": true + "id": "identitytoolkit:v3", + "kind": "discovery#directoryItem", + "name": "identitytoolkit", + "preferred": true, + "title": "Identity Toolkit API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "ids:v1", - "name": "ids", - "version": "v1", - "title": "Cloud IDS API", "description": "Cloud IDS (Cloud Intrusion Detection System) detects malware, spyware, command-and-control attacks, and other network-based threats. Its security efficacy is industry leading, built with Palo Alto Networks technologies. When you use this product, your organization name and consumption levels will be shared with Palo Alto Networks.", "discoveryRestUrl": "https://ids.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": true + "id": "ids:v1", + "kind": "discovery#directoryItem", + "name": "ids", + "preferred": true, + "title": "Cloud IDS API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "indexing:v3", - "name": "indexing", - "version": "v3", - "title": "Web Search Indexing API", "description": "Notifies Google Web Search when your web pages change.", "discoveryRestUrl": "https://indexing.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/search/apis/indexing-api/", "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://developers.google.com/search/apis/indexing-api/", - "preferred": true + "id": "indexing:v3", + "kind": "discovery#directoryItem", + "name": "indexing", + "preferred": true, + "title": "Web Search Indexing API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "integrations:v1", - "name": "integrations", - "version": "v1", - "title": "Application Integration API", "description": "", "discoveryRestUrl": "https://integrations.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/application-integration", "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/application-integration", - "preferred": true + "id": "integrations:v1", + "kind": "discovery#directoryItem", + "name": "integrations", + "preferred": true, + "title": "Application Integration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "jobs:v3p1beta1", - "name": "jobs", - "version": "v3p1beta1", - "title": "Cloud Talent Solution API", "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "discoveryRestUrl": "https://jobs.googleapis.com/$discovery/rest?version=v3p1beta1", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "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/talent-solution/job-search/docs/", - "preferred": false - }, - { + "id": "jobs:v3p1beta1", "kind": "discovery#directoryItem", - "id": "jobs:v3", "name": "jobs", - "version": "v3", + "preferred": false, "title": "Cloud Talent Solution API", + "version": "v3p1beta1" + }, + { "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "discoveryRestUrl": "https://jobs.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "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/talent-solution/job-search/docs/", - "preferred": false - }, - { + "id": "jobs:v3", "kind": "discovery#directoryItem", - "id": "jobs:v4", "name": "jobs", - "version": "v4", + "preferred": false, "title": "Cloud Talent Solution API", + "version": "v3" + }, + { "description": "Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.", "discoveryRestUrl": "https://jobs.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://cloud.google.com/talent-solution/job-search/docs/", "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/talent-solution/job-search/docs/", - "preferred": true + "id": "jobs:v4", + "kind": "discovery#directoryItem", + "name": "jobs", + "preferred": true, + "title": "Cloud Talent Solution API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "keep:v1", - "name": "keep", - "version": "v1", - "title": "Google Keep API", "description": "The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software.", "discoveryRestUrl": "https://keep.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/keep/api", "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://developers.google.com/keep/api", - "preferred": true + "id": "keep:v1", + "kind": "discovery#directoryItem", + "name": "keep", + "preferred": true, + "title": "Google Keep API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "kgsearch:v1", - "name": "kgsearch", - "version": "v1", - "title": "Knowledge Graph Search API", "description": "Searches the Google Knowledge Graph for entities.", "discoveryRestUrl": "https://kgsearch.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/knowledge-graph/", "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://developers.google.com/knowledge-graph/", - "preferred": true + "id": "kgsearch:v1", + "kind": "discovery#directoryItem", + "name": "kgsearch", + "preferred": true, + "title": "Knowledge Graph Search API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "kmsinventory:v1", - "name": "kmsinventory", - "version": "v1", - "title": "KMS Inventory API", "description": "", "discoveryRestUrl": "https://kmsinventory.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/kms/", "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/kms/", - "preferred": true + "id": "kmsinventory:v1", + "kind": "discovery#directoryItem", + "name": "kmsinventory", + "preferred": true, + "title": "KMS Inventory API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "language:v1beta2", - "name": "language", - "version": "v1beta2", - "title": "Cloud Natural Language API", "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", "discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/natural-language/", "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/natural-language/", - "preferred": false - }, - { + "id": "language:v1beta2", "kind": "discovery#directoryItem", - "id": "language:v1", "name": "language", - "version": "v1", + "preferred": false, "title": "Cloud Natural Language API", + "version": "v1beta2" + }, + { "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", "discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/natural-language/", "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/natural-language/", - "preferred": false - }, - { + "id": "language:v1", "kind": "discovery#directoryItem", - "id": "language:v2", "name": "language", - "version": "v2", + "preferred": false, "title": "Cloud Natural Language API", + "version": "v1" + }, + { "description": "Provides natural language understanding technologies, such as sentiment analysis, entity recognition, entity sentiment analysis, and other text annotations, to developers.", "discoveryRestUrl": "https://language.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/natural-language/", "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/natural-language/", - "preferred": true + "id": "language:v2", + "kind": "discovery#directoryItem", + "name": "language", + "preferred": true, + "title": "Cloud Natural Language API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "libraryagent:v1", - "name": "libraryagent", - "version": "v1", - "title": "Library Agent API", "description": "A simple Google Example Library API.", "discoveryRestUrl": "https://libraryagent.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/docs/quota", "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/docs/quota", - "preferred": true + "id": "libraryagent:v1", + "kind": "discovery#directoryItem", + "name": "libraryagent", + "preferred": true, + "title": "Library Agent API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "licensing:v1", - "name": "licensing", - "version": "v1", - "title": "Enterprise License Manager API", "description": "The Google Enterprise License Manager API lets you manage Google Workspace and related licenses for all users of a customer that you manage.", "discoveryRestUrl": "https://licensing.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/admin-sdk/licensing/", "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://developers.google.com/admin-sdk/licensing/", - "preferred": true + "id": "licensing:v1", + "kind": "discovery#directoryItem", + "name": "licensing", + "preferred": true, + "title": "Enterprise License Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "lifesciences:v2beta", - "name": "lifesciences", - "version": "v2beta", - "title": "Cloud Life Sciences API", "description": "Cloud Life Sciences is a suite of services and tools for managing, processing, and transforming life sciences data.", "discoveryRestUrl": "https://lifesciences.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/life-sciences", "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/life-sciences", - "preferred": true + "id": "lifesciences:v2beta", + "kind": "discovery#directoryItem", + "name": "lifesciences", + "preferred": true, + "title": "Cloud Life Sciences API", + "version": "v2beta" }, { - "kind": "discovery#directoryItem", - "id": "localservices:v1", - "name": "localservices", - "version": "v1", - "title": "Local Services API", "description": "", "discoveryRestUrl": "https://localservices.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://ads.google.com/local-services-ads/", "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://ads.google.com/local-services-ads/", - "preferred": true + "id": "localservices:v1", + "kind": "discovery#directoryItem", + "name": "localservices", + "preferred": true, + "title": "Local Services API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "logging:v2", - "name": "logging", - "version": "v2", - "title": "Cloud Logging API", "description": "Writes log entries and manages your Cloud Logging configuration.", "discoveryRestUrl": "https://logging.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/logging/docs/", "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/logging/docs/", - "preferred": true + "id": "logging:v2", + "kind": "discovery#directoryItem", + "name": "logging", + "preferred": true, + "title": "Cloud Logging API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "looker:v1", - "name": "looker", - "version": "v1", - "title": "Looker (Google Cloud core) API", "description": "", "discoveryRestUrl": "https://looker.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/looker/docs/reference/rest/", "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/looker/docs/reference/rest/", - "preferred": true + "id": "looker:v1", + "kind": "discovery#directoryItem", + "name": "looker", + "preferred": true, + "title": "Looker (Google Cloud core) API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "managedidentities:v1alpha1", - "name": "managedidentities", - "version": "v1alpha1", - "title": "Managed Service for Microsoft Active Directory API", "description": "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD).", "discoveryRestUrl": "https://managedidentities.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", "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/managed-microsoft-ad/", - "preferred": false - }, - { + "id": "managedidentities:v1alpha1", "kind": "discovery#directoryItem", - "id": "managedidentities:v1beta1", "name": "managedidentities", - "version": "v1beta1", + "preferred": false, "title": "Managed Service for Microsoft Active Directory API", + "version": "v1alpha1" + }, + { "description": "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD).", "discoveryRestUrl": "https://managedidentities.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", "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/managed-microsoft-ad/", - "preferred": false - }, - { + "id": "managedidentities:v1beta1", "kind": "discovery#directoryItem", - "id": "managedidentities:v1", "name": "managedidentities", - "version": "v1", + "preferred": false, "title": "Managed Service for Microsoft Active Directory API", + "version": "v1beta1" + }, + { "description": "The Managed Service for Microsoft Active Directory API is used for managing a highly available, hardened service running Microsoft Active Directory (AD).", "discoveryRestUrl": "https://managedidentities.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/managed-microsoft-ad/", "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/managed-microsoft-ad/", - "preferred": true + "id": "managedidentities:v1", + "kind": "discovery#directoryItem", + "name": "managedidentities", + "preferred": true, + "title": "Managed Service for Microsoft Active Directory API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "manufacturers:v1", - "name": "manufacturers", - "version": "v1", - "title": "Manufacturer Center API", "description": "Public API for managing Manufacturer Center related data.", "discoveryRestUrl": "https://manufacturers.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/manufacturers/", "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://developers.google.com/manufacturers/", - "preferred": true + "id": "manufacturers:v1", + "kind": "discovery#directoryItem", + "name": "manufacturers", + "preferred": true, + "title": "Manufacturer Center API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "marketingplatformadmin:v1alpha", - "name": "marketingplatformadmin", - "version": "v1alpha", - "title": "Google Marketing Platform Admin API", "description": "The Google Marketing Platform Admin API allows for programmatic access to the Google Marketing Platform configuration data. You can use the Google Marketing Platform Admin API to manage links between your Google Marketing Platform organization and Google Analytics accounts, and to set the service level of your GA4 properties.", "discoveryRestUrl": "https://marketingplatformadmin.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://developers.google.com/analytics/devguides/config/gmp/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://developers.google.com/analytics/devguides/config/gmp/v1", - "preferred": true + "id": "marketingplatformadmin:v1alpha", + "kind": "discovery#directoryItem", + "name": "marketingplatformadmin", + "preferred": true, + "title": "Google Marketing Platform Admin API", + "version": "v1alpha" }, { - "kind": "discovery#directoryItem", - "id": "meet:v2", - "name": "meet", - "version": "v2", - "title": "Google Meet API", "description": "Create and manage meetings in Google Meet.", "discoveryRestUrl": "https://meet.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/meet/api", "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://developers.google.com/meet/api", - "preferred": true + "id": "meet:v2", + "kind": "discovery#directoryItem", + "name": "meet", + "preferred": true, + "title": "Google Meet API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "memcache:v1beta2", - "name": "memcache", - "version": "v1beta2", - "title": "Cloud Memorystore for Memcached API", "description": "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.", "discoveryRestUrl": "https://memcache.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/memorystore/", "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/memorystore/", - "preferred": false - }, - { + "id": "memcache:v1beta2", "kind": "discovery#directoryItem", - "id": "memcache:v1", "name": "memcache", - "version": "v1", + "preferred": false, "title": "Cloud Memorystore for Memcached API", + "version": "v1beta2" + }, + { "description": "Google Cloud Memorystore for Memcached API is used for creating and managing Memcached instances in GCP.", "discoveryRestUrl": "https://memcache.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/memorystore/", "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/memorystore/", - "preferred": true + "id": "memcache:v1", + "kind": "discovery#directoryItem", + "name": "memcache", + "preferred": true, + "title": "Cloud Memorystore for Memcached API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "merchantapi:accounts_v1beta", - "name": "merchantapi", - "version": "accounts_v1beta", - "title": "Merchant API", "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=accounts_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:accounts_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:conversions_v1beta", "name": "merchantapi", - "version": "conversions_v1beta", + "preferred": false, "title": "Merchant API", + "version": "accounts_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=conversions_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:conversions_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:datasources_v1beta", "name": "merchantapi", - "version": "datasources_v1beta", + "preferred": false, "title": "Merchant API", + "version": "conversions_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=datasources_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:datasources_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:inventories_v1beta", "name": "merchantapi", - "version": "inventories_v1beta", + "preferred": false, "title": "Merchant API", + "version": "datasources_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=inventories_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:inventories_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:lfp_v1beta", "name": "merchantapi", - "version": "lfp_v1beta", + "preferred": false, "title": "Merchant API", + "version": "inventories_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=lfp_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:lfp_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:notifications_v1beta", "name": "merchantapi", - "version": "notifications_v1beta", + "preferred": false, "title": "Merchant API", + "version": "lfp_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=notifications_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:notifications_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:products_v1beta", "name": "merchantapi", - "version": "products_v1beta", + "preferred": false, "title": "Merchant API", + "version": "notifications_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=products_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:products_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:promotions_v1beta", "name": "merchantapi", - "version": "promotions_v1beta", + "preferred": false, "title": "Merchant API", + "version": "products_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=promotions_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:promotions_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:quota_v1beta", "name": "merchantapi", - "version": "quota_v1beta", + "preferred": false, "title": "Merchant API", + "version": "promotions_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=quota_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": false - }, - { + "id": "merchantapi:quota_v1beta", "kind": "discovery#directoryItem", - "id": "merchantapi:reports_v1beta", "name": "merchantapi", - "version": "reports_v1beta", + "preferred": false, "title": "Merchant API", + "version": "quota_v1beta" + }, + { "description": "Programmatically manage your Merchant Center Accounts.", "discoveryRestUrl": "https://merchantapi.googleapis.com/$discovery/rest?version=reports_v1beta", + "documentationLink": "https://developers.devsite.corp.google.com/merchant/api", "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://developers.devsite.corp.google.com/merchant/api", - "preferred": true + "id": "merchantapi:reports_v1beta", + "kind": "discovery#directoryItem", + "name": "merchantapi", + "preferred": true, + "title": "Merchant API", + "version": "reports_v1beta" }, { - "kind": "discovery#directoryItem", - "id": "metastore:v1alpha", - "name": "metastore", - "version": "v1alpha", - "title": "Dataproc Metastore API", "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "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/dataproc-metastore/docs", - "preferred": false - }, - { + "id": "metastore:v1alpha", "kind": "discovery#directoryItem", - "id": "metastore:v1beta", "name": "metastore", - "version": "v1beta", + "preferred": false, "title": "Dataproc Metastore API", + "version": "v1alpha" + }, + { "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "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/dataproc-metastore/docs", - "preferred": false - }, - { + "id": "metastore:v1beta", "kind": "discovery#directoryItem", - "id": "metastore:v1", "name": "metastore", - "version": "v1", + "preferred": false, "title": "Dataproc Metastore API", + "version": "v1beta" + }, + { "description": "The Dataproc Metastore API is used to manage the lifecycle and configuration of metastore services.", "discoveryRestUrl": "https://metastore.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/dataproc-metastore/docs", "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/dataproc-metastore/docs", - "preferred": true + "id": "metastore:v1", + "kind": "discovery#directoryItem", + "name": "metastore", + "preferred": true, + "title": "Dataproc Metastore API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "migrationcenter:v1alpha1", - "name": "migrationcenter", - "version": "v1alpha1", - "title": "Migration Center API", "description": "A unified platform that helps you accelerate your end-to-end cloud journey from your current on-premises or cloud environments to Google Cloud.", "discoveryRestUrl": "https://migrationcenter.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/migration-center", "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/migration-center", - "preferred": false - }, - { + "id": "migrationcenter:v1alpha1", "kind": "discovery#directoryItem", - "id": "migrationcenter:v1", "name": "migrationcenter", - "version": "v1", + "preferred": false, "title": "Migration Center API", + "version": "v1alpha1" + }, + { "description": "A unified platform that helps you accelerate your end-to-end cloud journey from your current on-premises or cloud environments to Google Cloud.", "discoveryRestUrl": "https://migrationcenter.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/migration-center", "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/migration-center", - "preferred": true + "id": "migrationcenter:v1", + "kind": "discovery#directoryItem", + "name": "migrationcenter", + "preferred": true, + "title": "Migration Center API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "ml:v1", - "name": "ml", - "version": "v1", - "title": "AI Platform Training & Prediction API", "description": "An API to enable creating and using machine learning models.", "discoveryRestUrl": "https://ml.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/ml/", "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/ml/", - "preferred": true + "id": "ml:v1", + "kind": "discovery#directoryItem", + "name": "ml", + "preferred": true, + "title": "AI Platform Training & Prediction API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "monitoring:v1", - "name": "monitoring", - "version": "v1", - "title": "Cloud Monitoring API", "description": "Manages your Cloud Monitoring data and configurations.", "discoveryRestUrl": "https://monitoring.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/monitoring/api/", "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/monitoring/api/", - "preferred": false - }, - { + "id": "monitoring:v1", "kind": "discovery#directoryItem", - "id": "monitoring:v3", "name": "monitoring", - "version": "v3", + "preferred": false, "title": "Cloud Monitoring API", + "version": "v1" + }, + { "description": "Manages your Cloud Monitoring data and configurations.", "discoveryRestUrl": "https://monitoring.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/monitoring/api/", "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/monitoring/api/", - "preferred": true + "id": "monitoring:v3", + "kind": "discovery#directoryItem", + "name": "monitoring", + "preferred": true, + "title": "Cloud Monitoring API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessaccountmanagement:v1", - "name": "mybusinessaccountmanagement", - "version": "v1", - "title": "My Business Account Management API", "description": "The My Business Account Management API provides an interface for managing access to a location on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessaccountmanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessaccountmanagement:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessaccountmanagement", + "preferred": true, + "title": "My Business Account Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessbusinessinformation:v1", - "name": "mybusinessbusinessinformation", - "version": "v1", - "title": "My Business Business Information API", "description": "The My Business Business Information API provides an interface for managing business information. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessbusinessinformation.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessbusinessinformation:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessbusinessinformation", + "preferred": true, + "title": "My Business Business Information API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinesslodging:v1", - "name": "mybusinesslodging", - "version": "v1", - "title": "My Business Lodging API", "description": "The My Business Lodging API enables managing lodging business information on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinesslodging.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinesslodging:v1", + "kind": "discovery#directoryItem", + "name": "mybusinesslodging", + "preferred": true, + "title": "My Business Lodging API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessnotifications:v1", - "name": "mybusinessnotifications", - "version": "v1", - "title": "My Business Notifications API", "description": "The My Business Notification Settings API enables managing notification settings for business accounts. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessnotifications.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessnotifications:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessnotifications", + "preferred": true, + "title": "My Business Notifications API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessplaceactions:v1", - "name": "mybusinessplaceactions", - "version": "v1", - "title": "My Business Place Actions API", "description": "The My Business Place Actions API provides an interface for managing place action links of a location on Google. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessplaceactions.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessplaceactions:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessplaceactions", + "preferred": true, + "title": "My Business Place Actions API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessqanda:v1", - "name": "mybusinessqanda", - "version": "v1", - "title": "My Business Q&A API", "description": "The My Business Q&A API allows questions and answers to be posted for specific listings. Note - If you have a quota of 0 after enabling the API, please request for GBP API access.", "discoveryRestUrl": "https://mybusinessqanda.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessqanda:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessqanda", + "preferred": true, + "title": "My Business Q&A API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "mybusinessverifications:v1", - "name": "mybusinessverifications", - "version": "v1", - "title": "My Business Verifications API", "description": "The My Business Verifications API provides an interface for taking verifications related actions for locations.", "discoveryRestUrl": "https://mybusinessverifications.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/my-business/", "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://developers.google.com/my-business/", - "preferred": true + "id": "mybusinessverifications:v1", + "kind": "discovery#directoryItem", + "name": "mybusinessverifications", + "preferred": true, + "title": "My Business Verifications API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networkconnectivity:v1alpha1", - "name": "networkconnectivity", - "version": "v1alpha1", - "title": "Network Connectivity API", "description": "This API enables connectivity with and between Google Cloud resources.", "discoveryRestUrl": "https://networkconnectivity.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", "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/network-connectivity/docs/reference/networkconnectivity/rest", - "preferred": false - }, - { + "id": "networkconnectivity:v1alpha1", "kind": "discovery#directoryItem", - "id": "networkconnectivity:v1", "name": "networkconnectivity", - "version": "v1", + "preferred": false, "title": "Network Connectivity API", + "version": "v1alpha1" + }, + { "description": "This API enables connectivity with and between Google Cloud resources.", "discoveryRestUrl": "https://networkconnectivity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/network-connectivity/docs/reference/networkconnectivity/rest", "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/network-connectivity/docs/reference/networkconnectivity/rest", - "preferred": true + "id": "networkconnectivity:v1", + "kind": "discovery#directoryItem", + "name": "networkconnectivity", + "preferred": true, + "title": "Network Connectivity API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networkmanagement:v1beta1", - "name": "networkmanagement", - "version": "v1beta1", - "title": "Network Management API", "description": "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.", "discoveryRestUrl": "https://networkmanagement.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": false - }, - { + "id": "networkmanagement:v1beta1", "kind": "discovery#directoryItem", - "id": "networkmanagement:v1", "name": "networkmanagement", - "version": "v1", + "preferred": false, "title": "Network Management API", + "version": "v1beta1" + }, + { "description": "The Network Management API provides a collection of network performance monitoring and diagnostic capabilities.", "discoveryRestUrl": "https://networkmanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": true + "id": "networkmanagement:v1", + "kind": "discovery#directoryItem", + "name": "networkmanagement", + "preferred": true, + "title": "Network Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networksecurity:v1beta1", - "name": "networksecurity", - "version": "v1beta1", - "title": "Network Security API", "description": "", "discoveryRestUrl": "https://networksecurity.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/networking", "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/networking", - "preferred": false - }, - { + "id": "networksecurity:v1beta1", "kind": "discovery#directoryItem", - "id": "networksecurity:v1", "name": "networksecurity", - "version": "v1", + "preferred": false, "title": "Network Security API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://networksecurity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/networking", "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/networking", - "preferred": true + "id": "networksecurity:v1", + "kind": "discovery#directoryItem", + "name": "networksecurity", + "preferred": true, + "title": "Network Security API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "networkservices:v1beta1", - "name": "networkservices", - "version": "v1beta1", - "title": "Network Services API", "description": "", "discoveryRestUrl": "https://networkservices.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/networking", "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/networking", - "preferred": false - }, - { + "id": "networkservices:v1beta1", "kind": "discovery#directoryItem", - "id": "networkservices:v1", "name": "networkservices", - "version": "v1", + "preferred": false, "title": "Network Services API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://networkservices.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/networking", "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/networking", - "preferred": true + "id": "networkservices:v1", + "kind": "discovery#directoryItem", + "name": "networkservices", + "preferred": true, + "title": "Network Services API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "notebooks:v1", - "name": "notebooks", - "version": "v1", - "title": "Notebooks API", "description": "Notebooks API is used to manage notebook resources in Google Cloud.", "discoveryRestUrl": "https://notebooks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/notebooks/docs/", "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/notebooks/docs/", - "preferred": false - }, - { + "id": "notebooks:v1", "kind": "discovery#directoryItem", - "id": "notebooks:v2", "name": "notebooks", - "version": "v2", + "preferred": false, "title": "Notebooks API", + "version": "v1" + }, + { "description": "Notebooks API is used to manage notebook resources in Google Cloud.", "discoveryRestUrl": "https://notebooks.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/notebooks/docs/", "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/notebooks/docs/", - "preferred": true + "id": "notebooks:v2", + "kind": "discovery#directoryItem", + "name": "notebooks", + "preferred": true, + "title": "Notebooks API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "oauth2:v2", - "name": "oauth2", - "version": "v2", - "title": "Google OAuth2 API", "description": "[Deprecated] Obtains end-user authorization grants for use with other Google APIs.", - "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest", "discoveryLink": "./apis/oauth2/v2/rest", + "discoveryRestUrl": "https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest", + "documentationLink": "https://developers.google.com/accounts/docs/OAuth2", "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://developers.google.com/accounts/docs/OAuth2", - "preferred": true + "id": "oauth2:v2", + "kind": "discovery#directoryItem", + "name": "oauth2", + "preferred": true, + "title": "Google OAuth2 API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "ondemandscanning:v1beta1", - "name": "ondemandscanning", - "version": "v1beta1", - "title": "On-Demand Scanning API", "description": "A service to scan container images for vulnerabilities.", "discoveryRestUrl": "https://ondemandscanning.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", "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/container-analysis/docs/on-demand-scanning/", - "preferred": false - }, - { + "id": "ondemandscanning:v1beta1", "kind": "discovery#directoryItem", - "id": "ondemandscanning:v1", "name": "ondemandscanning", - "version": "v1", + "preferred": false, "title": "On-Demand Scanning API", + "version": "v1beta1" + }, + { "description": "A service to scan container images for vulnerabilities.", "discoveryRestUrl": "https://ondemandscanning.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/container-analysis/docs/on-demand-scanning/", "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/container-analysis/docs/on-demand-scanning/", - "preferred": true + "id": "ondemandscanning:v1", + "kind": "discovery#directoryItem", + "name": "ondemandscanning", + "preferred": true, + "title": "On-Demand Scanning API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "orgpolicy:v2", - "name": "orgpolicy", - "version": "v2", - "title": "Organization Policy API", "description": "The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy.", "discoveryRestUrl": "https://orgpolicy.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/orgpolicy/docs/reference/rest/index.html", "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/orgpolicy/docs/reference/rest/index.html", - "preferred": true + "id": "orgpolicy:v2", + "kind": "discovery#directoryItem", + "name": "orgpolicy", + "preferred": true, + "title": "Organization Policy API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "osconfig:v1alpha", - "name": "osconfig", - "version": "v1alpha", - "title": "OS Config API", "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "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/compute/docs/osconfig/rest", - "preferred": false - }, - { + "id": "osconfig:v1alpha", "kind": "discovery#directoryItem", - "id": "osconfig:v1beta", "name": "osconfig", - "version": "v1beta", + "preferred": false, "title": "OS Config API", + "version": "v1alpha" + }, + { "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "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/compute/docs/osconfig/rest", - "preferred": false - }, - { + "id": "osconfig:v1beta", "kind": "discovery#directoryItem", - "id": "osconfig:v1", "name": "osconfig", - "version": "v1", + "preferred": false, "title": "OS Config API", + "version": "v1beta" + }, + { "description": "OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.", "discoveryRestUrl": "https://osconfig.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/compute/docs/osconfig/rest", "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/compute/docs/osconfig/rest", - "preferred": true + "id": "osconfig:v1", + "kind": "discovery#directoryItem", + "name": "osconfig", + "preferred": true, + "title": "OS Config API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "oslogin:v1alpha", - "name": "oslogin", - "version": "v1alpha", - "title": "Cloud OS Login API", "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", "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/compute/docs/oslogin/", - "preferred": false - }, - { + "id": "oslogin:v1alpha", "kind": "discovery#directoryItem", - "id": "oslogin:v1beta", "name": "oslogin", - "version": "v1beta", + "preferred": false, "title": "Cloud OS Login API", + "version": "v1alpha" + }, + { "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", "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/compute/docs/oslogin/", - "preferred": false - }, - { + }, + "id": "oslogin:v1beta", "kind": "discovery#directoryItem", - "id": "oslogin:v1", "name": "oslogin", - "version": "v1", + "preferred": false, "title": "Cloud OS Login API", + "version": "v1beta" + }, + { "description": "You can use OS Login to manage access to your VM instances using IAM roles.", "discoveryRestUrl": "https://oslogin.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/", "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/compute/docs/oslogin/", - "preferred": true + "id": "oslogin:v1", + "kind": "discovery#directoryItem", + "name": "oslogin", + "preferred": true, + "title": "Cloud OS Login API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pagespeedonline:v5", - "name": "pagespeedonline", - "version": "v5", - "title": "PageSpeed Insights API", "description": "The PageSpeed Insights API lets you analyze the performance of your website with a simple API. It offers tailored suggestions for how you can optimize your site, and lets you easily integrate PageSpeed Insights analysis into your development tools and workflow.", "discoveryRestUrl": "https://pagespeedonline.googleapis.com/$discovery/rest?version=v5", + "documentationLink": "https://developers.google.com/speed/docs/insights/v5/about", "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://developers.google.com/speed/docs/insights/v5/about", - "preferred": true + "id": "pagespeedonline:v5", + "kind": "discovery#directoryItem", + "name": "pagespeedonline", + "preferred": true, + "title": "PageSpeed Insights API", + "version": "v5" }, { - "kind": "discovery#directoryItem", - "id": "paymentsresellersubscription:v1", - "name": "paymentsresellersubscription", - "version": "v1", - "title": "Payments Reseller Subscription API", "description": "", "discoveryRestUrl": "https://paymentsresellersubscription.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/payments/reseller/subscription/", "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://developers.google.com/payments/reseller/subscription/", - "preferred": true + "id": "paymentsresellersubscription:v1", + "kind": "discovery#directoryItem", + "name": "paymentsresellersubscription", + "preferred": true, + "title": "Payments Reseller Subscription API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "people:v1", - "name": "people", - "version": "v1", - "title": "People API", "description": "Provides access to information about profiles and contacts.", "discoveryRestUrl": "https://people.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/people/", "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://developers.google.com/people/", - "preferred": true + "id": "people:v1", + "kind": "discovery#directoryItem", + "name": "people", + "preferred": true, + "title": "People API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "places:v1", - "name": "places", - "version": "v1", - "title": "Places API (New)", "description": "", "discoveryRestUrl": "https://places.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://mapsplatform.google.com/maps-products/#places-section", "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://mapsplatform.google.com/maps-products/#places-section", - "preferred": true + "id": "places:v1", + "kind": "discovery#directoryItem", + "name": "places", + "preferred": true, + "title": "Places API (New)", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "playcustomapp:v1", - "name": "playcustomapp", - "version": "v1", - "title": "Google Play Custom App Publishing API", "description": "API to create and publish custom Android apps", "discoveryRestUrl": "https://playcustomapp.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/android/work/play/custom-app-api/", "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://developers.google.com/android/work/play/custom-app-api/", - "preferred": true + "id": "playcustomapp:v1", + "kind": "discovery#directoryItem", + "name": "playcustomapp", + "preferred": true, + "title": "Google Play Custom App Publishing API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "playdeveloperreporting:v1alpha1", - "name": "playdeveloperreporting", - "version": "v1alpha1", - "title": "Google Play Developer Reporting API", "description": "", "discoveryRestUrl": "https://playdeveloperreporting.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/play/developer/reporting", "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://developers.google.com/play/developer/reporting", - "preferred": false - }, - { + "id": "playdeveloperreporting:v1alpha1", "kind": "discovery#directoryItem", - "id": "playdeveloperreporting:v1beta1", "name": "playdeveloperreporting", - "version": "v1beta1", + "preferred": false, "title": "Google Play Developer Reporting API", + "version": "v1alpha1" + }, + { "description": "", "discoveryRestUrl": "https://playdeveloperreporting.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://developers.google.com/play/developer/reporting", "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://developers.google.com/play/developer/reporting", - "preferred": true + "id": "playdeveloperreporting:v1beta1", + "kind": "discovery#directoryItem", + "name": "playdeveloperreporting", + "preferred": true, + "title": "Google Play Developer Reporting API", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "playgrouping:v1alpha1", - "name": "playgrouping", - "version": "v1alpha1", - "title": "Google Play Grouping API", "description": "playgrouping.googleapis.com API.", "discoveryRestUrl": "https://playgrouping.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/playgrouping/", "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/playgrouping/", - "preferred": true + "id": "playgrouping:v1alpha1", + "kind": "discovery#directoryItem", + "name": "playgrouping", + "preferred": true, + "title": "Google Play Grouping API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "playintegrity:v1", - "name": "playintegrity", - "version": "v1", - "title": "Google Play Integrity API", "description": "The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.", "discoveryRestUrl": "https://playintegrity.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developer.android.com/google/play/integrity", "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://developer.android.com/google/play/integrity", - "preferred": true + "id": "playintegrity:v1", + "kind": "discovery#directoryItem", + "name": "playintegrity", + "preferred": true, + "title": "Google Play Integrity API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "policyanalyzer:v1beta1", - "name": "policyanalyzer", - "version": "v1beta1", - "title": "Policy Analyzer API", "description": "", "discoveryRestUrl": "https://policyanalyzer.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://www.google.com", "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://www.google.com", - "preferred": false - }, - { + "id": "policyanalyzer:v1beta1", "kind": "discovery#directoryItem", - "id": "policyanalyzer:v1", "name": "policyanalyzer", - "version": "v1", + "preferred": false, "title": "Policy Analyzer API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://policyanalyzer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://www.google.com", "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://www.google.com", - "preferred": true + "id": "policyanalyzer:v1", + "kind": "discovery#directoryItem", + "name": "policyanalyzer", + "preferred": true, + "title": "Policy Analyzer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "policysimulator:v1alpha", - "name": "policysimulator", - "version": "v1alpha", - "title": "Policy Simulator API", "description": "Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.Replay]. A `Replay` is a type of simulation that lets you see how your members' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members' access might change under the proposed policy.", "discoveryRestUrl": "https://policysimulator.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", "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/iam/docs/simulating-access", - "preferred": false - }, - { + "id": "policysimulator:v1alpha", "kind": "discovery#directoryItem", - "id": "policysimulator:v1beta", "name": "policysimulator", - "version": "v1beta", + "preferred": false, "title": "Policy Simulator API", + "version": "v1alpha" + }, + { "description": "Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.Replay]. A `Replay` is a type of simulation that lets you see how your members' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members' access might change under the proposed policy.", "discoveryRestUrl": "https://policysimulator.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", "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/iam/docs/simulating-access", - "preferred": false - }, - { + "id": "policysimulator:v1beta", "kind": "discovery#directoryItem", - "id": "policysimulator:v1", "name": "policysimulator", - "version": "v1", + "preferred": false, "title": "Policy Simulator API", + "version": "v1beta" + }, + { "description": "Policy Simulator is a collection of endpoints for creating, running, and viewing a [Replay][google.cloud.policysimulator.v1.Replay]. A `Replay` is a type of simulation that lets you see how your members' access to resources might change if you changed your IAM policy. During a `Replay`, Policy Simulator re-evaluates, or replays, past access attempts under both the current policy and your proposed policy, and compares those results to determine how your members' access might change under the proposed policy.", "discoveryRestUrl": "https://policysimulator.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/docs/simulating-access", "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/iam/docs/simulating-access", - "preferred": true + "id": "policysimulator:v1", + "kind": "discovery#directoryItem", + "name": "policysimulator", + "preferred": true, + "title": "Policy Simulator API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "policytroubleshooter:v1beta", - "name": "policytroubleshooter", - "version": "v1beta", - "title": "Policy Troubleshooter API", "description": "", "discoveryRestUrl": "https://policytroubleshooter.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/iam/", "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/iam/", - "preferred": false - }, - { + "id": "policytroubleshooter:v1beta", "kind": "discovery#directoryItem", - "id": "policytroubleshooter:v1", "name": "policytroubleshooter", - "version": "v1", + "preferred": false, "title": "Policy Troubleshooter API", + "version": "v1beta" + }, + { "description": "", "discoveryRestUrl": "https://policytroubleshooter.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/iam/", "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/iam/", - "preferred": true + "id": "policytroubleshooter:v1", + "kind": "discovery#directoryItem", + "name": "policytroubleshooter", + "preferred": true, + "title": "Policy Troubleshooter API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pollen:v1", - "name": "pollen", - "version": "v1", - "title": "Pollen API", "description": "The Pollen API.", "discoveryRestUrl": "https://pollen.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/pollen", "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://developers.google.com/maps/documentation/pollen", - "preferred": true + "id": "pollen:v1", + "kind": "discovery#directoryItem", + "name": "pollen", + "preferred": true, + "title": "Pollen API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "poly:v1", - "name": "poly", - "version": "v1", - "title": "Poly API", "description": "The Poly API provides read access to assets hosted on poly.google.com to all, and upload access to poly.google.com for whitelisted accounts.", "discoveryRestUrl": "https://poly.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/poly/", "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://developers.google.com/poly/", - "preferred": true + "id": "poly:v1", + "kind": "discovery#directoryItem", + "name": "poly", + "preferred": true, + "title": "Poly API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "privateca:v1beta1", - "name": "privateca", - "version": "v1beta1", - "title": "Certificate Authority API", "description": "The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.", "discoveryRestUrl": "https://privateca.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": false - }, - { + "id": "privateca:v1beta1", "kind": "discovery#directoryItem", - "id": "privateca:v1", "name": "privateca", - "version": "v1", + "preferred": false, "title": "Certificate Authority API", + "version": "v1beta1" + }, + { "description": "The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.", "discoveryRestUrl": "https://privateca.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/", "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/", - "preferred": true + "id": "privateca:v1", + "kind": "discovery#directoryItem", + "name": "privateca", + "preferred": true, + "title": "Certificate Authority API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "prod_tt_sasportal:v1alpha1", - "name": "prod_tt_sasportal", - "version": "v1alpha1", - "title": "SAS Portal API (Testing)", "description": "", "discoveryRestUrl": "https://prod-tt-sasportal.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/spectrum-access-system/", "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://developers.google.com/spectrum-access-system/", - "preferred": true + "id": "prod_tt_sasportal:v1alpha1", + "kind": "discovery#directoryItem", + "name": "prod_tt_sasportal", + "preferred": true, + "title": "SAS Portal API (Testing)", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "publicca:v1alpha1", - "name": "publicca", - "version": "v1alpha1", - "title": "Public Certificate Authority API", "description": "The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.", "discoveryRestUrl": "https://publicca.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", "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/public-certificate-authority/docs", - "preferred": false - }, - { + "id": "publicca:v1alpha1", "kind": "discovery#directoryItem", - "id": "publicca:v1beta1", "name": "publicca", - "version": "v1beta1", + "preferred": false, "title": "Public Certificate Authority API", + "version": "v1alpha1" + }, + { "description": "The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.", "discoveryRestUrl": "https://publicca.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", "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/public-certificate-authority/docs", - "preferred": false - }, - { + "id": "publicca:v1beta1", "kind": "discovery#directoryItem", - "id": "publicca:v1", "name": "publicca", - "version": "v1", + "preferred": false, "title": "Public Certificate Authority API", + "version": "v1beta1" + }, + { "description": "The Public Certificate Authority API may be used to create and manage ACME external account binding keys associated with Google Trust Services' publicly trusted certificate authority.", "discoveryRestUrl": "https://publicca.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/public-certificate-authority/docs", "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/public-certificate-authority/docs", - "preferred": true + "id": "publicca:v1", + "kind": "discovery#directoryItem", + "name": "publicca", + "preferred": true, + "title": "Public Certificate Authority API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pubsub:v1beta1a", - "name": "pubsub", - "version": "v1beta1a", - "title": "Cloud Pub/Sub API", "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", "discoveryRestUrl": "https://pubsub.googleapis.com/$discovery/rest?version=v1beta1a", + "documentationLink": "https://cloud.google.com/pubsub/docs", "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/pubsub/docs", - "preferred": false - }, - { + "id": "pubsub:v1beta1a", "kind": "discovery#directoryItem", - "id": "pubsub:v1beta2", "name": "pubsub", - "version": "v1beta2", + "preferred": false, "title": "Cloud Pub/Sub API", + "version": "v1beta1a" + }, + { "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", "discoveryRestUrl": "https://pubsub.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/pubsub/docs", "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/pubsub/docs", - "preferred": false - }, - { + "id": "pubsub:v1beta2", "kind": "discovery#directoryItem", - "id": "pubsub:v1", "name": "pubsub", - "version": "v1", + "preferred": false, "title": "Cloud Pub/Sub API", + "version": "v1beta2" + }, + { "description": "Provides reliable, many-to-many, asynchronous messaging between applications.", "discoveryRestUrl": "https://pubsub.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/pubsub/docs", "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/pubsub/docs", - "preferred": true + "id": "pubsub:v1", + "kind": "discovery#directoryItem", + "name": "pubsub", + "preferred": true, + "title": "Cloud Pub/Sub API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "pubsublite:v1", - "name": "pubsublite", - "version": "v1", - "title": "Pub/Sub Lite API", "description": "", "discoveryRestUrl": "https://pubsublite.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/pubsub/lite/docs", "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/pubsub/lite/docs", - "preferred": true + "id": "pubsublite:v1", + "kind": "discovery#directoryItem", + "name": "pubsublite", + "preferred": true, + "title": "Pub/Sub Lite API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "rapidmigrationassessment:v1", - "name": "rapidmigrationassessment", - "version": "v1", - "title": "Rapid Migration Assessment API", "description": "The Rapid Migration Assessment service is our first-party migration assessment and planning tool.", "discoveryRestUrl": "https://rapidmigrationassessment.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/migration-center", "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/migration-center", - "preferred": true + "id": "rapidmigrationassessment:v1", + "kind": "discovery#directoryItem", + "name": "rapidmigrationassessment", + "preferred": true, + "title": "Rapid Migration Assessment API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "readerrevenuesubscriptionlinking:v1", - "name": "readerrevenuesubscriptionlinking", - "version": "v1", - "title": "Reader Revenue Subscription Linking API", "description": "readerrevenuesubscriptionlinking.googleapis.com API.", "discoveryRestUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/news/subscribe/subscription-linking/overview", "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://developers.google.com/news/subscribe/subscription-linking/overview", - "preferred": true + "id": "readerrevenuesubscriptionlinking:v1", + "kind": "discovery#directoryItem", + "name": "readerrevenuesubscriptionlinking", + "preferred": true, + "title": "Reader Revenue Subscription Linking API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "realtimebidding:v1alpha", - "name": "realtimebidding", - "version": "v1alpha", - "title": "Real-time Bidding API", "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", - "discoveryRestUrl": "https://realtimebidding.googleapis.com/$discovery/rest?version=v1alpha", + "discoveryRestUrl": "https://realtimebidding.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", "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://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", - "preferred": false - }, - { - "kind": "discovery#directoryItem", "id": "realtimebidding:v1", + "kind": "discovery#directoryItem", "name": "realtimebidding", - "version": "v1", + "preferred": true, "title": "Real-time Bidding API", - "description": "Allows external bidders to manage their RTB integration with Google. This includes managing bidder endpoints, QPS quotas, configuring what ad inventory to receive via pretargeting, submitting creatives for verification, and accessing creative metadata such as approval status.", - "discoveryRestUrl": "https://realtimebidding.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://developers.google.com/authorized-buyers/apis/realtimebidding/reference/rest/", - "preferred": true + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "recaptchaenterprise:v1", - "name": "recaptchaenterprise", - "version": "v1", - "title": "reCAPTCHA Enterprise API", "description": "Help protect your website from fraudulent activity, spam, and abuse without creating friction.", "discoveryRestUrl": "https://recaptchaenterprise.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/recaptcha-enterprise/", "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/recaptcha-enterprise/", - "preferred": true + "id": "recaptchaenterprise:v1", + "kind": "discovery#directoryItem", + "name": "recaptchaenterprise", + "preferred": true, + "title": "reCAPTCHA Enterprise API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "recommendationengine:v1beta1", - "name": "recommendationengine", - "version": "v1beta1", - "title": "Recommendations AI (Beta)", "description": "Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit https://console.cloud.google.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.", "discoveryRestUrl": "https://recommendationengine.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/recommendations-ai/docs", "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/recommendations-ai/docs", - "preferred": true + "id": "recommendationengine:v1beta1", + "kind": "discovery#directoryItem", + "name": "recommendationengine", + "preferred": true, + "title": "Recommendations AI (Beta)", + "version": "v1beta1" }, { - "kind": "discovery#directoryItem", - "id": "recommender:v1beta1", - "name": "recommender", - "version": "v1beta1", - "title": "Recommender API", "description": "", "discoveryRestUrl": "https://recommender.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/recommender/docs/", "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/recommender/docs/", - "preferred": false - }, - { + "id": "recommender:v1beta1", "kind": "discovery#directoryItem", - "id": "recommender:v1", "name": "recommender", - "version": "v1", + "preferred": false, "title": "Recommender API", + "version": "v1beta1" + }, + { "description": "", "discoveryRestUrl": "https://recommender.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/recommender/docs/", "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/recommender/docs/", - "preferred": true + "id": "recommender:v1", + "kind": "discovery#directoryItem", + "name": "recommender", + "preferred": true, + "title": "Recommender API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "redis:v1beta1", - "name": "redis", - "version": "v1beta1", - "title": "Google Cloud Memorystore for Redis API", "description": "Creates and manages Redis instances on the Google Cloud Platform.", "discoveryRestUrl": "https://redis.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", "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/memorystore/docs/redis/", - "preferred": false - }, - { + "id": "redis:v1beta1", "kind": "discovery#directoryItem", - "id": "redis:v1", "name": "redis", - "version": "v1", + "preferred": false, "title": "Google Cloud Memorystore for Redis API", + "version": "v1beta1" + }, + { "description": "Creates and manages Redis instances on the Google Cloud Platform.", "discoveryRestUrl": "https://redis.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/memorystore/docs/redis/", "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/memorystore/docs/redis/", - "preferred": true + "id": "redis:v1", + "kind": "discovery#directoryItem", + "name": "redis", + "preferred": true, + "title": "Google Cloud Memorystore for Redis API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "reseller:v1", - "name": "reseller", - "version": "v1", - "title": "Google Workspace Reseller API", "description": "Perform common functions that are available on the Channel Services console at scale, like placing orders and viewing customer information", "discoveryRestUrl": "https://reseller.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/google-apps/reseller/", "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://developers.google.com/google-apps/reseller/", - "preferred": true + "id": "reseller:v1", + "kind": "discovery#directoryItem", + "name": "reseller", + "preferred": true, + "title": "Google Workspace Reseller API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "resourcesettings:v1", - "name": "resourcesettings", - "version": "v1", - "title": "Resource Settings API", "description": "The Resource Settings API allows users to control and modify the behavior of their GCP resources (e.g., VM, firewall, Project, etc.) across the Cloud Resource Hierarchy.", "discoveryRestUrl": "https://resourcesettings.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/resource-manager/docs/resource-settings/overview", "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/resource-manager/docs/resource-settings/overview", - "preferred": true + "id": "resourcesettings:v1", + "kind": "discovery#directoryItem", + "name": "resourcesettings", + "preferred": true, + "title": "Resource Settings API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "retail:v2alpha", - "name": "retail", - "version": "v2alpha", - "title": "Vertex AI Search for Retail API", "description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2alpha", + "documentationLink": "https://cloud.google.com/recommendations", "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/recommendations", - "preferred": false - }, - { + "id": "retail:v2alpha", "kind": "discovery#directoryItem", - "id": "retail:v2beta", "name": "retail", - "version": "v2beta", + "preferred": false, "title": "Vertex AI Search for Retail API", + "version": "v2alpha" + }, + { "description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2beta", + "documentationLink": "https://cloud.google.com/recommendations", "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/recommendations", - "preferred": false - }, - { + "id": "retail:v2beta", "kind": "discovery#directoryItem", - "id": "retail:v2", "name": "retail", - "version": "v2", + "preferred": false, "title": "Vertex AI Search for Retail API", + "version": "v2beta" + }, + { "description": "Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.", "discoveryRestUrl": "https://retail.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/recommendations", "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/recommendations", - "preferred": true + "id": "retail:v2", + "kind": "discovery#directoryItem", + "name": "retail", + "preferred": true, + "title": "Vertex AI Search for Retail API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "run:v1", - "name": "run", - "version": "v1", - "title": "Cloud Run Admin API", "description": "Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.", "discoveryRestUrl": "https://run.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/run/", "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/run/", - "preferred": false - }, - { + "id": "run:v1", "kind": "discovery#directoryItem", - "id": "run:v2", "name": "run", - "version": "v2", + "preferred": false, "title": "Cloud Run Admin API", + "version": "v1" + }, + { "description": "Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/.", "discoveryRestUrl": "https://run.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/run/", "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/run/", - "preferred": true + "id": "run:v2", + "kind": "discovery#directoryItem", + "name": "run", + "preferred": true, + "title": "Cloud Run Admin API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "runtimeconfig:v1beta1", - "name": "runtimeconfig", - "version": "v1beta1", - "title": "Cloud Runtime Configuration API", "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", "discoveryRestUrl": "https://runtimeconfig.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", "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/deployment-manager/runtime-configurator/", - "preferred": false - }, - { + "id": "runtimeconfig:v1beta1", "kind": "discovery#directoryItem", - "id": "runtimeconfig:v1", "name": "runtimeconfig", - "version": "v1", + "preferred": false, "title": "Cloud Runtime Configuration API", + "version": "v1beta1" + }, + { "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", "discoveryRestUrl": "https://runtimeconfig.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", "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/deployment-manager/runtime-configurator/", - "preferred": true + "id": "runtimeconfig:v1", + "kind": "discovery#directoryItem", + "name": "runtimeconfig", + "preferred": true, + "title": "Cloud Runtime Configuration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "safebrowsing:v4", - "name": "safebrowsing", - "version": "v4", - "title": "Safe Browsing API", "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.", "discoveryRestUrl": "https://safebrowsing.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/safe-browsing/", "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://developers.google.com/safe-browsing/", - "preferred": false - }, - { + "id": "safebrowsing:v4", "kind": "discovery#directoryItem", - "id": "safebrowsing:v5", "name": "safebrowsing", - "version": "v5", + "preferred": false, "title": "Safe Browsing API", + "version": "v4" + }, + { "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.", "discoveryRestUrl": "https://safebrowsing.googleapis.com/$discovery/rest?version=v5", + "documentationLink": "https://developers.google.com/safe-browsing/", "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://developers.google.com/safe-browsing/", - "preferred": true + "id": "safebrowsing:v5", + "kind": "discovery#directoryItem", + "name": "safebrowsing", + "preferred": true, + "title": "Safe Browsing API", + "version": "v5" }, { - "kind": "discovery#directoryItem", - "id": "sasportal:v1alpha1", - "name": "sasportal", - "version": "v1alpha1", - "title": "SAS Portal API", "description": "", "discoveryRestUrl": "https://sasportal.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://developers.google.com/spectrum-access-system/", "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://developers.google.com/spectrum-access-system/", - "preferred": true + "id": "sasportal:v1alpha1", + "kind": "discovery#directoryItem", + "name": "sasportal", + "preferred": true, + "title": "SAS Portal API", + "version": "v1alpha1" }, { - "kind": "discovery#directoryItem", - "id": "script:v1", - "name": "script", - "version": "v1", - "title": "Apps Script API", "description": "Manages and executes Google Apps Script projects.", "discoveryRestUrl": "https://script.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/apps-script/api/", "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://developers.google.com/apps-script/api/", - "preferred": true + "id": "script:v1", + "kind": "discovery#directoryItem", + "name": "script", + "preferred": true, + "title": "Apps Script API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "searchads360:v0", - "name": "searchads360", - "version": "v0", - "title": "Search Ads 360 Reporting API", "description": "The Search Ads 360 API allows developers to automate downloading reports from Search Ads 360.", "discoveryRestUrl": "https://searchads360.googleapis.com/$discovery/rest?version=v0", + "documentationLink": "https://developers.google.com/search-ads/reporting", "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://developers.google.com/search-ads/reporting", - "preferred": true + "id": "searchads360:v0", + "kind": "discovery#directoryItem", + "name": "searchads360", + "preferred": true, + "title": "Search Ads 360 Reporting API", + "version": "v0" }, { - "kind": "discovery#directoryItem", - "id": "searchconsole:v1", - "name": "searchconsole", - "version": "v1", - "title": "Google Search Console API", "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", "discoveryRestUrl": "https://searchconsole.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/webmaster-tools/about", "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://developers.google.com/webmaster-tools/search-console-api/", - "preferred": true + "id": "searchconsole:v1", + "kind": "discovery#directoryItem", + "name": "searchconsole", + "preferred": true, + "title": "Google Search Console API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "secretmanager:v1beta1", - "name": "secretmanager", - "version": "v1beta1", - "title": "Secret Manager API", "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/secret-manager/", "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/secret-manager/", - "preferred": false - }, - { + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "id": "secretmanager:v1beta1", "kind": "discovery#directoryItem", - "id": "secretmanager:v1beta2", "name": "secretmanager", - "version": "v1beta2", + "preferred": false, "title": "Secret Manager API", + "version": "v1beta1" + }, + { "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/secret-manager/", "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/secret-manager/", - "preferred": false - }, - { + "id": "secretmanager:v1beta2", "kind": "discovery#directoryItem", - "id": "secretmanager:v1", "name": "secretmanager", - "version": "v1", + "preferred": false, "title": "Secret Manager API", + "version": "v1beta2" + }, + { "description": "Stores sensitive data such as API keys, passwords, and certificates. Provides convenience while improving security.", "discoveryRestUrl": "https://secretmanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/secret-manager/", "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/secret-manager/", - "preferred": true + "id": "secretmanager:v1", + "kind": "discovery#directoryItem", + "name": "secretmanager", + "preferred": true, + "title": "Secret Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "securitycenter:v1beta1", - "name": "securitycenter", - "version": "v1beta1", - "title": "Security Command Center API", "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryRestUrl": "https://securitycenter.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/security-command-center", "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/security-command-center", - "preferred": false - }, - { + "id": "securitycenter:v1beta1", "kind": "discovery#directoryItem", - "id": "securitycenter:v1beta2", "name": "securitycenter", - "version": "v1beta2", + "preferred": false, "title": "Security Command Center API", + "version": "v1beta1" + }, + { "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryRestUrl": "https://securitycenter.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/security-command-center", "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/security-command-center", - "preferred": false - }, - { + "id": "securitycenter:v1beta2", "kind": "discovery#directoryItem", - "id": "securitycenter:v1", "name": "securitycenter", - "version": "v1", + "preferred": false, "title": "Security Command Center API", + "version": "v1beta2" + }, + { "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryRestUrl": "https://securitycenter.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/security-command-center", "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/security-command-center", - "preferred": true + "id": "securitycenter:v1", + "kind": "discovery#directoryItem", + "name": "securitycenter", + "preferred": true, + "title": "Security Command Center API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "serviceconsumermanagement:v1beta1", - "name": "serviceconsumermanagement", - "version": "v1beta1", - "title": "Service Consumer Management API", "description": "Manages the service consumers of a Service Infrastructure service.", "discoveryRestUrl": "https://serviceconsumermanagement.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", "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/service-consumer-management/docs/overview", - "preferred": false - }, - { + "id": "serviceconsumermanagement:v1beta1", "kind": "discovery#directoryItem", - "id": "serviceconsumermanagement:v1", "name": "serviceconsumermanagement", - "version": "v1", + "preferred": false, "title": "Service Consumer Management API", + "version": "v1beta1" + }, + { "description": "Manages the service consumers of a Service Infrastructure service.", "discoveryRestUrl": "https://serviceconsumermanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", "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/service-consumer-management/docs/overview", - "preferred": true + "id": "serviceconsumermanagement:v1", + "kind": "discovery#directoryItem", + "name": "serviceconsumermanagement", + "preferred": true, + "title": "Service Consumer Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "servicecontrol:v1", - "name": "servicecontrol", - "version": "v1", - "title": "Service Control API", "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", "discoveryRestUrl": "https://servicecontrol.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-control/", "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/service-control/", - "preferred": false - }, - { + "id": "servicecontrol:v1", "kind": "discovery#directoryItem", - "id": "servicecontrol:v2", "name": "servicecontrol", - "version": "v2", + "preferred": false, "title": "Service Control API", + "version": "v1" + }, + { "description": "Provides admission control and telemetry reporting for services integrated with Service Infrastructure.", "discoveryRestUrl": "https://servicecontrol.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/service-control/", "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/service-control/", - "preferred": true + "id": "servicecontrol:v2", + "kind": "discovery#directoryItem", + "name": "servicecontrol", + "preferred": true, + "title": "Service Control API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "servicedirectory:v1beta1", - "name": "servicedirectory", - "version": "v1beta1", - "title": "Service Directory API", "description": "Service Directory is a platform for discovering, publishing, and connecting services.", "discoveryRestUrl": "https://servicedirectory.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/service-directory", "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/service-directory", - "preferred": false - }, - { + "id": "servicedirectory:v1beta1", "kind": "discovery#directoryItem", - "id": "servicedirectory:v1", "name": "servicedirectory", - "version": "v1", + "preferred": false, "title": "Service Directory API", + "version": "v1beta1" + }, + { "description": "Service Directory is a platform for discovering, publishing, and connecting services.", "discoveryRestUrl": "https://servicedirectory.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-directory", "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/service-directory", - "preferred": true + "id": "servicedirectory:v1", + "kind": "discovery#directoryItem", + "name": "servicedirectory", + "preferred": true, + "title": "Service Directory API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "servicemanagement:v1", - "name": "servicemanagement", - "version": "v1", - "title": "Service Management API", "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.", "discoveryRestUrl": "https://servicemanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-management/", "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/service-management/", - "preferred": true + "id": "servicemanagement:v1", + "kind": "discovery#directoryItem", + "name": "servicemanagement", + "preferred": true, + "title": "Service Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "servicenetworking:v1beta", - "name": "servicenetworking", - "version": "v1beta", - "title": "Service Networking API", "description": "Provides automatic management of network configurations necessary for certain services.", "discoveryRestUrl": "https://servicenetworking.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started", "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/service-infrastructure/docs/service-networking/getting-started", - "preferred": false - }, - { + "id": "servicenetworking:v1beta", "kind": "discovery#directoryItem", - "id": "servicenetworking:v1", "name": "servicenetworking", - "version": "v1", + "preferred": false, "title": "Service Networking API", + "version": "v1beta" + }, + { "description": "Provides automatic management of network configurations necessary for certain services.", "discoveryRestUrl": "https://servicenetworking.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-infrastructure/docs/service-networking/getting-started", "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/service-infrastructure/docs/service-networking/getting-started", - "preferred": true + "id": "servicenetworking:v1", + "kind": "discovery#directoryItem", + "name": "servicenetworking", + "preferred": true, + "title": "Service Networking API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "serviceusage:v1beta1", - "name": "serviceusage", - "version": "v1beta1", - "title": "Service Usage API", "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", "discoveryRestUrl": "https://serviceusage.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/service-usage/", "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/service-usage/", - "preferred": false - }, - { + "id": "serviceusage:v1beta1", "kind": "discovery#directoryItem", - "id": "serviceusage:v1", "name": "serviceusage", - "version": "v1", + "preferred": false, "title": "Service Usage API", + "version": "v1beta1" + }, + { "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", "discoveryRestUrl": "https://serviceusage.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/service-usage/", "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/service-usage/", - "preferred": true + "id": "serviceusage:v1", + "kind": "discovery#directoryItem", + "name": "serviceusage", + "preferred": true, + "title": "Service Usage API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "sheets:v4", - "name": "sheets", - "version": "v4", - "title": "Google Sheets API", "description": "Reads and writes Google Sheets.", "discoveryRestUrl": "https://sheets.googleapis.com/$discovery/rest?version=v4", + "documentationLink": "https://developers.google.com/sheets/", "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://developers.google.com/sheets/", - "preferred": true + "id": "sheets:v4", + "kind": "discovery#directoryItem", + "name": "sheets", + "preferred": true, + "title": "Google Sheets API", + "version": "v4" }, { - "kind": "discovery#directoryItem", - "id": "siteVerification:v1", - "name": "siteVerification", - "version": "v1", - "title": "Site Verification API", "description": "The Google Site Verification API lets applications automate the process of managing ownership records for websites and domains.", "discoveryRestUrl": "https://siteverification.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://code.google.com/apis/siteverification/", "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://code.google.com/apis/siteverification/", - "preferred": true + "id": "siteVerification:v1", + "kind": "discovery#directoryItem", + "name": "siteVerification", + "preferred": true, + "title": "Site Verification API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "slides:v1", - "name": "slides", - "version": "v1", - "title": "Google Slides API", "description": "Reads and writes Google Slides presentations.", "discoveryRestUrl": "https://slides.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/slides/", "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://developers.google.com/slides/", - "preferred": true + "id": "slides:v1", + "kind": "discovery#directoryItem", + "name": "slides", + "preferred": true, + "title": "Google Slides API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "smartdevicemanagement:v1", - "name": "smartdevicemanagement", - "version": "v1", - "title": "Smart Device Management API", "description": "Allow select enterprise partners to access, control, and manage Google and Nest devices programmatically.", "discoveryRestUrl": "https://smartdevicemanagement.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/nest/device-access", "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://developers.google.com/nest/device-access", - "preferred": true + "id": "smartdevicemanagement:v1", + "kind": "discovery#directoryItem", + "name": "smartdevicemanagement", + "preferred": true, + "title": "Smart Device Management API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "solar:v1", - "name": "solar", - "version": "v1", - "title": "Solar API", "description": "Solar API.", "discoveryRestUrl": "https://solar.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/maps/documentation/solar", "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://developers.google.com/maps/documentation/solar", - "preferred": true + "id": "solar:v1", + "kind": "discovery#directoryItem", + "name": "solar", + "preferred": true, + "title": "Solar API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "spanner:v1", - "name": "spanner", - "version": "v1", - "title": "Cloud Spanner API", "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.", "discoveryRestUrl": "https://spanner.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/spanner/", "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/spanner/", - "preferred": true + "id": "spanner:v1", + "kind": "discovery#directoryItem", + "name": "spanner", + "preferred": true, + "title": "Cloud Spanner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "speech:v1p1beta1", - "name": "speech", - "version": "v1p1beta1", - "title": "Cloud Speech-to-Text API", "description": "Converts audio to text by applying powerful neural network models.", "discoveryRestUrl": "https://speech.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", "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/speech-to-text/docs/quickstart-protocol", - "preferred": false - }, - { + "id": "speech:v1p1beta1", "kind": "discovery#directoryItem", - "id": "speech:v1", "name": "speech", - "version": "v1", + "preferred": false, "title": "Cloud Speech-to-Text API", + "version": "v1p1beta1" + }, + { "description": "Converts audio to text by applying powerful neural network models.", "discoveryRestUrl": "https://speech.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/speech-to-text/docs/quickstart-protocol", "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/speech-to-text/docs/quickstart-protocol", - "preferred": true + "id": "speech:v1", + "kind": "discovery#directoryItem", + "name": "speech", + "preferred": true, + "title": "Cloud Speech-to-Text API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "sqladmin:v1beta4", - "name": "sqladmin", - "version": "v1beta4", - "title": "Cloud SQL Admin API", "description": "API for Cloud SQL database instance management", "discoveryRestUrl": "https://sqladmin.googleapis.com/$discovery/rest?version=v1beta4", + "documentationLink": "https://developers.google.com/cloud-sql/", "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://developers.google.com/cloud-sql/", - "preferred": false - }, - { + "id": "sqladmin:v1beta4", "kind": "discovery#directoryItem", - "id": "sqladmin:v1", "name": "sqladmin", - "version": "v1", + "preferred": false, "title": "Cloud SQL Admin API", + "version": "v1beta4" + }, + { "description": "API for Cloud SQL database instance management", "discoveryRestUrl": "https://sqladmin.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/cloud-sql/", "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://developers.google.com/cloud-sql/", - "preferred": true + "id": "sqladmin:v1", + "kind": "discovery#directoryItem", + "name": "sqladmin", + "preferred": true, + "title": "Cloud SQL Admin API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "storage:v1", - "name": "storage", - "version": "v1", - "title": "Cloud Storage API", "description": "Lets you store and retrieve potentially-large, immutable data objects.", "discoveryRestUrl": "https://storage.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/storage/docs/apis", "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/storage/docs/apis", - "preferred": true - }, - { + "id": "storage:v1", "kind": "discovery#directoryItem", - "id": "storagetransfer:v1", - "name": "storagetransfer", - "version": "v1", - "title": "Storage Transfer API", + "name": "storage", + "preferred": true, + "title": "Cloud Storage API", + "version": "v1" + }, + { "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.", "discoveryRestUrl": "https://storagetransfer.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/storage-transfer/docs", "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/storage-transfer/docs", - "preferred": true + "id": "storagetransfer:v1", + "kind": "discovery#directoryItem", + "name": "storagetransfer", + "preferred": true, + "title": "Storage Transfer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "streetviewpublish:v1", - "name": "streetviewpublish", - "version": "v1", - "title": "Street View Publish API", "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.", "discoveryRestUrl": "https://streetviewpublish.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/streetview/publish/", "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://developers.google.com/streetview/publish/", - "preferred": true + "id": "streetviewpublish:v1", + "kind": "discovery#directoryItem", + "name": "streetviewpublish", + "preferred": true, + "title": "Street View Publish API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "sts:v1beta", - "name": "sts", - "version": "v1beta", - "title": "Security Token Service API", "description": "The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources.", "discoveryRestUrl": "https://sts.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "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": "http://cloud.google.com/iam/docs/workload-identity-federation", - "preferred": false - }, - { + "id": "sts:v1beta", "kind": "discovery#directoryItem", - "id": "sts:v1", "name": "sts", - "version": "v1", + "preferred": false, "title": "Security Token Service API", + "version": "v1beta" + }, + { "description": "The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources.", "discoveryRestUrl": "https://sts.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "http://cloud.google.com/iam/docs/workload-identity-federation", "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": "http://cloud.google.com/iam/docs/workload-identity-federation", - "preferred": true + "id": "sts:v1", + "kind": "discovery#directoryItem", + "name": "sts", + "preferred": true, + "title": "Security Token Service API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "tagmanager:v1", - "name": "tagmanager", - "version": "v1", - "title": "Tag Manager API", "description": "This API allows clients to access and modify container and tag configuration.", "discoveryRestUrl": "https://tagmanager.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/tag-manager", "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://developers.google.com/tag-manager", - "preferred": false - }, - { + "id": "tagmanager:v1", "kind": "discovery#directoryItem", - "id": "tagmanager:v2", "name": "tagmanager", - "version": "v2", + "preferred": false, "title": "Tag Manager API", + "version": "v1" + }, + { "description": "This API allows clients to access and modify container and tag configuration.", "discoveryRestUrl": "https://tagmanager.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/tag-manager", "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://developers.google.com/tag-manager", - "preferred": true + "id": "tagmanager:v2", + "kind": "discovery#directoryItem", + "name": "tagmanager", + "preferred": true, + "title": "Tag Manager API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "tasks:v1", - "name": "tasks", - "version": "v1", - "title": "Google Tasks API", "description": "The Google Tasks API lets you manage your tasks and task lists.", "discoveryRestUrl": "https://tasks.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/tasks/", "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://developers.google.com/tasks/", - "preferred": true + "id": "tasks:v1", + "kind": "discovery#directoryItem", + "name": "tasks", + "preferred": true, + "title": "Google Tasks API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "testing:v1", - "name": "testing", - "version": "v1", - "title": "Cloud Testing API", "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.", "discoveryRestUrl": "https://testing.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://firebase.google.com/docs/test-lab/", "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://firebase.google.com/docs/test-lab/", - "preferred": true + "id": "testing:v1", + "kind": "discovery#directoryItem", + "name": "testing", + "preferred": true, + "title": "Cloud Testing API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "texttospeech:v1beta1", - "name": "texttospeech", - "version": "v1beta1", - "title": "Cloud Text-to-Speech API", "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", "discoveryRestUrl": "https://texttospeech.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/text-to-speech/", "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/text-to-speech/", - "preferred": false - }, - { + "id": "texttospeech:v1beta1", "kind": "discovery#directoryItem", - "id": "texttospeech:v1", "name": "texttospeech", - "version": "v1", + "preferred": false, "title": "Cloud Text-to-Speech API", + "version": "v1beta1" + }, + { "description": "Synthesizes natural-sounding speech by applying powerful neural network models.", "discoveryRestUrl": "https://texttospeech.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/text-to-speech/", "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/text-to-speech/", - "preferred": true + "id": "texttospeech:v1", + "kind": "discovery#directoryItem", + "name": "texttospeech", + "preferred": true, + "title": "Cloud Text-to-Speech API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "toolresults:v1beta3", - "name": "toolresults", - "version": "v1beta3", - "title": "Cloud Tool Results API", "description": "API to publish and access results from developer tools.", "discoveryRestUrl": "https://toolresults.googleapis.com/$discovery/rest?version=v1beta3", + "documentationLink": "https://firebase.google.com/docs/test-lab/", "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://firebase.google.com/docs/test-lab/", - "preferred": true + "id": "toolresults:v1beta3", + "kind": "discovery#directoryItem", + "name": "toolresults", + "preferred": true, + "title": "Cloud Tool Results API", + "version": "v1beta3" }, { - "kind": "discovery#directoryItem", - "id": "tpu:v1alpha1", - "name": "tpu", - "version": "v1alpha1", - "title": "Cloud TPU API", "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/tpu/", "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/tpu/", - "preferred": false - }, - { + "id": "tpu:v1alpha1", "kind": "discovery#directoryItem", - "id": "tpu:v2alpha1", "name": "tpu", - "version": "v2alpha1", + "preferred": false, "title": "Cloud TPU API", + "version": "v1alpha1" + }, + { "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v2alpha1", + "documentationLink": "https://cloud.google.com/tpu/", "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/tpu/", - "preferred": false - }, - { + "id": "tpu:v2alpha1", "kind": "discovery#directoryItem", - "id": "tpu:v1", "name": "tpu", - "version": "v1", + "preferred": false, "title": "Cloud TPU API", + "version": "v2alpha1" + }, + { "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/tpu/", "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/tpu/", - "preferred": false - }, - { + "id": "tpu:v1", "kind": "discovery#directoryItem", - "id": "tpu:v2", "name": "tpu", - "version": "v2", + "preferred": false, "title": "Cloud TPU API", + "version": "v1" + }, + { "description": "TPU API provides customers with access to Google TPU technology.", "discoveryRestUrl": "https://tpu.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/tpu/", "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/tpu/", - "preferred": true + "id": "tpu:v2", + "kind": "discovery#directoryItem", + "name": "tpu", + "preferred": true, + "title": "Cloud TPU API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "trafficdirector:v2", - "name": "trafficdirector", - "version": "v2", - "title": "Traffic Director API", "description": "", "discoveryRestUrl": "https://trafficdirector.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/traffic-director", "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/traffic-director", - "preferred": false - }, - { + "id": "trafficdirector:v2", "kind": "discovery#directoryItem", - "id": "trafficdirector:v3", "name": "trafficdirector", - "version": "v3", + "preferred": false, "title": "Traffic Director API", + "version": "v2" + }, + { "description": "", "discoveryRestUrl": "https://trafficdirector.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/traffic-director", "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/traffic-director", - "preferred": true + "id": "trafficdirector:v3", + "kind": "discovery#directoryItem", + "name": "trafficdirector", + "preferred": true, + "title": "Traffic Director API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "transcoder:v1", - "name": "transcoder", - "version": "v1", - "title": "Transcoder API", "description": "This API converts video files into formats suitable for consumer distribution. For more information, see the Transcoder API overview .", "discoveryRestUrl": "https://transcoder.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/transcoder/docs/", "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/transcoder/docs/", - "preferred": true + "id": "transcoder:v1", + "kind": "discovery#directoryItem", + "name": "transcoder", + "preferred": true, + "title": "Transcoder API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "translate:v3beta1", - "name": "translate", - "version": "v3beta1", - "title": "Cloud Translation API", "description": "Integrates text translation into your website or application.", "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v3beta1", + "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", "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/translate/docs/quickstarts", - "preferred": false - }, - { + "id": "translate:v3beta1", "kind": "discovery#directoryItem", - "id": "translate:v2", "name": "translate", - "version": "v2", + "preferred": false, "title": "Cloud Translation API", + "version": "v3beta1" + }, + { "description": "Integrates text translation into your website or application.", "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", "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/translate/docs/quickstarts", - "preferred": false - }, - { + "id": "translate:v2", "kind": "discovery#directoryItem", - "id": "translate:v3", "name": "translate", - "version": "v3", + "preferred": false, "title": "Cloud Translation API", + "version": "v2" + }, + { "description": "Integrates text translation into your website or application.", "discoveryRestUrl": "https://translation.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://cloud.google.com/translate/docs/quickstarts", "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/translate/docs/quickstarts", - "preferred": true + "id": "translate:v3", + "kind": "discovery#directoryItem", + "name": "translate", + "preferred": true, + "title": "Cloud Translation API", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "travelimpactmodel:v1", - "name": "travelimpactmodel", - "version": "v1", - "title": "Travel Impact Model API", "description": "Travel Impact Model API lets you query travel carbon emission estimates.", "discoveryRestUrl": "https://travelimpactmodel.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/travel/impact-model", "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://developers.google.com/travel/impact-model", - "preferred": true + "id": "travelimpactmodel:v1", + "kind": "discovery#directoryItem", + "name": "travelimpactmodel", + "preferred": true, + "title": "Travel Impact Model API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vault:v1", - "name": "vault", - "version": "v1", - "title": "Google Vault API", "description": "Retention and eDiscovery for Google Workspace. To work with Vault resources, the account must have the [required Vault privileges](https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. For example, to download an export, an account needs the **Manage Exports** privilege and the matter shared with them.", "discoveryRestUrl": "https://vault.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/vault", "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://developers.google.com/vault", - "preferred": true + "id": "vault:v1", + "kind": "discovery#directoryItem", + "name": "vault", + "preferred": true, + "title": "Google Vault API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "verifiedaccess:v1", - "name": "verifiedaccess", - "version": "v1", - "title": "Chrome Verified Access API", "description": "API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network", "discoveryRestUrl": "https://verifiedaccess.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/chrome/verified-access", "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://developers.google.com/chrome/verified-access", - "preferred": false - }, - { + "id": "verifiedaccess:v1", "kind": "discovery#directoryItem", - "id": "verifiedaccess:v2", "name": "verifiedaccess", - "version": "v2", + "preferred": false, "title": "Chrome Verified Access API", + "version": "v1" + }, + { "description": "API for Verified Access chrome extension to provide credential verification for chrome devices connecting to an enterprise network", "discoveryRestUrl": "https://verifiedaccess.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/chrome/verified-access", "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://developers.google.com/chrome/verified-access", - "preferred": true + "id": "verifiedaccess:v2", + "kind": "discovery#directoryItem", + "name": "verifiedaccess", + "preferred": true, + "title": "Chrome Verified Access API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "versionhistory:v1", - "name": "versionhistory", - "version": "v1", - "title": "versionhistory.googleapis.com API", "description": "Version History API - Prod", "discoveryRestUrl": "https://versionhistory.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.chrome.com/versionhistory", "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://developers.chrome.com/versionhistory", - "preferred": true + "id": "versionhistory:v1", + "kind": "discovery#directoryItem", + "name": "versionhistory", + "preferred": true, + "title": "versionhistory.googleapis.com API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "videointelligence:v1p1beta1", - "name": "videointelligence", - "version": "v1p1beta1", - "title": "Cloud Video Intelligence API", "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "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/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1p1beta1", "kind": "discovery#directoryItem", - "id": "videointelligence:v1p2beta1", "name": "videointelligence", - "version": "v1p2beta1", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1p1beta1" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1p2beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "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/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1p2beta1", "kind": "discovery#directoryItem", - "id": "videointelligence:v1p3beta1", "name": "videointelligence", - "version": "v1p3beta1", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1p2beta1" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1p3beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "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/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1p3beta1", "kind": "discovery#directoryItem", - "id": "videointelligence:v1beta2", "name": "videointelligence", - "version": "v1beta2", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1p3beta1" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1beta2", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "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/video-intelligence/docs/", - "preferred": false - }, - { + "id": "videointelligence:v1beta2", "kind": "discovery#directoryItem", - "id": "videointelligence:v1", "name": "videointelligence", - "version": "v1", + "preferred": false, "title": "Cloud Video Intelligence API", + "version": "v1beta2" + }, + { "description": "Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text. Supports both asynchronous API and streaming API.", "discoveryRestUrl": "https://videointelligence.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "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/video-intelligence/docs/", - "preferred": true + "id": "videointelligence:v1", + "kind": "discovery#directoryItem", + "name": "videointelligence", + "preferred": true, + "title": "Cloud Video Intelligence API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vision:v1p1beta1", - "name": "vision", - "version": "v1p1beta1", - "title": "Cloud Vision API", "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1p1beta1", + "documentationLink": "https://cloud.google.com/vision/", "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/vision/", - "preferred": false - }, - { + "id": "vision:v1p1beta1", "kind": "discovery#directoryItem", - "id": "vision:v1p2beta1", "name": "vision", - "version": "v1p2beta1", + "preferred": false, "title": "Cloud Vision API", + "version": "v1p1beta1" + }, + { "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1p2beta1", + "documentationLink": "https://cloud.google.com/vision/", "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/vision/", - "preferred": false - }, - { + "id": "vision:v1p2beta1", "kind": "discovery#directoryItem", - "id": "vision:v1", "name": "vision", - "version": "v1", + "preferred": false, "title": "Cloud Vision API", + "version": "v1p2beta1" + }, + { "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", "discoveryRestUrl": "https://vision.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/vision/", "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/vision/", - "preferred": true + "id": "vision:v1", + "kind": "discovery#directoryItem", + "name": "vision", + "preferred": true, + "title": "Cloud Vision API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vmmigration:v1alpha1", - "name": "vmmigration", - "version": "v1alpha1", - "title": "VM Migration API", "description": "Use the Migrate to Virtual Machines API to programmatically migrate workloads.", "discoveryRestUrl": "https://vmmigration.googleapis.com/$discovery/rest?version=v1alpha1", + "documentationLink": "https://cloud.google.com/migrate/virtual-machines", "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/migrate/virtual-machines", - "preferred": false - }, - { + "id": "vmmigration:v1alpha1", "kind": "discovery#directoryItem", - "id": "vmmigration:v1", "name": "vmmigration", - "version": "v1", + "preferred": false, "title": "VM Migration API", + "version": "v1alpha1" + }, + { "description": "Use the Migrate to Virtual Machines API to programmatically migrate workloads.", "discoveryRestUrl": "https://vmmigration.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/migrate/virtual-machines", "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/migrate/virtual-machines", - "preferred": true + "id": "vmmigration:v1", + "kind": "discovery#directoryItem", + "name": "vmmigration", + "preferred": true, + "title": "VM Migration API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vmwareengine:v1", - "name": "vmwareengine", - "version": "v1", - "title": "VMware Engine API", "description": "The Google VMware Engine API lets you programmatically manage VMware environments.", "discoveryRestUrl": "https://vmwareengine.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/solutions/vmware-as-a-service", "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/solutions/vmware-as-a-service", - "preferred": true + "id": "vmwareengine:v1", + "kind": "discovery#directoryItem", + "name": "vmwareengine", + "preferred": true, + "title": "VMware Engine API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "vpcaccess:v1beta1", - "name": "vpcaccess", - "version": "v1beta1", - "title": "Serverless VPC Access API", "description": "API for managing VPC access connectors.", "discoveryRestUrl": "https://vpcaccess.googleapis.com/$discovery/rest?version=v1beta1", + "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access", "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/vpc/docs/configure-serverless-vpc-access", - "preferred": false - }, - { + "id": "vpcaccess:v1beta1", "kind": "discovery#directoryItem", - "id": "vpcaccess:v1", "name": "vpcaccess", - "version": "v1", + "preferred": false, "title": "Serverless VPC Access API", + "version": "v1beta1" + }, + { "description": "API for managing VPC access connectors.", "discoveryRestUrl": "https://vpcaccess.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/vpc/docs/configure-serverless-vpc-access", "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/vpc/docs/configure-serverless-vpc-access", - "preferred": true + "id": "vpcaccess:v1", + "kind": "discovery#directoryItem", + "name": "vpcaccess", + "preferred": true, + "title": "Serverless VPC Access API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "walletobjects:v1", - "name": "walletobjects", - "version": "v1", - "title": "Google Wallet API", "description": "API for issuers to save and manage Google Wallet Objects.", "discoveryRestUrl": "https://walletobjects.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/pay/passes", "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://developers.google.com/pay/passes", - "preferred": true + "id": "walletobjects:v1", + "kind": "discovery#directoryItem", + "name": "walletobjects", + "preferred": true, + "title": "Google Wallet API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "webfonts:v1", - "name": "webfonts", - "version": "v1", - "title": "Web Fonts Developer API", "description": "The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.", "discoveryRestUrl": "https://webfonts.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/fonts/docs/developer_api", "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://developers.google.com/fonts/docs/developer_api", - "preferred": true + "id": "webfonts:v1", + "kind": "discovery#directoryItem", + "name": "webfonts", + "preferred": true, + "title": "Web Fonts Developer API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "webrisk:v1", - "name": "webrisk", - "version": "v1", - "title": "Web Risk API", "description": "", "discoveryRestUrl": "https://webrisk.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/web-risk/", "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/web-risk/", - "preferred": true + "id": "webrisk:v1", + "kind": "discovery#directoryItem", + "name": "webrisk", + "preferred": true, + "title": "Web Risk API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "websecurityscanner:v1alpha", - "name": "websecurityscanner", - "version": "v1alpha", - "title": "Web Security Scanner API", "description": "Scans your Compute and App Engine apps for common web vulnerabilities.", "discoveryRestUrl": "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1alpha", + "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", "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/security-command-center/docs/concepts-web-security-scanner-overview/", - "preferred": false - }, - { + "id": "websecurityscanner:v1alpha", "kind": "discovery#directoryItem", - "id": "websecurityscanner:v1beta", "name": "websecurityscanner", - "version": "v1beta", + "preferred": false, "title": "Web Security Scanner API", + "version": "v1alpha" + }, + { "description": "Scans your Compute and App Engine apps for common web vulnerabilities.", "discoveryRestUrl": "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", "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/security-command-center/docs/concepts-web-security-scanner-overview/", - "preferred": false - }, - { + "id": "websecurityscanner:v1beta", "kind": "discovery#directoryItem", - "id": "websecurityscanner:v1", "name": "websecurityscanner", - "version": "v1", + "preferred": false, "title": "Web Security Scanner API", + "version": "v1beta" + }, + { "description": "Scans your Compute and App Engine apps for common web vulnerabilities.", "discoveryRestUrl": "https://websecurityscanner.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview/", "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/security-command-center/docs/concepts-web-security-scanner-overview/", - "preferred": true + "id": "websecurityscanner:v1", + "kind": "discovery#directoryItem", + "name": "websecurityscanner", + "preferred": true, + "title": "Web Security Scanner API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workflowexecutions:v1beta", - "name": "workflowexecutions", - "version": "v1beta", - "title": "Workflow Executions API", "description": "Execute workflows created with Workflows API.", "discoveryRestUrl": "https://workflowexecutions.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/workflows", "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/workflows", - "preferred": false - }, - { + "id": "workflowexecutions:v1beta", "kind": "discovery#directoryItem", - "id": "workflowexecutions:v1", "name": "workflowexecutions", - "version": "v1", + "preferred": false, "title": "Workflow Executions API", + "version": "v1beta" + }, + { "description": "Execute workflows created with Workflows API.", "discoveryRestUrl": "https://workflowexecutions.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workflows", "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/workflows", - "preferred": true + "id": "workflowexecutions:v1", + "kind": "discovery#directoryItem", + "name": "workflowexecutions", + "preferred": true, + "title": "Workflow Executions API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workflows:v1beta", - "name": "workflows", - "version": "v1beta", - "title": "Workflows API", "description": "Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.", "discoveryRestUrl": "https://workflows.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/workflows", "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/workflows", - "preferred": false - }, - { + "id": "workflows:v1beta", "kind": "discovery#directoryItem", - "id": "workflows:v1", "name": "workflows", - "version": "v1", + "preferred": false, "title": "Workflows API", + "version": "v1beta" + }, + { "description": "Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.", "discoveryRestUrl": "https://workflows.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workflows", "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/workflows", - "preferred": true + "id": "workflows:v1", + "kind": "discovery#directoryItem", + "name": "workflows", + "preferred": true, + "title": "Workflows API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workloadmanager:v1", - "name": "workloadmanager", - "version": "v1", - "title": "Workload Manager API", "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", + "documentationLink": "https://cloud.google.com/workload-manager/docs", "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/workload-manager/docs", - "preferred": true + "id": "workloadmanager:v1", + "kind": "discovery#directoryItem", + "name": "workloadmanager", + "preferred": true, + "title": "Workload Manager API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workspaceevents:v1", - "name": "workspaceevents", - "version": "v1", - "title": "Google Workspace Events API", "description": "The Google Workspace Events API lets you subscribe to events and manage change notifications across Google Workspace applications.", "discoveryRestUrl": "https://workspaceevents.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/workspace/events", "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://developers.google.com/workspace/events", - "preferred": true + "id": "workspaceevents:v1", + "kind": "discovery#directoryItem", + "name": "workspaceevents", + "preferred": true, + "title": "Google Workspace Events API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "workstations:v1beta", - "name": "workstations", - "version": "v1beta", - "title": "Cloud Workstations API", "description": "Allows administrators to create managed developer environments in the cloud.", "discoveryRestUrl": "https://workstations.googleapis.com/$discovery/rest?version=v1beta", + "documentationLink": "https://cloud.google.com/workstations", "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/workstations", - "preferred": false - }, - { + "id": "workstations:v1beta", "kind": "discovery#directoryItem", - "id": "workstations:v1", "name": "workstations", - "version": "v1", + "preferred": false, "title": "Cloud Workstations API", + "version": "v1beta" + }, + { "description": "Allows administrators to create managed developer environments in the cloud.", "discoveryRestUrl": "https://workstations.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://cloud.google.com/workstations", "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/workstations", - "preferred": true + "id": "workstations:v1", + "kind": "discovery#directoryItem", + "name": "workstations", + "preferred": true, + "title": "Cloud Workstations API", + "version": "v1" }, { - "kind": "discovery#directoryItem", - "id": "youtube:v3", - "name": "youtube", - "version": "v3", - "title": "YouTube Data API v3", "description": "The YouTube Data API v3 is an API that provides access to YouTube data, such as videos, playlists, and channels.", "discoveryRestUrl": "https://youtube.googleapis.com/$discovery/rest?version=v3", + "documentationLink": "https://developers.google.com/youtube/", "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://developers.google.com/youtube/", - "preferred": true + "id": "youtube:v3", + "kind": "discovery#directoryItem", + "name": "youtube", + "preferred": true, + "title": "YouTube Data API v3", + "version": "v3" }, { - "kind": "discovery#directoryItem", - "id": "youtubeAnalytics:v2", - "name": "youtubeAnalytics", - "version": "v2", - "title": "YouTube Analytics API", "description": "Retrieves your YouTube Analytics data.", "discoveryRestUrl": "https://youtubeanalytics.googleapis.com/$discovery/rest?version=v2", + "documentationLink": "https://developers.google.com/youtube/analytics", "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://developers.google.com/youtube/analytics", - "preferred": true + "id": "youtubeAnalytics:v2", + "kind": "discovery#directoryItem", + "name": "youtubeAnalytics", + "preferred": true, + "title": "YouTube Analytics API", + "version": "v2" }, { - "kind": "discovery#directoryItem", - "id": "youtubereporting:v1", - "name": "youtubereporting", - "version": "v1", - "title": "YouTube Reporting API", "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.", "discoveryRestUrl": "https://youtubereporting.googleapis.com/$discovery/rest?version=v1", + "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/", "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://developers.google.com/youtube/reporting/v1/reports/", - "preferred": true + "id": "youtubereporting:v1", + "kind": "discovery#directoryItem", + "name": "youtubereporting", + "preferred": true, + "title": "YouTube Reporting API", + "version": "v1" } - ] + ], + "kind": "discovery#directoryList" } \ No newline at end of file diff --git a/discovery/integrations-v1.json b/discovery/integrations-v1.json index 0474e03293..5e5c5a96f3 100644 --- a/discovery/integrations-v1.json +++ b/discovery/integrations-v1.json @@ -3790,6 +3790,46 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "download": { + "description": "Downloads a template. Retrieves the `Template` and returns the response as a string.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:download", + "httpMethod": "GET", + "id": "integrations.projects.locations.templates.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "fileFormat": { + "description": "Required. File format for download request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The template to download. Format: projects/{project}/locations/{location}/template/{template_id}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/templates/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:download", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Get a template in the specified project.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}", @@ -4037,6 +4077,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "upload": { + "description": "Uploads a template. The content can be a previously downloaded template. Performs the same function as CreateTemplate, but accepts input in a string format, which holds the complete representation of the Template content.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates:upload", + "httpMethod": "POST", + "id": "integrations.projects.locations.templates.upload", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The template to upload. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/templates:upload", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadTemplateRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaUploadTemplateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "use": { "description": "Use the template to create integration. This api would keep track of usage_count and last_used_time. PERMISSION_DENIED would be thrown if template is not accessible by client.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/templates/{templatesId}:use", @@ -4072,7 +4140,7 @@ } } }, - "revision": "20240622", + "revision": "20240707", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -5277,6 +5345,10 @@ "description": "Represents external traffic type and id.", "id": "EnterpriseCrmEventbusProtoExternalTraffic", "properties": { + "enableInternalIp": { + "description": "Indicates the client enables internal IP feature, this is applicable for internal clients only.", + "type": "boolean" + }, "gcpProjectId": { "description": "User’s GCP project id the traffic is referring to.", "type": "string" @@ -10114,6 +10186,10 @@ "description": "Description of what the client is used for", "type": "string" }, + "enableInternalIp": { + "description": "Optional. Indicates the client enables internal IP feature, this is applicable for internal clients only.", + "type": "boolean" + }, "enableVariableMasking": { "description": "Optional. True if variable masking feature should be turned on for this region", "type": "boolean" @@ -10469,6 +10545,17 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse": { + "description": "Response for DownloadTemplate.", + "id": "GoogleCloudIntegrationsV1alphaDownloadTemplateResponse", + "properties": { + "content": { + "description": "String representation of the template.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse": { "description": "Response containing all provisioned regions for Connector Platform.", "id": "GoogleCloudIntegrationsV1alphaEnumerateConnectorPlatformRegionsResponse", @@ -11013,16 +11100,20 @@ "description": "Request to Import template", "id": "GoogleCloudIntegrationsV1alphaImportTemplateRequest", "properties": { - "configParameters": { - "description": "Optional. Config parameters which would be used to configure template bundles.", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" - }, - "type": "array" - }, "integration": { "description": "Required. Name of the integration where template needs to be imported.", "type": "string" + }, + "integrationRegion": { + "description": "Required. The region of the Integration to be created.", + "type": "string" + }, + "subIntegrations": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" + }, + "description": "Optional. Sub Integration which would be created via templates.", + "type": "object" } }, "type": "object" @@ -11516,16 +11607,13 @@ "description": "Define the template of IntegrationVersion.", "id": "GoogleCloudIntegrationsV1alphaIntegrationVersionTemplate", "properties": { - "configParameters": { - "description": "Required. Config parameters which are required for the integration template. These config parameters would be requested by users while creating integration.", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" - }, - "type": "array" - }, "integrationVersion": { "$ref": "GoogleCloudIntegrationsV1alphaIntegrationVersion", "description": "Required. Templatized version of integration." + }, + "key": { + "description": "Required. Unique Key of the IntegrationVersion.", + "type": "string" } }, "type": "object" @@ -12970,7 +13058,7 @@ "enum": [ "CATEGORY_UNSPECIFIED", "AI_MACHINE_LEARNING", - "BUSINESS_INTELLIGENCE_", + "BUSINESS_INTELLIGENCE", "COLLABORATION", "CUSTOMER_SERVICE", "DATABASES", @@ -13383,23 +13471,74 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaUploadTemplateRequest": { + "description": "Request for UploadTemplate.", + "id": "GoogleCloudIntegrationsV1alphaUploadTemplateRequest", + "properties": { + "content": { + "description": "Required. The textproto of the template.", + "type": "string" + }, + "fileFormat": { + "description": "Required. File format for upload request.", + "enum": [ + "FILE_FORMAT_UNSPECIFIED", + "JSON", + "YAML" + ], + "enumDescriptions": [ + "Unspecified file format", + "JSON File Format", + "YAML File Format" + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUploadTemplateResponse": { + "description": "Response for UploadTemplate.", + "id": "GoogleCloudIntegrationsV1alphaUploadTemplateResponse", + "properties": { + "template": { + "$ref": "GoogleCloudIntegrationsV1alphaTemplate", + "description": "The uploaded Template" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaUseTemplateRequest": { "description": "Request to Use template", "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequest", "properties": { - "configParameters": { - "description": "Optional. Config parameters which would be used to configure template bundles.", - "items": { - "$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" - }, - "type": "array" + "integrationDetails": { + "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails", + "description": "Required. Integration details which would be created via templates." }, + "integrationRegion": { + "description": "Required. The region of the Integration to be created.", + "type": "string" + }, + "subIntegrations": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" + }, + "description": "Optional. Sub Integration which would be created via templates.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails": { + "description": "Sub Integration which would be created via templates.", + "id": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails", + "properties": { "integration": { - "description": "Required. Name of the integration which would be created via templates.", + "description": "Required. Name of the sub integration which would be created via templates.", "type": "string" }, "integrationDescription": { - "description": "Optional. Description of the integration which would be created via templates.", + "description": "Optional. Description of the sub integration which would be created via templates.", "type": "string" } }, diff --git a/discovery/keep-v1.json b/discovery/keep-v1.json new file mode 100644 index 0000000000..05a86882c5 --- /dev/null +++ b/discovery/keep-v1.json @@ -0,0 +1,623 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/keep": { + "description": "See, edit, create and permanently delete all your Google Keep data" + }, + "https://www.googleapis.com/auth/keep.readonly": { + "description": "View all your Google Keep data" + } + } + } + }, + "basePath": "", + "baseUrl": "https://keep.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Keep", + "description": "The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/keep/api", + "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": "keep:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://keep.mtls.googleapis.com/", + "name": "keep", + "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": { + "media": { + "methods": { + "download": { + "description": "Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.", + "flatPath": "v1/notes/{notesId}/attachments/{attachmentsId}", + "httpMethod": "GET", + "id": "keep.media.download", + "parameterOrder": [ + "name" + ], + "parameters": { + "mimeType": { + "description": "The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The name of the attachment.", + "location": "path", + "pattern": "^notes/[^/]+/attachments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Attachment" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep", + "https://www.googleapis.com/auth/keep.readonly" + ], + "supportsMediaDownload": true, + "useMediaDownloadService": true + } + } + }, + "notes": { + "methods": { + "create": { + "description": "Creates a new note.", + "flatPath": "v1/notes", + "httpMethod": "POST", + "id": "keep.notes.create", + "parameterOrder": [], + "parameters": {}, + "path": "v1/notes", + "request": { + "$ref": "Note" + }, + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep" + ] + }, + "delete": { + "description": "Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note.", + "flatPath": "v1/notes/{notesId}", + "httpMethod": "DELETE", + "id": "keep.notes.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the note to delete.", + "location": "path", + "pattern": "^notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep" + ] + }, + "get": { + "description": "Gets a note.", + "flatPath": "v1/notes/{notesId}", + "httpMethod": "GET", + "id": "keep.notes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource.", + "location": "path", + "pattern": "^notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Note" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep", + "https://www.googleapis.com/auth/keep.readonly" + ] + }, + "list": { + "description": "Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error.", + "flatPath": "v1/notes", + "httpMethod": "GET", + "id": "keep.notes.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `create_time`, `update_time`, `trash_time`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160).", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The previous page's `next_page_token` field.", + "location": "query", + "type": "string" + } + }, + "path": "v1/notes", + "response": { + "$ref": "ListNotesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep", + "https://www.googleapis.com/auth/keep.readonly" + ] + } + }, + "resources": { + "permissions": { + "methods": { + "batchCreate": { + "description": "Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made.", + "flatPath": "v1/notes/{notesId}/permissions:batchCreate", + "httpMethod": "POST", + "id": "keep.notes.permissions.batchCreate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "The parent resource shared by all Permissions being created. Format: `notes/{note}` If this is set, the parent field in the CreatePermission messages must either be empty or match this field.", + "location": "path", + "pattern": "^notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/permissions:batchCreate", + "request": { + "$ref": "BatchCreatePermissionsRequest" + }, + "response": { + "$ref": "BatchCreatePermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep" + ] + }, + "batchDelete": { + "description": "Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.", + "flatPath": "v1/notes/{notesId}/permissions:batchDelete", + "httpMethod": "POST", + "id": "keep.notes.permissions.batchDelete", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "The parent resource shared by all permissions being deleted. Format: `notes/{note}` If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field.", + "location": "path", + "pattern": "^notes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/permissions:batchDelete", + "request": { + "$ref": "BatchDeletePermissionsRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/keep" + ] + } + } + } + } + } + }, + "revision": "20220322", + "rootUrl": "https://keep.googleapis.com/", + "schemas": { + "Attachment": { + "description": "An attachment to a note.", + "id": "Attachment", + "properties": { + "mimeType": { + "description": "The MIME types (IANA media types) in which the attachment is available.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "The resource name;", + "type": "string" + } + }, + "type": "object" + }, + "BatchCreatePermissionsRequest": { + "description": "The request to add one or more permissions on the note. Currently, only the `WRITER` role may be specified. If adding a permission fails, then the entire request fails and no changes are made.", + "id": "BatchCreatePermissionsRequest", + "properties": { + "requests": { + "description": "The request message specifying the resources to create.", + "items": { + "$ref": "CreatePermissionRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchCreatePermissionsResponse": { + "description": "The response for creating permissions on a note.", + "id": "BatchCreatePermissionsResponse", + "properties": { + "permissions": { + "description": "Permissions created.", + "items": { + "$ref": "Permission" + }, + "type": "array" + } + }, + "type": "object" + }, + "BatchDeletePermissionsRequest": { + "description": "The request to remove one or more permissions from a note. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note.", + "id": "BatchDeletePermissionsRequest", + "properties": { + "names": { + "description": "Required. The names of the permissions to delete. Format: `notes/{note}/permissions/{permission}`", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CreatePermissionRequest": { + "description": "The request to add a single permission on the note.", + "id": "CreatePermissionRequest", + "properties": { + "parent": { + "description": "Required. The parent note where this permission will be created. Format: `notes/{note}`", + "type": "string" + }, + "permission": { + "$ref": "Permission", + "description": "Required. The permission to create. One of Permission.email, User.email or Group.email must be supplied." + } + }, + "type": "object" + }, + "Empty": { + "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", + "id": "Empty", + "properties": {}, + "type": "object" + }, + "Family": { + "description": "Describes a single Google Family.", + "id": "Family", + "properties": {}, + "type": "object" + }, + "Group": { + "description": "Describes a single Group.", + "id": "Group", + "properties": { + "email": { + "description": "The group email.", + "type": "string" + } + }, + "type": "object" + }, + "ListContent": { + "description": "The list of items for a single list note.", + "id": "ListContent", + "properties": { + "listItems": { + "description": "The items in the list. The number of items must be less than 1,000.", + "items": { + "$ref": "ListItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListItem": { + "description": "A single list item in a note's list.", + "id": "ListItem", + "properties": { + "checked": { + "description": "Whether this item has been checked off or not.", + "type": "boolean" + }, + "childListItems": { + "description": "If set, list of list items nested under this list item. Only one level of nesting is allowed.", + "items": { + "$ref": "ListItem" + }, + "type": "array" + }, + "text": { + "$ref": "TextContent", + "description": "The text of this item. Length must be less than 1,000 characters." + } + }, + "type": "object" + }, + "ListNotesResponse": { + "description": "The response when listing a page of notes.", + "id": "ListNotesResponse", + "properties": { + "nextPageToken": { + "description": "Next page's `page_token` field.", + "type": "string" + }, + "notes": { + "description": "A page of notes.", + "items": { + "$ref": "Note" + }, + "type": "array" + } + }, + "type": "object" + }, + "Note": { + "description": "A single note.", + "id": "Note", + "properties": { + "attachments": { + "description": "Output only. The attachments attached to this note.", + "items": { + "$ref": "Attachment" + }, + "readOnly": true, + "type": "array" + }, + "body": { + "$ref": "Section", + "description": "The body of the note." + }, + "createTime": { + "description": "Output only. When this note was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of this note. See general note on identifiers in KeepService.", + "readOnly": true, + "type": "string" + }, + "permissions": { + "description": "Output only. The list of permissions set on the note. Contains at least one entry for the note owner.", + "items": { + "$ref": "Permission" + }, + "readOnly": true, + "type": "array" + }, + "title": { + "description": "The title of the note. Length must be less than 1,000 characters.", + "type": "string" + }, + "trashTime": { + "description": "Output only. When this note was trashed. If `trashed`, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is `false`).", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "trashed": { + "description": "Output only. `true` if this note has been trashed. If trashed, the note is eventually deleted.", + "readOnly": true, + "type": "boolean" + }, + "updateTime": { + "description": "Output only. When this note was last modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Permission": { + "description": "A single permission on the note. Associates a `member` with a `role`.", + "id": "Permission", + "properties": { + "deleted": { + "description": "Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note.", + "readOnly": true, + "type": "boolean" + }, + "email": { + "description": "The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email.", + "type": "string" + }, + "family": { + "$ref": "Family", + "description": "Output only. The Google Family to which this role applies.", + "readOnly": true + }, + "group": { + "$ref": "Group", + "description": "Output only. The group to which this role applies.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name.", + "readOnly": true, + "type": "string" + }, + "role": { + "description": "The role granted by this permission. The role determines the entity’s ability to read, write, and share notes.", + "enum": [ + "ROLE_UNSPECIFIED", + "OWNER", + "WRITER" + ], + "enumDescriptions": [ + "An undefined role.", + "A role granting full access. This role cannot be added or removed. Defined by the creator of the note.", + "A role granting the ability to contribute content and modify note permissions." + ], + "type": "string" + }, + "user": { + "$ref": "User", + "description": "Output only. The user to whom this role applies.", + "readOnly": true + } + }, + "type": "object" + }, + "Section": { + "description": "The content of the note.", + "id": "Section", + "properties": { + "list": { + "$ref": "ListContent", + "description": "Used if this section's content is a list." + }, + "text": { + "$ref": "TextContent", + "description": "Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters." + } + }, + "type": "object" + }, + "TextContent": { + "description": "The block of text for a single text section or list item.", + "id": "TextContent", + "properties": { + "text": { + "description": "The text of the note. The limits on this vary with the specific field using this type.", + "type": "string" + } + }, + "type": "object" + }, + "User": { + "description": "Describes a single user.", + "id": "User", + "properties": { + "email": { + "description": "The user's email.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Google Keep API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/language-v2.json b/discovery/language-v2.json index 0e1a289197..2ca253270c 100644 --- a/discovery/language-v2.json +++ b/discovery/language-v2.json @@ -208,7 +208,7 @@ } } }, - "revision": "20240310", + "revision": "20240713", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -577,6 +577,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -862,6 +863,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1108,6 +1110,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1393,6 +1396,7 @@ "", "", "", + "", "" ], "type": "string" @@ -1525,6 +1529,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", + "A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1810,6 +1815,7 @@ "", "", "", + "", "" ], "type": "string" @@ -2968,6 +2974,7 @@ "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", + "NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -2984,6 +2991,7 @@ "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", + "Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 5db00b4cf9..ae4c3db784 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -29,84 +29,84 @@ "documentationLink": "https://cloud.google.com/logging/docs/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-east7.rep.googleapis.com/", - "location": "us-east7", - "description": "Regional Endpoint" + "location": "us-east7" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://logging.us-west8.rep.googleapis.com/", - "location": "us-west8", - "description": "Regional Endpoint" + "location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -1362,6 +1362,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -2053,7 +2058,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", + "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -3274,6 +3279,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -4700,7 +4710,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", + "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5921,6 +5931,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7552,6 +7567,11 @@ "parent" ], "parameters": { + "filter": { + "description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", + "location": "query", + "type": "string" + }, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -8376,7 +8396,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", + "description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -8404,7 +8424,7 @@ } } }, - "revision": "20240620", + "revision": "20240726", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { @@ -8962,7 +8982,7 @@ "type": "string" }, "fieldPath": { - "description": "Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status", + "description": "Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/analyze/custom-index) for details.For example: jsonPayload.request.status", "type": "string" }, "type": { @@ -9232,7 +9252,7 @@ "type": "array" }, "resourceNames": { - "description": "Required. Names of one or more parent resources from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list. A maximum of 100 resources may be specified in a single request.", + "description": "Required. Names of one or more parent resources from which to retrieve log entries. Resources may either be resource containers or specific LogViews. For the case of resource containers, all logs ingested into that container will be returned regardless of which LogBuckets they are actually stored in - i.e. these queries may fan out to multiple regions. In the event of region unavailability, specify a specific set of LogViews that do not include the unavailable region. projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list. A maximum of 100 resources may be specified in a single request.", "items": { "type": "string" }, diff --git a/discovery/manufacturers-v1.json b/discovery/manufacturers-v1.json index 45adff4ccc..e163193ceb 100644 --- a/discovery/manufacturers-v1.json +++ b/discovery/manufacturers-v1.json @@ -416,7 +416,7 @@ } } }, - "revision": "20231113", + "revision": "20240809", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -513,6 +513,13 @@ }, "type": "array" }, + "intendedCountry": { + "description": "Optional. List of countries to show this product in. Countries provided in this attribute will override any of the countries configured at feed level. The values should be: the [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries in which this item will be shown.", + "items": { + "type": "string" + }, + "type": "array" + }, "itemGroupId": { "description": "The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid.", "type": "string" @@ -697,10 +704,34 @@ "description": "The destination status.", "id": "DestinationStatus", "properties": { + "approvedCountries": { + "description": "Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "destination": { "description": "The name of the destination.", "type": "string" }, + "disapprovedCountries": { + "description": "Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "pendingCountries": { + "description": "Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "status": { "description": "The status of the destination.", "enum": [ @@ -892,6 +923,14 @@ "description": "Product issue.", "id": "Issue", "properties": { + "applicableCountries": { + "description": "Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "attribute": { "description": "If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.", "type": "string" @@ -1216,6 +1255,10 @@ }, "type": "array" }, + "feedLabel": { + "description": "Optional. The feed label for the product.", + "type": "string" + }, "issues": { "description": "A server-generated list of issues associated with the product.", "items": { diff --git a/discovery/meet-v2.json b/discovery/meet-v2.json index 54ef93fb5a..79728573fd 100644 --- a/discovery/meet-v2.json +++ b/discovery/meet-v2.json @@ -543,7 +543,7 @@ ] }, "endActiveConference": { - "description": "Ends an active conference (if there's one).", + "description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).", "flatPath": "v2/spaces/{spacesId}:endActiveConference", "httpMethod": "POST", "id": "meet.spaces.endActiveConference", @@ -552,7 +552,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space.", + "description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -571,7 +571,7 @@ ] }, "get": { - "description": "Gets a space by `space_id` or `meeting_code`.", + "description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "GET", "id": "meet.spaces.get", @@ -580,7 +580,7 @@ ], "parameters": { "name": { - "description": "Required. Resource name of the space.", + "description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -597,7 +597,7 @@ ] }, "patch": { - "description": "Updates a space.", + "description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "PATCH", "id": "meet.spaces.patch", @@ -606,14 +606,14 @@ ], "parameters": { "name": { - "description": "Immutable. Resource name of the space. Format: `spaces/{space}`", + "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request.", + "description": "Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has \"\" as paths), it defaults to update all fields provided with values in the request. Using \"*\" as update_mask will update all fields, including deleting fields not set in the request.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -633,7 +633,7 @@ } } }, - "revision": "20240627", + "revision": "20240808", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -1000,17 +1000,17 @@ "description": "Configuration pertaining to the meeting space." }, "meetingCode": { - "description": "Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space.", + "description": "Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.", "readOnly": true, "type": "string" }, "meetingUri": { - "description": "Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`.", + "description": "Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.", "readOnly": true, "type": "string" }, "name": { - "description": "Immutable. Resource name of the space. Format: `spaces/{space}`", + "description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "type": "string" } }, diff --git a/discovery/merchantapi-accounts_v1beta.json b/discovery/merchantapi-accounts_v1beta.json index 301647be78..cfcd0d6791 100644 --- a/discovery/merchantapi-accounts_v1beta.json +++ b/discovery/merchantapi-accounts_v1beta.json @@ -175,106 +175,6 @@ "https://www.googleapis.com/auth/content" ] }, - "getBusinessIdentity": { - "description": "Retrieves the business identity of an account.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", - "httpMethod": "GET", - "id": "merchantapi.accounts.getBusinessIdentity", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", - "location": "path", - "pattern": "^accounts/[^/]+/businessIdentity$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "BusinessIdentity" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "getBusinessInfo": { - "description": "Retrieves the business info of an account.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", - "httpMethod": "GET", - "id": "merchantapi.accounts.getBusinessInfo", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", - "location": "path", - "pattern": "^accounts/[^/]+/businessInfo$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "BusinessInfo" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "getHomepage": { - "description": "Retrieves a store's homepage.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", - "httpMethod": "GET", - "id": "merchantapi.accounts.getHomepage", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", - "location": "path", - "pattern": "^accounts/[^/]+/homepage$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "Homepage" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "getShippingSettings": { - "description": "Retrieve shipping setting information.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", - "httpMethod": "GET", - "id": "merchantapi.accounts.getShippingSettings", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", - "location": "path", - "pattern": "^accounts/[^/]+/shippingSettings$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "ShippingSettings" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, "list": { "description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.", "flatPath": "accounts/v1beta/accounts", @@ -376,192 +276,180 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] - }, - "updateBusinessIdentity": { - "description": "Updates the business identity of an account. Executing this method requires admin access.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.updateBusinessIdentity", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", - "location": "path", - "pattern": "^accounts/[^/]+/businessIdentity$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "BusinessIdentity" - }, - "response": { - "$ref": "BusinessIdentity" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "updateBusinessInfo": { - "description": "Updates the business info of an account. Executing this method requires admin access.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.updateBusinessInfo", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", - "location": "path", - "pattern": "^accounts/[^/]+/businessInfo$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "BusinessInfo" - }, - "response": { - "$ref": "BusinessInfo" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, - "updateHomepage": { - "description": "Updates a store's homepage. Executing this method requires admin access.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.updateHomepage", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", - "location": "path", - "pattern": "^accounts/[^/]+/homepage$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "Homepage" - }, - "response": { - "$ref": "Homepage" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] } }, "resources": { - "accounttax": { + "businessIdentity": { "methods": { - "get": { - "description": "Returns the tax rules that match the conditions of GetAccountTaxRequest", - "flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", + "getBusinessIdentity": { + "description": "Retrieves the business identity of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", "httpMethod": "GET", - "id": "merchantapi.accounts.accounttax.get", + "id": "merchantapi.accounts.businessIdentity.getBusinessIdentity", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name from which tax settings will be retrieved", + "description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", "location": "path", - "pattern": "^accounts/[^/]+/accounttax/[^/]+$", + "pattern": "^accounts/[^/]+/businessIdentity$", "required": true, "type": "string" } }, "path": "accounts/v1beta/{+name}", "response": { - "$ref": "AccountTax" + "$ref": "BusinessIdentity" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, - "list": { - "description": "Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax", - "httpMethod": "GET", - "id": "merchantapi.accounts.accounttax.list", + "updateBusinessIdentity": { + "description": "Updates the business identity of an account. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.businessIdentity.updateBusinessIdentity", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "pageSize": { - "description": "The maximum number of tax settings to return in the response, used for paging.", - "format": "int32", - "location": "query", - "type": "integer" + "name": { + "description": "Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", + "location": "path", + "pattern": "^accounts/[^/]+/businessIdentity$", + "required": true, + "type": "string" }, - "pageToken": { - "description": "The token returned by the previous request.", + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", "location": "query", "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "BusinessIdentity" + }, + "response": { + "$ref": "BusinessIdentity" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "businessInfo": { + "methods": { + "getBusinessInfo": { + "description": "Retrieves the business info of an account.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", + "httpMethod": "GET", + "id": "merchantapi.accounts.businessInfo.getBusinessInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", + "location": "path", + "pattern": "^accounts/[^/]+/businessInfo$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "BusinessInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, + "updateBusinessInfo": { + "description": "Updates the business info of an account. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.businessInfo.updateBusinessInfo", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", + "location": "path", + "pattern": "^accounts/[^/]+/businessInfo$", + "required": true, + "type": "string" }, - "parent": { - "description": "Required. The parent, which owns this collection of account tax. Format: accounts/{account}", + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "BusinessInfo" + }, + "response": { + "$ref": "BusinessInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + } + } + }, + "emailpreferences": { + "methods": { + "getEmailPreferences": { + "description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", + "httpMethod": "GET", + "id": "merchantapi.accounts.emailpreferences.getEmailPreferences", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", "location": "path", - "pattern": "^accounts/[^/]+$", + "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", "required": true, "type": "string" } }, - "path": "accounts/v1beta/{+parent}/accounttax", + "path": "accounts/v1beta/{+name}", "response": { - "$ref": "ListAccountTaxResponse" + "$ref": "EmailPreferences" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, - "patch": { - "description": "Updates the tax settings of the account.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", + "updateEmailPreferences": { + "description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", "httpMethod": "PATCH", - "id": "merchantapi.accounts.accounttax.patch", + "id": "merchantapi.accounts.emailpreferences.updateEmailPreferences", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Identifier. The name of the tax setting. Format: \"{account_tax.name=accounts/{account}}\"", + "description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", "location": "path", - "pattern": "^accounts/[^/]+/accounttax/[^/]+$", + "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", "required": true, "type": "string" }, "updateMask": { - "description": "The list of fields to be updated", + "description": "Required. List of fields being updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -569,10 +457,10 @@ }, "path": "accounts/v1beta/{+name}", "request": { - "$ref": "AccountTax" + "$ref": "EmailPreferences" }, "response": { - "$ref": "AccountTax" + "$ref": "EmailPreferences" }, "scopes": [ "https://www.googleapis.com/auth/content" @@ -610,6 +498,31 @@ "https://www.googleapis.com/auth/content" ] }, + "getHomepage": { + "description": "Retrieves a store's homepage.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", + "httpMethod": "GET", + "id": "merchantapi.accounts.homepage.getHomepage", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", + "location": "path", + "pattern": "^accounts/[^/]+/homepage$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "Homepage" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "unclaim": { "description": "Unclaims a store's homepage. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage:unclaim", @@ -637,6 +550,40 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] + }, + "updateHomepage": { + "description": "Updates a store's homepage. Executing this method requires admin access.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", + "httpMethod": "PATCH", + "id": "merchantapi.accounts.homepage.updateHomepage", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", + "location": "path", + "pattern": "^accounts/[^/]+/homepage$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. List of fields being updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "request": { + "$ref": "Homepage" + }, + "response": { + "$ref": "Homepage" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] } } }, @@ -1040,6 +987,31 @@ }, "shippingSettings": { "methods": { + "getShippingSettings": { + "description": "Retrieve shipping setting information.", + "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", + "httpMethod": "GET", + "id": "merchantapi.accounts.shippingSettings.getShippingSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", + "location": "path", + "pattern": "^accounts/[^/]+/shippingSettings$", + "required": true, + "type": "string" + } + }, + "path": "accounts/v1beta/{+name}", + "response": { + "$ref": "ShippingSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/content" + ] + }, "insert": { "description": "Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings:insert", @@ -1082,7 +1054,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", + "description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", "location": "path", "pattern": "^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$", "required": true, @@ -1209,31 +1181,6 @@ "https://www.googleapis.com/auth/content" ] }, - "getEmailPreferences": { - "description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", - "httpMethod": "GET", - "id": "merchantapi.accounts.users.getEmailPreferences", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", - "location": "path", - "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", - "required": true, - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "response": { - "$ref": "EmailPreferences" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] - }, "list": { "description": "Lists all users of a Merchant Center account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users", @@ -1303,40 +1250,6 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] - }, - "updateEmailPreferences": { - "description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", - "flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", - "httpMethod": "PATCH", - "id": "merchantapi.accounts.users.updateEmailPreferences", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", - "location": "path", - "pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. List of fields being updated.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "accounts/v1beta/{+name}", - "request": { - "$ref": "EmailPreferences" - }, - "response": { - "$ref": "EmailPreferences" - }, - "scopes": [ - "https://www.googleapis.com/auth/content" - ] } } } @@ -1441,7 +1354,7 @@ } } }, - "revision": "20240614", + "revision": "20240806", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -1562,30 +1475,6 @@ }, "type": "object" }, - "AccountTax": { - "description": "The tax settings of a merchant account. All methods require the admin role.", - "id": "AccountTax", - "properties": { - "account": { - "description": "Output only. The ID of the account to which these account tax settings belong.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Identifier. The name of the tax setting. Format: \"{account_tax.name=accounts/{account}}\"", - "type": "string" - }, - "taxRules": { - "description": "Tax rules. \"Define the tax rules in each region. No tax will be presented if a region has no rule.\"", - "items": { - "$ref": "TaxRule" - }, - "type": "array" - } - }, - "type": "object" - }, "AddAccountService": { "description": "Additional instructions to add account services during creation of the account.", "id": "AddAccountService", @@ -1796,7 +1685,7 @@ "description": "Required. The account to be created." }, "service": { - "description": "Optional. If specified, an account service between the account to be created and the provider account is initialized as part of the creation.", + "description": "Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently only `account_aggregation` is supported which means the newly created account will be a subaccount of the provider defined in the `account_aggregation` service.", "items": { "$ref": "AddAccountService" }, @@ -2228,23 +2117,6 @@ }, "type": "object" }, - "Interval": { - "description": "Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.", - "id": "Interval", - "properties": { - "endTime": { - "description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", - "format": "google-datetime", - "type": "string" - }, - "startTime": { - "description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", - "format": "google-datetime", - "type": "string" - } - }, - "type": "object" - }, "ListAccountIssuesResponse": { "description": "Response message for the `ListAccountIssues` method.", "id": "ListAccountIssuesResponse", @@ -2263,24 +2135,6 @@ }, "type": "object" }, - "ListAccountTaxResponse": { - "description": "Response to account tax list request This method can only be called on a multi-client account, otherwise it'll return an error.", - "id": "ListAccountTaxResponse", - "properties": { - "accountTaxes": { - "description": "Page of accounttax settings", - "items": { - "$ref": "AccountTax" - }, - "type": "array" - }, - "nextPageToken": { - "description": "The token for the retrieval of the next page of account tax settings.", - "type": "string" - } - }, - "type": "object" - }, "ListAccountsResponse": { "description": "Response message for the `ListAccounts` method.", "id": "ListAccountsResponse", @@ -3250,58 +3104,6 @@ }, "type": "object" }, - "TaxPostalCodeRange": { - "description": "A range of postal codes that defines the area.", - "id": "TaxPostalCodeRange", - "properties": { - "end": { - "description": "The end of the postal code range. Will be the same as start if not specified.", - "type": "string" - }, - "start": { - "description": "Required. The start of the postal code range, which is also the smallest in the range.", - "type": "string" - } - }, - "type": "object" - }, - "TaxRule": { - "description": "Primary type convension percent micro : 100% = 1 000 000 and 1% = 10 000 cannot be negative. Information about tax nexus and related parameters applicable to orders delivered to the area covered by a single tax admin. Nexus is created when a merchant is doing business in an area administered by tax admin (only US states are supported for nexus configuration). If merchant has nexus in a US state, merchant needs to pay tax to all tax authorities associated with the shipping destination. Next Id : 8", - "id": "TaxRule", - "properties": { - "effectiveTimePeriod": { - "$ref": "Interval", - "description": "Required. Time period when this rule is effective. If the duration is missing from effective_time listed, then it is open ended to the future. The start of this time period is inclusive, and the end is exclusive." - }, - "locationId": { - "description": "The admin_id or criteria_id of the region in which this rule is applicable.", - "format": "int64", - "type": "string" - }, - "postCodeRange": { - "$ref": "TaxPostalCodeRange", - "description": "The range of postal codes in which this rule is applicable." - }, - "regionCode": { - "description": "Region code in which this rule is applicable", - "type": "string" - }, - "selfSpecifiedRateMicros": { - "description": "A fixed rate specified in micros, where 100% = 1_000_000. Suitable for origin-based states.", - "format": "int64", - "type": "string" - }, - "shippingTaxed": { - "description": "If set, shipping charge is taxed (at the same rate as product) when delivering to this admin's area. Can only be set on US states without category.", - "type": "boolean" - }, - "useGoogleRate": { - "description": "Rate that depends on delivery location: if merchant has a nexus in corresponding US state, rates from authorities with jurisdiction over delivery area are added up.", - "type": "boolean" - } - }, - "type": "object" - }, "TermsOfService": { "description": "A `TermsOfService`.", "id": "TermsOfService", @@ -3346,7 +3148,7 @@ "description": "The accepted terms of service of this kind and for the associated region_code" }, "name": { - "description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", + "description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US`", "type": "string" }, "regionCode": { diff --git a/discovery/merchantapi-datasources_v1beta.json b/discovery/merchantapi-datasources_v1beta.json index 67ffa2e009..ce6398bcfa 100644 --- a/discovery/merchantapi-datasources_v1beta.json +++ b/discovery/merchantapi-datasources_v1beta.json @@ -290,7 +290,7 @@ } } }, - "revision": "20240614", + "revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -526,7 +526,7 @@ "Not specified.", "Online product.", "Local product.", - "Unified data source for both local and online products." + "Unified data source for both local and online products. Note: Products management through the API is not possible for this channel." ], "type": "string" }, diff --git a/discovery/merchantapi-products_v1beta.json b/discovery/merchantapi-products_v1beta.json index dfb640b9cd..31b3603c8f 100644 --- a/discovery/merchantapi-products_v1beta.json +++ b/discovery/merchantapi-products_v1beta.json @@ -242,7 +242,7 @@ } } }, - "revision": "20240614", + "revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1085,6 +1085,10 @@ "format": "int64", "type": "string" }, + "memberPriceEffectiveDate": { + "$ref": "Interval", + "description": "A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash." + }, "price": { "$ref": "Price", "description": "The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price." diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index c36e218787..56363ceb62 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1684,7 +1684,7 @@ } } }, - "revision": "20240627", + "revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2060,6 +2060,31 @@ }, "type": "object" }, + "CustomRegionMetadata": { + "description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", + "id": "CustomRegionMetadata", + "properties": { + "optionalReadOnlyRegions": { + "description": "The read-only regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredReadWriteRegions": { + "description": "The read-write regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "witnessRegion": { + "description": "The Spanner witness region for this custom region.", + "type": "string" + } + }, + "type": "object" + }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2608,6 +2633,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "customRegionMetadata": { + "description": "Possible configurations supported if the current region is a custom region.", + "items": { + "$ref": "CustomRegionMetadata" + }, + "type": "array" + }, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3363,6 +3395,7 @@ "UPDATING", "DELETING", "ERROR", + "AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3374,6 +3407,7 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", + "The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index ed1b090fc8..4382f0af6d 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1796,7 +1796,7 @@ } } }, - "revision": "20240613", + "revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,6 +2196,52 @@ }, "type": "object" }, + "CustomRegionConfig": { + "description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", + "id": "CustomRegionConfig", + "properties": { + "readOnlyRegions": { + "description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readWriteRegions": { + "description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomRegionMetadata": { + "description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", + "id": "CustomRegionMetadata", + "properties": { + "optionalReadOnlyRegions": { + "description": "The read-only regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredReadWriteRegions": { + "description": "The read-write regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "witnessRegion": { + "description": "The Spanner witness region for this custom region.", + "type": "string" + } + }, + "type": "object" + }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2769,6 +2815,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "customRegionMetadata": { + "description": "Possible configurations supported if the current region is a custom region.", + "items": { + "$ref": "CustomRegionMetadata" + }, + "type": "array" + }, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3071,6 +3124,25 @@ "properties": {}, "type": "object" }, + "MultiRegionConfig": { + "description": "The multi-region config for the Dataproc Metastore service.", + "id": "MultiRegionConfig", + "properties": { + "certificates": { + "deprecated": true, + "description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", + "items": { + "$ref": "RootCACertificate" + }, + "readOnly": true, + "type": "array" + }, + "customRegionConfig": { + "$ref": "CustomRegionConfig" + } + }, + "type": "object" + }, "MultiRegionMetadata": { "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", @@ -3357,6 +3429,25 @@ }, "type": "object" }, + "RootCACertificate": { + "deprecated": true, + "description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", + "id": "RootCACertificate", + "properties": { + "certificate": { + "deprecated": true, + "description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", + "type": "string" + }, + "expirationTime": { + "deprecated": true, + "description": "The certificate expiration time in timestamp format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3504,6 +3595,10 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, + "multiRegionConfig": { + "$ref": "MultiRegionConfig", + "description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." + }, "name": { "description": "Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" @@ -3554,6 +3649,7 @@ "UPDATING", "DELETING", "ERROR", + "AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3565,6 +3661,7 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", + "The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 3613a8d5db..17d8b8078a 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1796,7 +1796,7 @@ } } }, - "revision": "20240613", + "revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,6 +2196,52 @@ }, "type": "object" }, + "CustomRegionConfig": { + "description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", + "id": "CustomRegionConfig", + "properties": { + "readOnlyRegions": { + "description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "readWriteRegions": { + "description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomRegionMetadata": { + "description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", + "id": "CustomRegionMetadata", + "properties": { + "optionalReadOnlyRegions": { + "description": "The read-only regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "requiredReadWriteRegions": { + "description": "The read-write regions for this custom region.", + "items": { + "type": "string" + }, + "type": "array" + }, + "witnessRegion": { + "description": "The Spanner witness region for this custom region.", + "type": "string" + } + }, + "type": "object" + }, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2769,6 +2815,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "customRegionMetadata": { + "description": "Possible configurations supported if the current region is a custom region.", + "items": { + "$ref": "CustomRegionMetadata" + }, + "type": "array" + }, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3071,6 +3124,25 @@ "properties": {}, "type": "object" }, + "MultiRegionConfig": { + "description": "The multi-region config for the Dataproc Metastore service.", + "id": "MultiRegionConfig", + "properties": { + "certificates": { + "deprecated": true, + "description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", + "items": { + "$ref": "RootCACertificate" + }, + "readOnly": true, + "type": "array" + }, + "customRegionConfig": { + "$ref": "CustomRegionConfig" + } + }, + "type": "object" + }, "MultiRegionMetadata": { "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", @@ -3357,6 +3429,25 @@ }, "type": "object" }, + "RootCACertificate": { + "deprecated": true, + "description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", + "id": "RootCACertificate", + "properties": { + "certificate": { + "deprecated": true, + "description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", + "type": "string" + }, + "expirationTime": { + "deprecated": true, + "description": "The certificate expiration time in timestamp format.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3504,6 +3595,10 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, + "multiRegionConfig": { + "$ref": "MultiRegionConfig", + "description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." + }, "name": { "description": "Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" @@ -3554,6 +3649,7 @@ "UPDATING", "DELETING", "ERROR", + "AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3565,6 +3661,7 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", + "The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index f3faaf86a3..d391f16bc9 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, - "revision": "20240620", + "revision": "20240711", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3443,7 +3443,7 @@ "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", - "Bring-your-own-license (BYOL) plan. User provides the OS license." + "Bring-your-own-license (BYOL) plan. User provides the license." ], "type": "string" }, @@ -3452,7 +3452,7 @@ "description": "Preferences concerning the machine types to consider on Compute Engine." }, "multithreading": { - "description": "Optional. Preferences for multithreading support.", + "description": "Optional. Preferences for multithreading support on Windows Server.", "enum": [ "MULTITHREADING_UNSPECIFIED", "MULTITHREADING_DISABLED", @@ -3460,10 +3460,10 @@ "MULTITHREADING_DISABLED_WITH_COMPENSATION" ], "enumDescriptions": [ - "Same as MULTITHREADING_DISABLED_WITH_COMPENSATION.", - "Disable simultaneous multithreading if doing so is advantageous.", - "Always enable simultaneous multithreading.", - "Disable simultaneous multithreading and increase number of VCPUs to compensate, if doing so is advantageous." + "Same as MULTITHREADING_AUTO.", + "Disable simultaneous multithreading.", + "Enable simultaneous multithreading.", + "Disable simultaneous multithreading and increase number of VCPUs to compensate." ], "type": "string" }, @@ -4070,10 +4070,10 @@ "MULTITHREADING_DISABLED_WITH_COMPENSATION" ], "enumDescriptions": [ - "Same as MULTITHREADING_DISABLED_WITH_COMPENSATION.", - "Disable simultaneous multithreading if doing so is lower cost.", - "Always enable simultaneous multithreading.", - "Disable simultaneous multithreading and increase number of VCPUs to compensate, if doing so is lower cost." + "Same as MULTITHREADING_AUTO.", + "Disable simultaneous multithreading.", + "Enable simultaneous multithreading.", + "Disable simultaneous multithreading and increase number of VCPUs to compensate." ], "type": "string" }, @@ -6255,7 +6255,7 @@ "type": "string" }, "licenseType": { - "description": "Optional. License type of the OS image.", + "description": "Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).", "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_TYPE_DEFAULT", @@ -6264,7 +6264,7 @@ "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", - "Bring-your-own-license (BYOL) plan. User provides the OS license." + "Bring-your-own-license (BYOL) plan. User provides the license." ], "type": "string" } @@ -6991,7 +6991,8 @@ }, "monthlyCostCompute": { "$ref": "Money", - "description": "Compute monthly cost for this preference set." + "description": "Output only. Compute monthly cost for this preference set.", + "readOnly": true }, "monthlyCostDatabaseBackup": { "$ref": "Money", @@ -7005,23 +7006,28 @@ }, "monthlyCostNetworkEgress": { "$ref": "Money", - "description": "Network Egress monthly cost for this preference set. Only present for virtual machines." + "description": "Output only. Network Egress monthly cost for this preference set. Only present for virtual machines.", + "readOnly": true }, "monthlyCostOsLicense": { "$ref": "Money", - "description": "Operating system licensing monthly cost for this preference set. Only present for virtual machines." + "description": "Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines.", + "readOnly": true }, "monthlyCostOther": { "$ref": "Money", - "description": "Miscellaneous monthly cost for this preference set." + "description": "Output only. Miscellaneous monthly cost for this preference set.", + "readOnly": true }, "monthlyCostStorage": { "$ref": "Money", - "description": "Storage monthly cost for this preference set." + "description": "Output only. Storage monthly cost for this preference set.", + "readOnly": true }, "monthlyCostTotal": { "$ref": "Money", - "description": "Total monthly cost for this preference set." + "description": "Output only. Total monthly cost for this preference set.", + "readOnly": true }, "preferenceSet": { "$ref": "PreferenceSet", @@ -8296,7 +8302,9 @@ "COMMITMENT_1_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_3_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_1_YEAR_UPFRONT_PAYMENT", - "COMMITMENT_3_YEAR_UPFRONT_PAYMENT" + "COMMITMENT_3_YEAR_UPFRONT_PAYMENT", + "COMMITMENT_FLEXIBLE_3_YEAR_MONTHLY_PAYMENTS", + "COMMITMENT_FLEXIBLE_3_YEAR_UPFRONT_PAYMENT" ], "enumDescriptions": [ "Unspecified commitment plan.", @@ -8304,7 +8312,9 @@ "1 year commitment (monthly payments).", "3 year commitment (monthly payments).", "1 year commitment (upfront payment).", - "3 years commitment (upfront payment)." + "3 years commitment (upfront payment).", + "3-year flexible commitment (monthly payments). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API.", + "3-year flexible commitment (upfront payment). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API." ], "type": "string" }, diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index 454cbb34e7..3465873113 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -463,7 +463,7 @@ "type": "string" }, "name": { - "description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", + "description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -500,7 +500,7 @@ "type": "string" }, "name": { - "description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", + "description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -537,7 +537,7 @@ "type": "string" }, "name": { - "description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", + "description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -574,7 +574,7 @@ "type": "string" }, "name": { - "description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", + "description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -669,7 +669,7 @@ "type": "string" }, "name": { - "description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", + "description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -753,7 +753,7 @@ } } }, - "revision": "20240623", + "revision": "20240721", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1119,7 +1119,8 @@ "METRIC_LABEL", "USER_METADATA_LABEL", "SYSTEM_METADATA_LABEL", - "GROUP" + "GROUP", + "VALUE_ONLY" ], "enumDescriptions": [ "Filter type is unspecified. This is not valid in a well-formed request.", @@ -1127,21 +1128,48 @@ "Filter on a metrics label value", "Filter on a user metadata label value", "Filter on a system metadata label value", - "Filter on a group id" + "Filter on a group id", + "Filter that only contains a value. The label_key field must be unset for filters of this type." ], "type": "string" }, "labelKey": { - "description": "Required. The key for the label", + "description": "Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise.", "type": "string" }, + "stringArray": { + "$ref": "StringArray", + "description": "A list of possible string values for the filter" + }, + "stringArrayValue": { + "$ref": "StringArray", + "description": "An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED" + }, "stringValue": { - "description": "A variable-length string value.", + "description": "A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED", "type": "string" }, "templateVariable": { "description": "The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.", "type": "string" + }, + "timeSeriesQuery": { + "$ref": "TimeSeriesQuery", + "description": "A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported" + }, + "valueType": { + "description": "The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default.", + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "STRING", + "STRING_ARRAY" + ], + "enumDescriptions": [ + "Value type is unspecified", + "String type", + "String array type" + ], + "type": "string" } }, "type": "object" @@ -1356,7 +1384,9 @@ "CLOUD_SQL_FAILOVER", "CLOUD_SQL_START_STOP", "CLOUD_SQL_STORAGE", - "UPTIME_CHECK_FAILURE" + "UPTIME_CHECK_FAILURE", + "CLOUD_ALERTING_ALERT", + "SERVICE_HEALTH_INCIDENT" ], "enumDescriptions": [ "No event type specified.", @@ -1378,7 +1408,9 @@ "Failover of a Cloud SQL instance.", "Start/stop of a Cloud SQL instance.", "Storage event for a Cloud SQL instance.", - "Failure of a Cloud Monitoring uptime check." + "Failure of a Cloud Monitoring uptime check.", + "Alerts from Cloud Alerting", + "Incidents from Service Health" ], "type": "string" }, @@ -2297,6 +2329,20 @@ }, "type": "object" }, + "StringArray": { + "description": "An array of strings", + "id": "StringArray", + "properties": { + "values": { + "description": "The values of the array", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "TableDataSet": { "description": "Groups a time series query definition with table options.", "id": "TableDataSet", diff --git a/discovery/monitoring-v3.json b/discovery/monitoring-v3.json index c081b81b42..c9a99f37fd 100644 --- a/discovery/monitoring-v3.json +++ b/discovery/monitoring-v3.json @@ -756,7 +756,7 @@ ], "parameters": { "filter": { - "description": "If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", + "description": "Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", "location": "query", "type": "string" }, @@ -768,18 +768,18 @@ "type": "string" }, "orderBy": { - "description": "A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", + "description": "Optional. A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of results to return in a single response.", + "description": "Optional. The maximum number of results to return in a single response.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.", + "description": "Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.", "location": "query", "type": "string" } @@ -804,7 +804,7 @@ ], "parameters": { "name": { - "description": "Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.", + "description": "Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.", "location": "path", "pattern": "^projects/[^/]+/alertPolicies/[^/]+$", "required": true, @@ -1514,7 +1514,7 @@ ], "parameters": { "filter": { - "description": "If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", + "description": "Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", "location": "query", "type": "string" }, @@ -1526,18 +1526,18 @@ "type": "string" }, "orderBy": { - "description": "A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", + "description": "Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).", "location": "query", "type": "string" }, "pageSize": { - "description": "The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.", + "description": "Optional. The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.", + "description": "Optional. If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results.", "location": "query", "type": "string" } @@ -1562,14 +1562,14 @@ ], "parameters": { "name": { - "description": "The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", + "description": "Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", "location": "path", "pattern": "^projects/[^/]+/notificationChannels/[^/]+$", "required": true, "type": "string" }, "updateMask": { - "description": "The fields to update.", + "description": "Optional. The fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2714,7 +2714,7 @@ } } }, - "revision": "20240616", + "revision": "20240804", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2870,7 +2870,7 @@ "description": "A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored." }, "name": { - "description": "Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.", + "description": "Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.", "type": "string" }, "notificationChannels": { @@ -2928,7 +2928,7 @@ }, "notificationRateLimit": { "$ref": "NotificationRateLimit", - "description": "Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based." + "description": "Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition." } }, "type": "object" @@ -4905,7 +4905,7 @@ "type": "array" }, "name": { - "description": "The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", + "description": "Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.", "type": "string" }, "type": { @@ -5639,6 +5639,10 @@ "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.", "id": "TimeSeries", "properties": { + "description": { + "description": "Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.", + "type": "string" + }, "metadata": { "$ref": "MonitoredResourceMetadata", "description": "Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored." @@ -5675,7 +5679,7 @@ "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources)." }, "unit": { - "description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.", + "description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty.", "type": "string" }, "valueType": { diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index 2ebc784d0a..b64bb8db0a 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -2812,7 +2812,7 @@ } } }, - "revision": "20240618", + "revision": "20240807", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2963,13 +2963,15 @@ "STATE_UNSPECIFIED", "VALID", "CONNECTION_POLICY_MISSING", - "POLICY_LIMIT_REACHED" + "POLICY_LIMIT_REACHED", + "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" ], "enumDescriptions": [ "Default state, when Connection Map is created initially.", "Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit.", "No Service Connection Policy found for this network and Service Class", - "Service Connection Policy limit reached for this network and Service Class" + "Service Connection Policy limit reached for this network and Service Class", + "The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy." ], "readOnly": true, "type": "string" @@ -3620,6 +3622,14 @@ }, "type": "array" }, + "producerVpcSpokes": { + "description": "Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "uri": { "description": "Required. The URI of the VPC network resource.", "type": "string" @@ -4926,7 +4936,7 @@ "type": "array" }, "serviceClass": { - "description": "The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.", + "description": "The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.", "type": "string" }, "updateTime": { diff --git a/discovery/networkconnectivity-v1alpha1.json b/discovery/networkconnectivity-v1alpha1.json index a5c9dbe1ab..7145a68cdc 100644 --- a/discovery/networkconnectivity-v1alpha1.json +++ b/discovery/networkconnectivity-v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, - "revision": "20240424", + "revision": "20240807", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { @@ -1393,6 +1393,10 @@ "description": "User-defined labels.", "type": "object" }, + "migration": { + "$ref": "Migration", + "description": "Optional. Should be present if usage is set to FOR_MIGRATION." + }, "name": { "description": "Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names", "type": "string" @@ -1456,12 +1460,14 @@ "enum": [ "USAGE_UNSPECIFIED", "FOR_VPC", - "EXTERNAL_TO_VPC" + "EXTERNAL_TO_VPC", + "FOR_MIGRATION" ], "enumDescriptions": [ "Unspecified usage is allowed in calls which identify the resource by other fields and do not need Usage set to complete. These are, i.e.: GetInternalRange and DeleteInternalRange. Usage needs to be specified explicitly in CreateInternalRange or UpdateInternalRange calls.", "A VPC resource can use the reserved CIDR block by associating it with the internal range resource if usage is set to FOR_VPC.", - "Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect." + "Ranges created with EXTERNAL_TO_VPC cannot be associated with VPC resources and are meant to block out address ranges for various use cases such as usage on-premises, with dynamic route announcements via Interconnect.", + "Ranges created FOR_MIGRATION can be used to lock a CIDR range between a source and target subnet. If usage is set to FOR_MIGRATION the peering value has to be set to FOR_SELF or default to FOR_SELF when unset." ], "type": "string" }, @@ -1603,6 +1609,21 @@ }, "type": "object" }, + "Migration": { + "description": "Specification for migration with source and target resource names.", + "id": "Migration", + "properties": { + "source": { + "description": "Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project}/regions/{region}/subnetworks/{subnet}", + "type": "string" + }, + "target": { + "description": "Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project}/regions/{region}/subnetworks/{subnet}", + "type": "string" + } + }, + "type": "object" + }, "OperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "OperationMetadata", diff --git a/discovery/networkmanagement-v1.json b/discovery/networkmanagement-v1.json index d56591f52e..98fc16c9c0 100644 --- a/discovery/networkmanagement-v1.json +++ b/discovery/networkmanagement-v1.json @@ -591,7 +591,7 @@ } } }, - "revision": "20240619", + "revision": "20240725", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1141,7 +1141,8 @@ "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", "CLOUD_NAT_NO_ADDRESSES", "ROUTING_LOOP", - "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE" + "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE", + "LOAD_BALANCER_BACKEND_INVALID_NETWORK" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1208,7 +1209,8 @@ "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", "Packet is stuck in a routing loop.", - "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces." + "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", + "Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer." ], "type": "string" }, @@ -1434,7 +1436,7 @@ "type": "object" }, "FirewallInfo": { - "description": "For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule.", + "description": "For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule.", "id": "FirewallInfo", "properties": { "action": { @@ -1446,7 +1448,7 @@ "type": "string" }, "displayName": { - "description": "The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.", + "description": "The display name of the firewall rule. This field might be empty for firewall policy rules.", "type": "string" }, "firewallRuleType": { @@ -1480,7 +1482,11 @@ "type": "string" }, "policy": { - "description": "The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.", + "description": "The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules.", + "type": "string" + }, + "policyUri": { + "description": "The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules.", "type": "string" }, "priority": { @@ -1496,14 +1502,14 @@ "type": "array" }, "targetTags": { - "description": "The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.", + "description": "The target tags defined by the VPC firewall rule. This field is not applicable to firewall policy rules.", "items": { "type": "string" }, "type": "array" }, "uri": { - "description": "The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.", + "description": "The URI of the firewall rule. This field is not applicable to implied VPC firewall rules.", "type": "string" } }, @@ -1702,6 +1708,10 @@ "description": "URI of a Compute Engine network.", "type": "string" }, + "pscNetworkAttachmentUri": { + "description": "URI of the PSC network attachment the NIC is attached to (if relevant).", + "type": "string" + }, "serviceAccount": { "deprecated": true, "description": "Service account authorized for the instance.", diff --git a/discovery/networkmanagement-v1beta1.json b/discovery/networkmanagement-v1beta1.json index 25b024c1b2..8eef6ebf42 100644 --- a/discovery/networkmanagement-v1beta1.json +++ b/discovery/networkmanagement-v1beta1.json @@ -585,13 +585,180 @@ } } } + }, + "vpcFlowLogsConfigs": { + "methods": { + "create": { + "description": "Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs", + "httpMethod": "POST", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "vpcFlowLogsConfigId": { + "description": "Required. ID of the `VpcFlowLogsConfig`.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/vpcFlowLogsConfigs", + "request": { + "$ref": "VpcFlowLogsConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a specific `VpcFlowLogsConfig`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", + "httpMethod": "DELETE", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific `VpcFlowLogsConfig`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", + "httpMethod": "GET", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "VpcFlowLogsConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all `VpcFlowLogsConfigs` in a given project.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs", + "httpMethod": "GET", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field to use to sort the list.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Number of `VpcFlowLogsConfigs` to return.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Page token from an earlier query, as returned in `next_page_token`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id}/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/vpcFlowLogsConfigs", + "response": { + "$ref": "ListVpcFlowLogsConfigsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/vpcFlowLogsConfigs/{vpcFlowLogsConfigsId}", + "httpMethod": "PATCH", + "id": "networkmanagement.projects.locations.vpcFlowLogsConfigs.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/vpcFlowLogsConfigs/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update. At least one path must be supplied in this field.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "VpcFlowLogsConfig" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } } } } }, - "revision": "20240612", + "revision": "20240807", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1146,7 +1313,10 @@ "LOAD_BALANCER_HAS_NO_PROXY_SUBNET", "CLOUD_NAT_NO_ADDRESSES", "ROUTING_LOOP", - "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE" + "DROPPED_INSIDE_GOOGLE_MANAGED_SERVICE", + "LOAD_BALANCER_BACKEND_INVALID_NETWORK", + "BACKEND_SERVICE_NAMED_PORT_NOT_DEFINED", + "DESTINATION_IS_PRIVATE_NAT_IP_RANGE" ], "enumDescriptions": [ "Cause is unspecified.", @@ -1213,7 +1383,10 @@ "Packet sent to a load balancer, which requires a proxy-only subnet and the subnet is not found.", "Packet sent to Cloud Nat without active NAT IPs.", "Packet is stuck in a routing loop.", - "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces." + "Packet is dropped due to an unspecified reason inside a Google-managed service. Used only for return traces.", + "Packet is dropped due to a load balancer backend instance not having a network interface in the network expected by the load balancer.", + "Packet is dropped due to a backend service named port not being defined on the instance group level.", + "Packet is dropped due to a destination IP range being part of a Private NAT IP range." ], "type": "string" }, @@ -1439,7 +1612,7 @@ "type": "object" }, "FirewallInfo": { - "description": "For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule.", + "description": "For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule.", "id": "FirewallInfo", "properties": { "action": { @@ -1451,7 +1624,7 @@ "type": "string" }, "displayName": { - "description": "The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.", + "description": "The display name of the firewall rule. This field might be empty for firewall policy rules.", "type": "string" }, "firewallRuleType": { @@ -1485,7 +1658,11 @@ "type": "string" }, "policy": { - "description": "The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules.", + "description": "The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules.", + "type": "string" + }, + "policyUri": { + "description": "The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules.", "type": "string" }, "priority": { @@ -1501,14 +1678,14 @@ "type": "array" }, "targetTags": { - "description": "The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules.", + "description": "The target tags defined by the VPC firewall rule. This field is not applicable to firewall policy rules.", "items": { "type": "string" }, "type": "array" }, "uri": { - "description": "The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules.", + "description": "The URI of the firewall rule. This field is not applicable to implied VPC firewall rules.", "type": "string" } }, @@ -1707,6 +1884,10 @@ "description": "URI of a Compute Engine network.", "type": "string" }, + "pscNetworkAttachmentUri": { + "description": "URI of the PSC network attachment the NIC is attached to (if relevant).", + "type": "string" + }, "serviceAccount": { "deprecated": true, "description": "Service account authorized for the instance.", @@ -1811,6 +1992,31 @@ }, "type": "object" }, + "ListVpcFlowLogsConfigsResponse": { + "description": "Response for the `ListVpcFlowLogsConfigs` method.", + "id": "ListVpcFlowLogsConfigsResponse", + "properties": { + "nextPageToken": { + "description": "Page token to fetch the next set of configurations.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached (when querying all locations with `-`).", + "items": { + "type": "string" + }, + "type": "array" + }, + "vpcFlowLogsConfigs": { + "description": "List of VPC Flow Log configurations.", + "items": { + "$ref": "VpcFlowLogsConfig" + }, + "type": "array" + } + }, + "type": "object" + }, "LoadBalancerBackend": { "description": "For display only. Metadata associated with a specific load balancer backend.", "id": "LoadBalancerBackend", @@ -2885,6 +3091,116 @@ }, "type": "object" }, + "VpcFlowLogsConfig": { + "description": "A configuration to generate VPC Flow Logs.", + "id": "VpcFlowLogsConfig", + "properties": { + "aggregationInterval": { + "description": "Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC.", + "enum": [ + "AGGREGATION_INTERVAL_UNSPECIFIED", + "INTERVAL_5_SEC", + "INTERVAL_30_SEC", + "INTERVAL_1_MIN", + "INTERVAL_5_MIN", + "INTERVAL_10_MIN", + "INTERVAL_15_MIN" + ], + "enumDescriptions": [ + "If not specified, will default to INTERVAL_5_SEC.", + "Aggregate logs in 5s intervals.", + "Aggregate logs in 30s intervals.", + "Aggregate logs in 1m intervals.", + "Aggregate logs in 5m intervals.", + "Aggregate logs in 10m intervals.", + "Aggregate logs in 15m intervals." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. The time the config was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters.", + "type": "string" + }, + "filterExpr": { + "description": "Optional. Export filter used to define which VPC Flow Logs should be logged.", + "type": "string" + }, + "flowSampling": { + "description": "Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0.", + "format": "float", + "type": "number" + }, + "interconnectAttachment": { + "description": "Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id}/regions/{region}/interconnectAttachments/{name}", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user-provided metadata.", + "type": "object" + }, + "metadata": { + "description": "Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA.", + "enum": [ + "METADATA_UNSPECIFIED", + "INCLUDE_ALL_METADATA", + "EXCLUDE_ALL_METADATA", + "CUSTOM_METADATA" + ], + "enumDescriptions": [ + "If not specified, will default to INCLUDE_ALL_METADATA.", + "Include all metadata fields.", + "Exclude all metadata fields.", + "Include only custom fields (specified in metadata_fields)." + ], + "type": "string" + }, + "metadataFields": { + "description": "Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if \"metadata\" was set to CUSTOM_METADATA.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Identifier. Unique name of the configuration using the form: `projects/{project_id}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id}`", + "type": "string" + }, + "state": { + "description": "Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "If not specified, will default to ENABLED.", + "When ENABLED, this configuration will generate logs.", + "When DISABLED, this configuration will not generate logs." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The time the config was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vpnTunnel": { + "description": "Traffic will be logged from the VPN Tunnel. Format: projects/{project_id}/regions/{region}/vpnTunnels/{name}", + "type": "string" + } + }, + "type": "object" + }, "VpnGatewayInfo": { "description": "For display only. Metadata associated with a Compute Engine VPN gateway.", "id": "VpnGatewayInfo", diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json index ad58709553..7f4ed330cc 100644 --- a/discovery/networksecurity-v1.json +++ b/discovery/networksecurity-v1.json @@ -1729,6 +1729,97 @@ } } }, + "authzPolicies": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:getIamPolicy", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.authzPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.authzPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.authzPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "clientTlsPolicies": { "methods": { "create": { @@ -3162,7 +3253,7 @@ } } }, - "revision": "20240505", + "revision": "20240803", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3220,6 +3311,23 @@ "description": "Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`.", "type": "string" }, + "purpose": { + "description": "Optional. List of supported purposes of the Address Group.", + "items": { + "enum": [ + "PURPOSE_UNSPECIFIED", + "DEFAULT", + "CLOUD_ARMOR" + ], + "enumDescriptions": [ + "Default value. Should never happen.", + "Address Group is distributed to VMC, and is usable in Firewall Policies and other systems that rely on VMC.", + "Address Group is usable in Cloud Armor." + ], + "type": "string" + }, + "type": "array" + }, "selfLink": { "description": "Output only. Server-defined fully-qualified URL for this resource.", "readOnly": true, @@ -4262,14 +4370,14 @@ "id": "MTLSPolicy", "properties": { "clientValidationCa": { - "description": "Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.", + "description": "Required if the policy is to be used with Traffic Director. For Application Load Balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.", "items": { "$ref": "ValidationCA" }, "type": "array" }, "clientValidationMode": { - "description": "When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.", + "description": "When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty.", "enum": [ "CLIENT_VALIDATION_MODE_UNSPECIFIED", "ALLOW_INVALID_OR_MISSING_CLIENT_CERT", @@ -4283,7 +4391,7 @@ "type": "string" }, "clientValidationTrustConfig": { - "description": "Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.", + "description": "Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers.", "type": "string" } }, @@ -4408,7 +4516,7 @@ "type": "object" }, "SecurityProfile": { - "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10", + "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12", "id": "SecurityProfile", "properties": { "createTime": { @@ -4463,7 +4571,7 @@ "type": "object" }, "SecurityProfileGroup": { - "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9", + "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 11", "id": "SecurityProfileGroup", "properties": { "createTime": { @@ -4493,7 +4601,7 @@ "type": "string" }, "threatPreventionProfile": { - "description": "Optional. Reference to a SecurityProfile with the threat prevention configuration for the SecurityProfileGroup.", + "description": "Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.", "type": "string" }, "updateTime": { @@ -4506,11 +4614,11 @@ "type": "object" }, "ServerTlsPolicy": { - "description": "ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", + "description": "ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by Application Load Balancers can be attached only to TargetHttpsProxy with an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", "id": "ServerTlsPolicy", "properties": { "allowOpen": { - "description": "This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.", + "description": "This field applies only for Traffic Director policies. It is must be set to false for Application Load Balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.", "type": "boolean" }, "createTime": { @@ -4532,7 +4640,7 @@ }, "mtlsPolicy": { "$ref": "MTLSPolicy", - "description": "This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections." + "description": "This field is required if the policy is used with Application Load Balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections." }, "name": { "description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", @@ -4540,7 +4648,7 @@ }, "serverCertificate": { "$ref": "GoogleCloudNetworksecurityV1CertificateProvider", - "description": "Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported." + "description": "Optional if policy is to be used with Traffic Director. For Application Load Balancers must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported." }, "updateTime": { "description": "Output only. The timestamp when the resource was updated.", diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 232b1ecdda..65b952c5e6 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -1729,6 +1729,275 @@ } } }, + "authzPolicies": { + "methods": { + "create": { + "description": "Creates a new AuthzPolicy in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.authzPolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "authzPolicyId": { + "description": "Required. User-provided ID of the `AuthzPolicy` resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the `AuthzPolicy` resource. Must be in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/authzPolicies", + "request": { + "$ref": "AuthzPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single AuthzPolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}", + "httpMethod": "DELETE", + "id": "networksecurity.projects.locations.authzPolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `AuthzPolicy` resource to delete. Must be in the format `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single AuthzPolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.authzPolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the `AuthzPolicy` resource to get. Must be in the format `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "AuthzPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:getIamPolicy", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.authzPolicies.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getIamPolicy", + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists AuthzPolicies in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies", + "httpMethod": "GET", + "id": "networksecurity.projects.locations.authzPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results that the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the `AuthzPolicy` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/authzPolicies", + "response": { + "$ref": "ListAuthzPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single AuthzPolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}", + "httpMethod": "PATCH", + "id": "networksecurity.projects.locations.authzPolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "AuthzPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:setIamPolicy", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.authzPolicies.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "GoogleIamV1SetIamPolicyRequest" + }, + "response": { + "$ref": "GoogleIamV1Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}:testIamPermissions", + "httpMethod": "POST", + "id": "networksecurity.projects.locations.authzPolicies.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1TestIamPermissionsRequest" + }, + "response": { + "$ref": "GoogleIamV1TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "clientTlsPolicies": { "methods": { "create": { @@ -3162,7 +3431,7 @@ } } }, - "revision": "20240510", + "revision": "20240803", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3320,6 +3589,336 @@ }, "type": "object" }, + "AuthzPolicy": { + "description": "`AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.", + "id": "AuthzPolicy", + "properties": { + "action": { + "description": "Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.", + "enum": [ + "AUTHZ_ACTION_UNSPECIFIED", + "ALLOW", + "DENY", + "CUSTOM" + ], + "enumDescriptions": [ + "Unspecified action.", + "Allow request to pass through to the backend.", + "Deny the request and return a HTTP 404 to the client.", + "Delegate the authorization decision to an external authorization engine." + ], + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customProvider": { + "$ref": "AuthzPolicyCustomProvider", + "description": "Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified." + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "httpRules": { + "description": "Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action.", + "items": { + "$ref": "AuthzPolicyAuthzRule" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "type": "object" + }, + "name": { + "description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", + "type": "string" + }, + "target": { + "$ref": "AuthzPolicyTarget", + "description": "Required. Specifies the set of resources to which this policy should be applied to." + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRule": { + "description": "Conditions to match against the incoming request.", + "id": "AuthzPolicyAuthzRule", + "properties": { + "from": { + "$ref": "AuthzPolicyAuthzRuleFrom", + "description": "Optional. Describes properties of one or more sources of a request." + }, + "to": { + "$ref": "AuthzPolicyAuthzRuleTo", + "description": "Optional. Describes properties of one or more targets of a request." + }, + "when": { + "description": "Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.", + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleFrom": { + "description": "Describes properties of one or more sources of a request.", + "id": "AuthzPolicyAuthzRuleFrom", + "properties": { + "notSources": { + "description": "Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.", + "items": { + "$ref": "AuthzPolicyAuthzRuleFromRequestSource" + }, + "type": "array" + }, + "sources": { + "description": "Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.", + "items": { + "$ref": "AuthzPolicyAuthzRuleFromRequestSource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleFromRequestSource": { + "description": "Describes the properties of a single source.", + "id": "AuthzPolicyAuthzRuleFromRequestSource", + "properties": { + "principals": { + "description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.", + "items": { + "$ref": "AuthzPolicyAuthzRuleStringMatch" + }, + "type": "array" + }, + "resources": { + "description": "Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.", + "items": { + "$ref": "AuthzPolicyAuthzRuleRequestResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleHeaderMatch": { + "description": "Determines how a HTTP header should be matched.", + "id": "AuthzPolicyAuthzRuleHeaderMatch", + "properties": { + "name": { + "description": "Optional. Specifies the name of the header in the request.", + "type": "string" + }, + "value": { + "$ref": "AuthzPolicyAuthzRuleStringMatch", + "description": "Optional. Specifies how the header match will be performed." + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleRequestResource": { + "description": "Describes the properties of a client VM resource accessing the internal application load balancers.", + "id": "AuthzPolicyAuthzRuleRequestResource", + "properties": { + "iamServiceAccount": { + "$ref": "AuthzPolicyAuthzRuleStringMatch", + "description": "Optional. An IAM service account to match against the source service account of the VM sending the request." + }, + "tagValueIdSet": { + "$ref": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", + "description": "Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request." + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet": { + "description": "Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.", + "id": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", + "properties": { + "ids": { + "description": "Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleStringMatch": { + "description": "Determines how a string value should be matched.", + "id": "AuthzPolicyAuthzRuleStringMatch", + "properties": { + "contains": { + "description": "The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``", + "type": "string" + }, + "exact": { + "description": "The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.", + "type": "string" + }, + "ignoreCase": { + "description": "If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.", + "type": "boolean" + }, + "prefix": { + "description": "The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``", + "type": "string" + }, + "suffix": { + "description": "The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``", + "type": "string" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleTo": { + "description": "Describes properties of one or more targets of a request.", + "id": "AuthzPolicyAuthzRuleTo", + "properties": { + "notOperations": { + "description": "Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.", + "items": { + "$ref": "AuthzPolicyAuthzRuleToRequestOperation" + }, + "type": "array" + }, + "operations": { + "description": "Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.", + "items": { + "$ref": "AuthzPolicyAuthzRuleToRequestOperation" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleToRequestOperation": { + "description": "Describes properties of one or more targets of a request.", + "id": "AuthzPolicyAuthzRuleToRequestOperation", + "properties": { + "headerSet": { + "$ref": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", + "description": "Optional. A list of headers to match against in http header." + }, + "hosts": { + "description": "Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.", + "items": { + "$ref": "AuthzPolicyAuthzRuleStringMatch" + }, + "type": "array" + }, + "methods": { + "description": "Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.", + "items": { + "type": "string" + }, + "type": "array" + }, + "paths": { + "description": "Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", + "items": { + "$ref": "AuthzPolicyAuthzRuleStringMatch" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyAuthzRuleToRequestOperationHeaderSet": { + "description": "Describes a set of HTTP headers to match against.", + "id": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", + "properties": { + "headers": { + "description": "Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.", + "items": { + "$ref": "AuthzPolicyAuthzRuleHeaderMatch" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyCustomProvider": { + "description": "Allows delegating authorization decisions to Cloud IAP or to Service Extensions.", + "id": "AuthzPolicyCustomProvider", + "properties": { + "authzExtension": { + "$ref": "AuthzPolicyCustomProviderAuthzExtension", + "description": "Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified." + }, + "cloudIap": { + "$ref": "AuthzPolicyCustomProviderCloudIap", + "description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places." + } + }, + "type": "object" + }, + "AuthzPolicyCustomProviderAuthzExtension": { + "description": "Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified.", + "id": "AuthzPolicyCustomProviderAuthzExtension", + "properties": { + "resources": { + "description": "Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AuthzPolicyCustomProviderCloudIap": { + "description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.", + "id": "AuthzPolicyCustomProviderCloudIap", + "properties": {}, + "type": "object" + }, + "AuthzPolicyTarget": { + "description": "Specifies the set of targets to which this policy should be applied to.", + "id": "AuthzPolicyTarget", + "properties": { + "loadBalancingScheme": { + "description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "enum": [ + "LOAD_BALANCING_SCHEME_UNSPECIFIED", + "INTERNAL_MANAGED", + "EXTERNAL_MANAGED", + "INTERNAL_SELF_MANAGED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Signifies that this is used for Regional internal or Cross-region internal Application Load Balancing.", + "Signifies that this is used for Global external or Regional external Application Load Balancing.", + "Signifies that this is used for Cloud Service Mesh. Meant for use by CSM GKE controller only." + ], + "type": "string" + }, + "resources": { + "description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -3982,6 +4581,31 @@ }, "type": "object" }, + "ListAuthzPoliciesResponse": { + "description": "Message for response to listing `AuthzPolicy` resources.", + "id": "ListAuthzPoliciesResponse", + "properties": { + "authzPolicies": { + "description": "The list of `AuthzPolicy` resources.", + "items": { + "$ref": "AuthzPolicy" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results that the server returns.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListClientTlsPoliciesResponse": { "description": "Response returned by the ListClientTlsPolicies method.", "id": "ListClientTlsPoliciesResponse", @@ -4279,14 +4903,14 @@ "id": "MTLSPolicy", "properties": { "clientValidationCa": { - "description": "Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.", + "description": "Required if the policy is to be used with Traffic Director. For Application Load Balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate.", "items": { "$ref": "ValidationCA" }, "type": "array" }, "clientValidationMode": { - "description": "When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty.", + "description": "When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty.", "enum": [ "CLIENT_VALIDATION_MODE_UNSPECIFIED", "ALLOW_INVALID_OR_MISSING_CLIENT_CERT", @@ -4300,7 +4924,7 @@ "type": "string" }, "clientValidationTrustConfig": { - "description": "Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers.", + "description": "Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers.", "type": "string" } }, @@ -4425,7 +5049,7 @@ "type": "object" }, "SecurityProfile": { - "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10", + "description": "SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12", "id": "SecurityProfile", "properties": { "createTime": { @@ -4480,7 +5104,7 @@ "type": "object" }, "SecurityProfileGroup": { - "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9", + "description": "SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 11", "id": "SecurityProfileGroup", "properties": { "createTime": { @@ -4510,7 +5134,7 @@ "type": "string" }, "threatPreventionProfile": { - "description": "Optional. Reference to a SecurityProfile with the threat prevention configuration for the SecurityProfileGroup.", + "description": "Optional. Reference to a SecurityProfile with the ThreatPrevention configuration.", "type": "string" }, "updateTime": { @@ -4523,11 +5147,11 @@ "type": "object" }, "ServerTlsPolicy": { - "description": "ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", + "description": "ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by Application Load Balancers can be attached only to TargetHttpsProxy with an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme.", "id": "ServerTlsPolicy", "properties": { "allowOpen": { - "description": "This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.", + "description": "This field applies only for Traffic Director policies. It is must be set to false for Application Load Balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80.", "type": "boolean" }, "createTime": { @@ -4549,7 +5173,7 @@ }, "mtlsPolicy": { "$ref": "MTLSPolicy", - "description": "This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections." + "description": "This field is required if the policy is used with Application Load Balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections." }, "name": { "description": "Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}`", @@ -4557,7 +5181,7 @@ }, "serverCertificate": { "$ref": "GoogleCloudNetworksecurityV1beta1CertificateProvider", - "description": "Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported." + "description": "Optional if policy is to be used with Traffic Director. For Application Load Balancers must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported." }, "updateTime": { "description": "Output only. The timestamp when the resource was updated.", diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 33a8cf1910..eba2e60cee 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -535,37 +535,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -612,7 +581,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", + "description": "Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", "required": true, @@ -635,62 +604,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -779,37 +692,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.gateways.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -856,7 +738,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", + "description": "Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", "required": true, @@ -879,62 +761,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -1069,7 +895,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", + "description": "Identifier. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$", "required": true, @@ -1226,7 +1052,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", + "description": "Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$", "required": true, @@ -1701,37 +1527,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.meshes.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1778,7 +1573,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", + "description": "Identifier. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", "required": true, @@ -1801,62 +1596,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2068,37 +1807,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.serviceBindings.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -2134,62 +1842,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2568,7 +2220,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", + "description": "Identifier. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$", "required": true, @@ -2725,7 +2377,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$", "required": true, @@ -2756,7 +2408,7 @@ } } }, - "revision": "20240620", + "revision": "20240721", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2929,7 +2581,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", + "description": "Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", "type": "string" }, "serverTlsPolicy": { @@ -3147,7 +2799,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", + "description": "Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", "type": "string" }, "network": { @@ -3245,7 +2897,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", + "description": "Identifier. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", "type": "string" }, "rules": { @@ -3542,7 +3194,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", + "description": "Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", "type": "string" }, "rules": { @@ -4529,7 +4181,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", + "description": "Identifier. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", "type": "string" }, "selfLink": { @@ -4678,7 +4330,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`.", + "description": "Identifier. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`.", "type": "string" }, "service": { @@ -4861,7 +4513,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", + "description": "Identifier. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", "type": "string" }, "rules": { @@ -5021,7 +4673,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "type": "string" }, "rules": { diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index c2664bf126..c9c939a68b 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -177,33 +177,38 @@ } }, "resources": { - "endpointPolicies": { + "authzExtensions": { "methods": { "create": { - "description": "Creates a new EndpointPolicy in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", + "description": "Creates a new `AuthzExtension` resource in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzExtensions", "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.create", + "id": "networkservices.projects.locations.authzExtensions.create", "parameterOrder": [ "parent" ], "parameters": { - "endpointPolicyId": { - "description": "Required. Short name of the EndpointPolicy resource to be created. E.g. \"CustomECS\".", + "authzExtensionId": { + "description": "Required. User-provided ID of the `AuthzExtension` resource to be created.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The parent resource of the EndpointPolicy. Must be in the format `projects/*/locations/global`.", + "description": "Required. The parent resource of the `AuthzExtension` resource. Must be in the format `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+parent}/endpointPolicies", + "path": "v1beta1/{+parent}/authzExtensions", "request": { - "$ref": "EndpointPolicy" + "$ref": "AuthzExtension" }, "response": { "$ref": "Operation" @@ -213,20 +218,25 @@ ] }, "delete": { - "description": "Deletes a single EndpointPolicy.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}", + "description": "Deletes the specified `AuthzExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzExtensions/{authzExtensionsId}", "httpMethod": "DELETE", - "id": "networkservices.projects.locations.endpointPolicies.delete", + "id": "networkservices.projects.locations.authzExtensions.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the EndpointPolicy to delete. Must be in the format `projects/*/locations/global/endpointPolicies/*`.", + "description": "Required. The name of the `AuthzExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/authzExtensions/[^/]+$", "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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" } }, "path": "v1beta1/{+name}", @@ -238,83 +248,135 @@ ] }, "get": { - "description": "Gets details of a single EndpointPolicy.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}", + "description": "Gets details of the specified `AuthzExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzExtensions/{authzExtensionsId}", "httpMethod": "GET", - "id": "networkservices.projects.locations.endpointPolicies.get", + "id": "networkservices.projects.locations.authzExtensions.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the EndpointPolicy to get. Must be in the format `projects/*/locations/global/endpointPolicies/*`.", + "description": "Required. A name of the `AuthzExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/authzExtensions/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "EndpointPolicy" + "$ref": "AuthzExtension" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", + "list": { + "description": "Lists `AuthzExtension` resources in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzExtensions", "httpMethod": "GET", - "id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", + "id": "networkservices.projects.locations.authzExtensions.list", "parameterOrder": [ - "resource" + "parent" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", "format": "int32", "location": "query", "type": "integer" }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "pageToken": { + "description": "Optional. A token identifying a page of results that the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the `AuthzExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+parent}/authzExtensions", "response": { - "$ref": "Policy" + "$ref": "ListAuthzExtensionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "list": { - "description": "Lists EndpointPolicies in a given project and location.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", - "httpMethod": "GET", - "id": "networkservices.projects.locations.endpointPolicies.list", + "patch": { + "description": "Updates the parameters of the specified `AuthzExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzExtensions/{authzExtensionsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.authzExtensions.patch", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "pageSize": { - "description": "Maximum number of EndpointPolicies to return per call.", - "format": "int32", + "name": { + "description": "Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/authzExtensions/[^/]+$", + "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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", - "type": "integer" + "type": "string" }, - "pageToken": { - "description": "The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data.", + "updateMask": { + "description": "Required. Used to specify the fields to be overwritten in the `AuthzExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "AuthzExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "endpointPolicies": { + "methods": { + "create": { + "description": "Creates a new EndpointPolicy in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", + "httpMethod": "POST", + "id": "networkservices.projects.locations.endpointPolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "endpointPolicyId": { + "description": "Required. Short name of the EndpointPolicy resource to be created. E.g. \"CustomECS\".", "location": "query", "type": "string" }, "parent": { - "description": "Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/*/locations/global`.", + "description": "Required. The parent resource of the EndpointPolicy. Must be in the format `projects/*/locations/global`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -322,40 +384,34 @@ } }, "path": "v1beta1/{+parent}/endpointPolicies", + "request": { + "$ref": "EndpointPolicy" + }, "response": { - "$ref": "ListEndpointPoliciesResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "patch": { - "description": "Updates the parameters of a single EndpointPolicy.", + "delete": { + "description": "Deletes a single EndpointPolicy.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}", - "httpMethod": "PATCH", - "id": "networkservices.projects.locations.endpointPolicies.patch", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.endpointPolicies.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", + "description": "Required. A name of the EndpointPolicy to delete. Must be in the format `projects/*/locations/global/endpointPolicies/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", "required": true, "type": "string" - }, - "updateMask": { - "description": "Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", - "format": "google-fieldmask", - "location": "query", - "type": "string" } }, "path": "v1beta1/{+name}", - "request": { - "$ref": "EndpointPolicy" - }, "response": { "$ref": "Operation" }, @@ -363,57 +419,96 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", + "get": { + "description": "Gets details of a single EndpointPolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.endpointPolicies.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. A name of the EndpointPolicy to get. Must be in the format `projects/*/locations/global/endpointPolicies/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" + "path": "v1beta1/{+name}", + "response": { + "$ref": "EndpointPolicy" }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists EndpointPolicies in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", + "httpMethod": "GET", + "id": "networkservices.projects.locations.endpointPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of EndpointPolicies to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/*/locations/global`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/endpointPolicies", "response": { - "$ref": "Policy" + "$ref": "ListEndpointPoliciesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", + "patch": { + "description": "Updates the parameters of a single EndpointPolicy.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.endpointPolicies.patch", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1beta1/{+resource}:testIamPermissions", + "path": "v1beta1/{+name}", "request": { - "$ref": "TestIamPermissionsRequest" + "$ref": "EndpointPolicy" }, "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -506,37 +601,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.gateways.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -583,7 +647,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", + "description": "Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", "required": true, @@ -606,62 +670,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.gateways.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -796,7 +804,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", + "description": "Identifier. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/grpcRoutes/[^/]+$", "required": true, @@ -953,7 +961,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", + "description": "Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/httpRoutes/[^/]+$", "required": true, @@ -1382,38 +1390,13 @@ "description": "Deletes a single Mesh.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}", "httpMethod": "DELETE", - "id": "networkservices.projects.locations.meshes.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. A name of the Mesh to delete. Must be in the format `projects/*/locations/global/meshes/*`.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Gets details of a single Mesh.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}", - "httpMethod": "GET", - "id": "networkservices.projects.locations.meshes.get", + "id": "networkservices.projects.locations.meshes.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. A name of the Mesh to get. Must be in the format `projects/*/locations/global/meshes/*`.", + "description": "Required. A name of the Mesh to delete. Must be in the format `projects/*/locations/global/meshes/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", "required": true, @@ -1422,38 +1405,32 @@ }, "path": "v1beta1/{+name}", "response": { - "$ref": "Mesh" + "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", + "get": { + "description": "Gets details of a single Mesh.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}", "httpMethod": "GET", - "id": "networkservices.projects.locations.meshes.getIamPolicy", + "id": "networkservices.projects.locations.meshes.get", "parameterOrder": [ - "resource" + "name" ], "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "name": { + "description": "Required. A name of the Mesh to get. Must be in the format `projects/*/locations/global/meshes/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", "required": true, "type": "string" } }, - "path": "v1beta1/{+resource}:getIamPolicy", + "path": "v1beta1/{+name}", "response": { - "$ref": "Policy" + "$ref": "Mesh" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -1505,7 +1482,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", + "description": "Identifier. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", "required": true, @@ -1528,62 +1505,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.meshes.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -1795,37 +1716,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", - "httpMethod": "GET", - "id": "networkservices.projects.locations.serviceBindings.getIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "options.requestedPolicyVersion": { - "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", - "format": "int32", - "location": "query", - "type": "integer" - }, - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:getIamPolicy", - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -1861,62 +1751,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.setIamPolicy", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", - "httpMethod": "POST", - "id": "networkservices.projects.locations.serviceBindings.testIamPermissions", - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] } } }, @@ -2295,7 +2129,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", + "description": "Identifier. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tcpRoutes/[^/]+$", "required": true, @@ -2452,7 +2286,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/tlsRoutes/[^/]+$", "required": true, @@ -2483,7 +2317,7 @@ } } }, - "revision": "20240613", + "revision": "20240721", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2534,6 +2368,98 @@ }, "type": "object" }, + "AuthzExtension": { + "description": "`AuthzExtension` is a resource that allows traffic forwarding to a callout backend to make an authorization decision.", + "id": "AuthzExtension", + "properties": { + "authority": { + "description": "Required. The `:authority` header in the gRPC request sent from Envoy to the extension service.", + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "failOpen": { + "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset.", + "type": "boolean" + }, + "forwardHeaders": { + "description": "Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.", + "type": "object" + }, + "loadBalancingScheme": { + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "enum": [ + "LOAD_BALANCING_SCHEME_UNSPECIFIED", + "INTERNAL_MANAGED", + "EXTERNAL_MANAGED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Signifies that this is used for Internal HTTP(S) Load Balancing.", + "Signifies that this is used for External Managed HTTP(S) Load Balancing." + ], + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.", + "type": "object" + }, + "name": { + "description": "Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`.", + "type": "string" + }, + "service": { + "description": "Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.", + "type": "string" + }, + "timeout": { + "description": "Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds.", + "format": "google-duration", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "wireFormat": { + "description": "Optional. The format of communication supported by the callout extension. If not specified, the default is `EXT_PROC_GRPC`.", + "enum": [ + "WIRE_FORMAT_UNSPECIFIED", + "EXT_PROC_GRPC" + ], + "enumDescriptions": [ + "Not specified.", + "The extension service uses ExtProc GRPC API." + ], + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -2613,7 +2539,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", + "description": "Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`.", "type": "string" }, "serverTlsPolicy": { @@ -2831,7 +2757,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", + "description": "Identifier. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`.", "type": "string" }, "network": { @@ -2929,7 +2855,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", + "description": "Identifier. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/`", "type": "string" }, "rules": { @@ -3226,7 +3152,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", + "description": "Identifier. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`.", "type": "string" }, "rules": { @@ -3883,6 +3809,31 @@ }, "type": "object" }, + "ListAuthzExtensionsResponse": { + "description": "Message for response to listing `AuthzExtension` resources.", + "id": "ListAuthzExtensionsResponse", + "properties": { + "authzExtensions": { + "description": "The list of `AuthzExtension` resources.", + "items": { + "$ref": "AuthzExtension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results that the server returns.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListEndpointPoliciesResponse": { "description": "Response returned by the ListEndpointPolicies method.", "id": "ListEndpointPoliciesResponse", @@ -4213,7 +4164,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", + "description": "Identifier. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.", "type": "string" }, "selfLink": { @@ -4405,7 +4356,7 @@ "type": "object" }, "name": { - "description": "Required. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`.", + "description": "Identifier. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`.", "type": "string" }, "service": { @@ -4588,7 +4539,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", + "description": "Identifier. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`.", "type": "string" }, "rules": { @@ -4748,7 +4699,7 @@ "type": "array" }, "name": { - "description": "Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", + "description": "Identifier. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`.", "type": "string" }, "rules": { diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index 943d9542b8..ef59973e37 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -876,7 +876,7 @@ } } }, - "revision": "20240613", + "revision": "20240731", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1306,6 +1306,10 @@ "description": "Optional. Custom metadata to apply to this instance.", "type": "object" }, + "minCpuPlatform": { + "description": "Optional. The minimum CPU platform to use for this instance. The list of valid values can be found in https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones", + "type": "string" + }, "networkInterfaces": { "description": "Optional. The network interfaces for the VM. Supports only one interface.", "items": { diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index 54485be337..6a954a1a83 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20240624", + "revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1110,10 +1110,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." - }, - "vulnerabilityAttestation": { - "$ref": "VulnerabilityAttestation", - "description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -1943,7 +1939,8 @@ "NUGET", "RUBYGEMS", "RUST", - "COMPOSER" + "COMPOSER", + "SWIFT" ], "enumDescriptions": [ "", @@ -1956,7 +1953,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", - "PHP packages from Composer package manager." + "PHP packages from Composer package manager.", + "Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, @@ -2846,36 +2844,6 @@ }, "type": "object" }, - "VulnerabilityAttestation": { - "description": "The status of an vulnerability attestation generation.", - "id": "VulnerabilityAttestation", - "properties": { - "error": { - "description": "If failure, the error reason for why the attestation generation failed.", - "type": "string" - }, - "lastAttemptTime": { - "description": "The last time we attempted to generate an attestation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The success/failure state of the latest attestation attempt.", - "enum": [ - "VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", - "SUCCESS", - "FAILURE" - ], - "enumDescriptions": [ - "Default unknown state.", - "Attestation was successfully generated and stored.", - "Attestation was unsuccessfully generated and stored." - ], - "type": "string" - } - }, - "type": "object" - }, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index e7d20882ec..2732e38a5b 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20240624", + "revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1105,10 +1105,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." - }, - "vulnerabilityAttestation": { - "$ref": "VulnerabilityAttestation", - "description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -1938,7 +1934,8 @@ "NUGET", "RUBYGEMS", "RUST", - "COMPOSER" + "COMPOSER", + "SWIFT" ], "enumDescriptions": [ "", @@ -1951,7 +1948,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", - "PHP packages from Composer package manager." + "PHP packages from Composer package manager.", + "Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, @@ -2841,36 +2839,6 @@ }, "type": "object" }, - "VulnerabilityAttestation": { - "description": "The status of an vulnerability attestation generation.", - "id": "VulnerabilityAttestation", - "properties": { - "error": { - "description": "If failure, the error reason for why the attestation generation failed.", - "type": "string" - }, - "lastAttemptTime": { - "description": "The last time we attempted to generate an attestation.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "description": "The success/failure state of the latest attestation attempt.", - "enum": [ - "VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", - "SUCCESS", - "FAILURE" - ], - "enumDescriptions": [ - "Default unknown state.", - "Attestation was successfully generated and stored.", - "Attestation was unsuccessfully generated and stored." - ], - "type": "string" - } - }, - "type": "object" - }, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/discovery/places-v1.json b/discovery/places-v1.json index d0b09ba821..e869c96255 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -276,7 +276,7 @@ } } }, - "revision": "20240529", + "revision": "20240729", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1287,7 +1287,7 @@ "id": "GoogleMapsPlacesV1PlaceOpeningHours", "properties": { "openNow": { - "description": "Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours.", + "description": "Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active.", "type": "boolean" }, "periods": { diff --git a/discovery/playdeveloperreporting-v1alpha1.json b/discovery/playdeveloperreporting-v1alpha1.json index 3124e77c6a..02551dae2e 100644 --- a/discovery/playdeveloperreporting-v1alpha1.json +++ b/discovery/playdeveloperreporting-v1alpha1.json @@ -947,7 +947,7 @@ } } }, - "revision": "20240312", + "revision": "20240704", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { @@ -1558,14 +1558,14 @@ "id": "GooglePlayDeveloperReportingV1alpha1QueryErrorCountMetricSetRequest", "properties": { "dimensions": { - "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", + "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", "items": { "type": "string" }, "type": "array" }, "filter": { - "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions.", + "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED.", "type": "string" }, "metrics": { diff --git a/discovery/playdeveloperreporting-v1beta1.json b/discovery/playdeveloperreporting-v1beta1.json index 86ad107a53..cbfcbec6a0 100644 --- a/discovery/playdeveloperreporting-v1beta1.json +++ b/discovery/playdeveloperreporting-v1beta1.json @@ -947,7 +947,7 @@ } } }, - "revision": "20240312", + "revision": "20240704", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { @@ -1558,14 +1558,14 @@ "id": "GooglePlayDeveloperReportingV1beta1QueryErrorCountMetricSetRequest", "properties": { "dimensions": { - "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", + "description": "Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., \"Exynos 2100\". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., \"Kryo 240\". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., \"4198400\". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., \"196610\". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi.", "items": { "type": "string" }, "type": "array" }, "filter": { - "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions.", + "description": "Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED.", "type": "string" }, "metrics": { diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index 87c0268890..a423ad4c10 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -105,6 +105,38 @@ }, "protocol": "rest", "resources": { + "deviceRecall": { + "methods": { + "write": { + "description": "Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).", + "flatPath": "v1/{v1Id}/deviceRecall:write", + "httpMethod": "POST", + "id": "playintegrity.deviceRecall.write", + "parameterOrder": [ + "packageName" + ], + "parameters": { + "packageName": { + "description": "Required. Package name of the app the attached integrity token belongs to.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+packageName}/deviceRecall:write", + "request": { + "$ref": "WriteDeviceRecallRequest" + }, + "response": { + "$ref": "WriteDeviceRecallResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/playintegrity" + ] + } + } + }, "v1": { "methods": { "decodeIntegrityToken": { @@ -138,7 +170,7 @@ } } }, - "revision": "20240508", + "revision": "20240813", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -335,9 +367,13 @@ "type": "object" }, "DeviceIntegrity": { - "description": "Contains the device attestation information. Next tag: 4", + "description": "Contains the device attestation information.", "id": "DeviceIntegrity", "properties": { + "deviceRecall": { + "$ref": "DeviceRecall", + "description": "Details about the device recall bits set by the developer." + }, "deviceRecognitionVerdict": { "description": "Details about the integrity of the device the app is running on.", "items": { @@ -366,6 +402,21 @@ }, "type": "object" }, + "DeviceRecall": { + "description": "Contains the recall bits per device set by the developer.", + "id": "DeviceRecall", + "properties": { + "values": { + "$ref": "Values", + "description": "Required. Contains the recall bits values." + }, + "writeDates": { + "$ref": "WriteDates", + "description": "Required. Contains the recall bits write dates." + } + }, + "type": "object" + }, "EnvironmentDetails": { "description": "Contains information about the environment Play Integrity API runs in, e.g. Play Protect verdict.", "id": "EnvironmentDetails", @@ -491,6 +542,68 @@ } }, "type": "object" + }, + "Values": { + "description": "Contains the recall bits values.", + "id": "Values", + "properties": { + "bitFirst": { + "description": "Required. First recall bit value.", + "type": "boolean" + }, + "bitSecond": { + "description": "Required. Second recall bit value.", + "type": "boolean" + }, + "bitThird": { + "description": "Required. Third recall bit value.", + "type": "boolean" + } + }, + "type": "object" + }, + "WriteDates": { + "description": "Contains the recall bits write dates.", + "id": "WriteDates", + "properties": { + "yyyymmFirst": { + "description": "Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the first bit. Note that this value won't be set if the first bit is false.", + "format": "int32", + "type": "integer" + }, + "yyyymmSecond": { + "description": "Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the second bit. Note that this value won't be set if the second bit is false.", + "format": "int32", + "type": "integer" + }, + "yyyymmThird": { + "description": "Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the third bit. Note that this value won't be set if the third bit is false.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "WriteDeviceRecallRequest": { + "description": "Request to write device recall bits.", + "id": "WriteDeviceRecallRequest", + "properties": { + "integrityToken": { + "description": "Required. Integrity token obtained from calling Play Integrity API.", + "type": "string" + }, + "newValues": { + "$ref": "Values", + "description": "Required. The new values for the device recall bits to be written." + } + }, + "type": "object" + }, + "WriteDeviceRecallResponse": { + "description": "Response for the Write Device Recall action. Currently empty.", + "id": "WriteDeviceRecallResponse", + "properties": {}, + "type": "object" } }, "servicePath": "", diff --git a/discovery/pollen-v1.json b/discovery/pollen-v1.json index 21cb7e5bcc..e5a6cb8fd9 100644 --- a/discovery/pollen-v1.json +++ b/discovery/pollen-v1.json @@ -121,7 +121,7 @@ "type": "integer" }, "languageCode": { - "description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. Default value is \"en\".", + "description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is \"en\".", "location": "query", "type": "string" }, @@ -138,18 +138,18 @@ "type": "number" }, "pageSize": { - "description": "Optional. The maximum number of daily info records to return per page. The default and max value is 5 (5 days of data).", + "description": "Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token all other request parameters provided must match the previous call that provided the page token.", + "description": "Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token.", "location": "query", "type": "string" }, "plantsDescription": { - "description": "Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos.", + "description": "Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is \"true\".", "location": "query", "type": "boolean" } @@ -192,7 +192,7 @@ "Unspecified map type.", "The heatmap type will represent a tree index graphical map.", "The heatmap type will represent a grass index graphical map.", - "The heatmap type will represent a weed index graphically map." + "The heatmap type will represent a weed index graphical map." ], "location": "path", "required": true, @@ -233,7 +233,7 @@ } } }, - "revision": "20240616", + "revision": "20240720", "rootUrl": "https://pollen.googleapis.com/", "schemas": { "Color": { @@ -294,14 +294,14 @@ "description": "The date in UTC at which the pollen forecast data is represented." }, "plantInfo": { - "description": "This list will include (up to) 15 pollen species affecting the location specified in the request.", + "description": "This list will include up to 15 pollen species affecting the location specified in the request.", "items": { "$ref": "PlantInfo" }, "type": "array" }, "pollenTypeInfo": { - "description": "This list will include (up to) three pollen types (grass, weed, tree) affecting the location specified in the request.", + "description": "This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request.", "items": { "$ref": "PollenTypeInfo" }, diff --git a/discovery/prod_tt_sasportal-v1alpha1.json b/discovery/prod_tt_sasportal-v1alpha1.json index acdbe53ac7..f39885e41f 100644 --- a/discovery/prod_tt_sasportal-v1alpha1.json +++ b/discovery/prod_tt_sasportal-v1alpha1.json @@ -2653,7 +2653,7 @@ } } }, - "revision": "20240523", + "revision": "20240730", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2862,7 +2862,8 @@ "DOODLE_CBRS", "CW", "REDLINE", - "TARANA_WIRELESS" + "TARANA_WIRELESS", + "FAROS" ], "enumDescriptions": [ "", @@ -2873,6 +2874,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 30116a81a4..0780fc1a7f 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -20,19 +20,74 @@ "documentationLink": "https://cloud.google.com/pubsub/docs", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west4.rep.googleapis.com/", + "location": "us-west4" } ], "icons": { @@ -1583,7 +1638,7 @@ } } }, - "revision": "20240618", + "revision": "20240730", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { @@ -1782,6 +1837,11 @@ "format": "google-duration", "type": "string" }, + "maxMessages": { + "description": "Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages.", + "format": "int64", + "type": "string" + }, "serviceAccountEmail": { "description": "Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", "type": "string" diff --git a/discovery/pubsub-v1beta1a.json b/discovery/pubsub-v1beta1a.json index 6b85cbeeec..3f7ee0be72 100644 --- a/discovery/pubsub-v1beta1a.json +++ b/discovery/pubsub-v1beta1a.json @@ -20,19 +20,74 @@ "documentationLink": "https://cloud.google.com/pubsub/docs", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west4.rep.googleapis.com/", + "location": "us-west4" } ], "icons": { @@ -474,7 +529,7 @@ } } }, - "revision": "20240227", + "revision": "20240730", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/pubsub-v1beta2.json b/discovery/pubsub-v1beta2.json index 67d3b67d94..74819ddf23 100644 --- a/discovery/pubsub-v1beta2.json +++ b/discovery/pubsub-v1beta2.json @@ -20,19 +20,74 @@ "documentationLink": "https://cloud.google.com/pubsub/docs", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.europe-west8.rep.googleapis.com/", + "location": "europe-west8" + }, + { + "description": "Regional Endpoint", "endpointUrl": "https://pubsub.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-central1.rep.googleapis.com/", + "location": "us-central1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-central2.rep.googleapis.com/", + "location": "us-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east1.rep.googleapis.com/", + "location": "us-east1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east4.rep.googleapis.com/", + "location": "us-east4" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-east5.rep.googleapis.com/", + "location": "us-east5" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-south1.rep.googleapis.com/", + "location": "us-south1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west1.rep.googleapis.com/", + "location": "us-west1" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west2.rep.googleapis.com/", + "location": "us-west2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west3.rep.googleapis.com/", + "location": "us-west3" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.us-west4.rep.googleapis.com/", + "location": "us-west4" } ], "icons": { @@ -741,7 +796,7 @@ } } }, - "revision": "20240227", + "revision": "20240730", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/realtimebidding-v1.json b/discovery/realtimebidding-v1.json index 02425c9c51..98a8a73508 100644 --- a/discovery/realtimebidding-v1.json +++ b/discovery/realtimebidding-v1.json @@ -1305,7 +1305,7 @@ } } }, - "revision": "20240321", + "revision": "20240806", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -1969,6 +1969,27 @@ }, "type": "array" }, + "detectedCategories": { + "description": "Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "detectedCategoriesTaxonomy": { + "description": "Output only. The taxonomy in which the detected_categories field is expressed.", + "enum": [ + "AD_CATEGORY_TAXONOMY_UNSPECIFIED", + "IAB_CONTENT_1_0" + ], + "enumDescriptions": [ + "Default value that should never be used.", + "IAB Content Taxonomy 1.0. See https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv for more details." + ], + "readOnly": true, + "type": "string" + }, "detectedClickThroughUrls": { "description": "The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.", "items": { @@ -2898,14 +2919,16 @@ "HOSTED_MATCH_DATA", "GOOGLE_COOKIE", "DEVICE_ID", - "PUBLISHER_PROVIDED_ID" + "PUBLISHER_PROVIDED_ID", + "PUBLISHER_FIRST_PARTY_ID" ], "enumDescriptions": [ "Placeholder for unspecified user identifier.", "Hosted match data, referring to hosted_match_data in the bid request.", "Google cookie, referring to google_user_id in the bid request.", "Mobile device advertising ID.", - "The request has a publisher-provided ID available to the bidder." + "The request has a publisher-provided ID available to the bidder.", + "Publisher first party ID, scoped to a single site, app or vendor needs to be present on the bid request." ], "type": "string" }, diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json index 129c55f48b..554ac63ce3 100644 --- a/discovery/recaptchaenterprise-v1.json +++ b/discovery/recaptchaenterprise-v1.json @@ -349,6 +349,34 @@ }, "keys": { "methods": { + "addIpOverride": { + "description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.", + "flatPath": "v1/projects/{projectsId}/keys/{keysId}:addIpOverride", + "httpMethod": "POST", + "id": "recaptchaenterprise.projects.keys.addIpOverride", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`.", + "location": "path", + "pattern": "^projects/[^/]+/keys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:addIpOverride", + "request": { + "$ref": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest" + }, + "response": { + "$ref": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "create": { "description": "Creates a new reCAPTCHA Enterprise key.", "flatPath": "v1/projects/{projectsId}/keys", @@ -694,7 +722,7 @@ } } }, - "revision": "20240526", + "revision": "20240804", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -778,6 +806,23 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest": { + "description": "The AddIpOverride request message.", + "id": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest", + "properties": { + "ipOverrideData": { + "$ref": "GoogleCloudRecaptchaenterpriseV1IpOverrideData", + "description": "Required. IP override added to the key." + } + }, + "type": "object" + }, + "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse": { + "description": "Response for AddIpOverride.", + "id": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings": { "description": "Settings specific to keys that can be used by Android apps.", "id": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings", @@ -924,6 +969,10 @@ "$ref": "GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo", "description": "Optional. Account verification information for identity verification. The assessment event must include a token and site key to use this feature." }, + "assessmentEnvironment": { + "$ref": "GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment", + "description": "Optional. The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user." + }, "event": { "$ref": "GoogleCloudRecaptchaenterpriseV1Event", "description": "Optional. The event being assessed." @@ -970,6 +1019,21 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment": { + "description": "The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user.", + "id": "GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment", + "properties": { + "client": { + "description": "Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - \"github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager\" - \"cloud.google.com/recaptcha/docs/implement-waf-akamai\" - \"cloud.google.com/recaptcha/docs/implement-waf-cloudflare\" - \"wordpress.org/plugins/recaptcha-something\"", + "type": "string" + }, + "version": { + "description": "Optional. The version of the client module. For example, \"1.0.0\".", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1ChallengeMetrics": { "description": "Metrics related to challenges.", "id": "GoogleCloudRecaptchaenterpriseV1ChallengeMetrics", @@ -1385,6 +1449,29 @@ }, "type": "object" }, + "GoogleCloudRecaptchaenterpriseV1IpOverrideData": { + "description": "Information about the IP or IP range override.", + "id": "GoogleCloudRecaptchaenterpriseV1IpOverrideData", + "properties": { + "ip": { + "description": "Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48", + "type": "string" + }, + "overrideType": { + "description": "Required. Describes the type of IP override.", + "enum": [ + "OVERRIDE_TYPE_UNSPECIFIED", + "ALLOW" + ], + "enumDescriptions": [ + "Default override type that indicates this enum hasn't been specified.", + "Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 for all valid assessments." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRecaptchaenterpriseV1Key": { "description": "A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.", "id": "GoogleCloudRecaptchaenterpriseV1Key", @@ -1411,7 +1498,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).", + "description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).", "type": "object" }, "name": { @@ -1541,7 +1628,7 @@ "id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest", "properties": { "skipBillingCheck": { - "description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information.", + "description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information.", "type": "boolean" } }, diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 8f1cb33f2e..9ce2a90e23 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -821,7 +821,7 @@ } } }, - "revision": "20240613", + "revision": "20240812", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -987,6 +987,10 @@ "readOnly": true, "type": "string" }, + "crossClusterReplicationConfig": { + "$ref": "CrossClusterReplicationConfig", + "description": "Optional. Cross cluster replication config." + }, "deletionProtectionEnabled": { "description": "Optional. The delete operation will fail when the value is set to true.", "type": "boolean" @@ -1059,7 +1063,7 @@ "type": "integer" }, "shardCount": { - "description": "Required. Number of shards for the Redis cluster.", + "description": "Optional. Number of shards for the Redis cluster.", "format": "int32", "type": "integer" }, @@ -1165,40 +1169,61 @@ }, "type": "object" }, - "CustomMetadataData": { - "description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", - "id": "CustomMetadataData", + "CrossClusterReplicationConfig": { + "description": "Cross cluster replication config.", + "id": "CrossClusterReplicationConfig", "properties": { - "databaseMetadata": { + "clusterRole": { + "description": "The role of the cluster in cross cluster replication.", + "enum": [ + "CLUSTER_ROLE_UNSPECIFIED", + "NONE", + "PRIMARY", + "SECONDARY" + ], + "enumDescriptions": [ + "Cluster role is not set. The behavior is equivalent to NONE.", + "This cluster does not participate in cross cluster replication. It is an independent cluster and does not replicate to or from any other clusters.", + "A cluster that allows both reads and writes. Any data written to this cluster is also replicated to the attached secondary clusters.", + "A cluster that allows only reads and replicates data from a primary cluster." + ], + "type": "string" + }, + "membership": { + "$ref": "Membership", + "description": "Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication.", + "readOnly": true + }, + "primaryCluster": { + "$ref": "RemoteCluster", + "description": "Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster." + }, + "secondaryClusters": { + "description": "List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster.", "items": { - "$ref": "DatabaseMetadata" + "$ref": "RemoteCluster" }, "type": "array" + }, + "updateTime": { + "description": "Output only. The last time cross cluster replication config was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "DatabaseMetadata": { - "description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", - "id": "DatabaseMetadata", + "CustomMetadataData": { + "description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", + "id": "CustomMetadataData", "properties": { - "backupConfiguration": { - "$ref": "BackupConfiguration", - "description": "Backup configuration for this database" - }, - "backupRun": { - "$ref": "BackupRun", - "description": "Information about the last backup attempt for this database" - }, - "product": { - "$ref": "Product" - }, - "resourceId": { - "$ref": "DatabaseResourceId" - }, - "resourceName": { - "description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", - "type": "string" + "internalResourceMetadata": { + "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", + "items": { + "$ref": "InternalResourceMetadata" + }, + "type": "array" } }, "type": "object" @@ -1231,8 +1256,7 @@ "type": "string" }, "observabilityMetricData": { - "$ref": "ObservabilityMetricData", - "description": "More feed data would be added in subsequent CLs" + "$ref": "ObservabilityMetricData" }, "recommendationSignalData": { "$ref": "DatabaseResourceRecommendationSignalData" @@ -1341,6 +1365,24 @@ "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, + "signalSeverity": { + "description": "The severity of the signal, such as if it's a HIGH or LOW severity.", + "enum": [ + "SIGNAL_SEVERITY_UNSPECIFIED", + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "This value is used for findings when a source doesn't write a severity value.", + "A critical vulnerability is easily discoverable by an external actor, exploitable.", + "A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", + "A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", + "A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." + ], + "type": "string" + }, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -1637,7 +1679,7 @@ "type": "string" }, "resourceType": { - "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", + "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -2571,6 +2613,31 @@ }, "type": "object" }, + "InternalResourceMetadata": { + "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", + "id": "InternalResourceMetadata", + "properties": { + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "Backup configuration for this database" + }, + "backupRun": { + "$ref": "BackupRun", + "description": "Information about the last backup attempt for this database" + }, + "product": { + "$ref": "Product" + }, + "resourceId": { + "$ref": "DatabaseResourceId" + }, + "resourceName": { + "description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", + "type": "string" + } + }, + "type": "object" + }, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2781,6 +2848,26 @@ }, "type": "object" }, + "Membership": { + "description": "An output only view of all the member clusters participating in the cross cluster replication.", + "id": "Membership", + "properties": { + "primaryCluster": { + "$ref": "RemoteCluster", + "description": "Output only. The primary cluster that acts as the source of replication for the secondary clusters.", + "readOnly": true + }, + "secondaryClusters": { + "description": "Output only. The list of secondary clusters replicating from the primary cluster.", + "items": { + "$ref": "RemoteCluster" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "NodeInfo": { "description": "Node specific properties.", "id": "NodeInfo", @@ -3051,7 +3138,9 @@ "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", - "ENGINE_OTHER" + "ENGINE_OTHER", + "ENGINE_FIRESTORE_WITH_NATIVE_MODE", + "ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -3067,6 +3156,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -3083,7 +3174,9 @@ "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", - "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." + "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", + "Firestore with native mode.", + "Firestore with datastore mode." ], "type": "string" }, @@ -3100,7 +3193,8 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER" + "PRODUCT_TYPE_OTHER", + "PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -3113,6 +3207,7 @@ true, false, false, + false, false ], "enumDescriptions": [ @@ -3126,7 +3221,8 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", + "Firestore product area in GCP." ], "type": "string" }, @@ -3239,6 +3335,22 @@ }, "type": "object" }, + "RemoteCluster": { + "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", + "id": "RemoteCluster", + "properties": { + "cluster": { + "description": "The full resource path of the remote cluster in the format: projects//locations//clusters/", + "type": "string" + }, + "uid": { + "description": "Output only. The unique identifier of the remote cluster.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/discovery/redis-v1beta1.json b/discovery/redis-v1beta1.json index ed7a5b2d7d..4ccc5bee1b 100644 --- a/discovery/redis-v1beta1.json +++ b/discovery/redis-v1beta1.json @@ -821,7 +821,7 @@ } } }, - "revision": "20240613", + "revision": "20240812", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -987,6 +987,10 @@ "readOnly": true, "type": "string" }, + "crossClusterReplicationConfig": { + "$ref": "CrossClusterReplicationConfig", + "description": "Optional. Cross cluster replication config." + }, "deletionProtectionEnabled": { "description": "Optional. The delete operation will fail when the value is set to true.", "type": "boolean" @@ -1059,7 +1063,7 @@ "type": "integer" }, "shardCount": { - "description": "Required. Number of shards for the Redis cluster.", + "description": "Optional. Number of shards for the Redis cluster.", "format": "int32", "type": "integer" }, @@ -1165,40 +1169,61 @@ }, "type": "object" }, - "CustomMetadataData": { - "description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", - "id": "CustomMetadataData", + "CrossClusterReplicationConfig": { + "description": "Cross cluster replication config.", + "id": "CrossClusterReplicationConfig", "properties": { - "databaseMetadata": { + "clusterRole": { + "description": "The role of the cluster in cross cluster replication.", + "enum": [ + "CLUSTER_ROLE_UNSPECIFIED", + "NONE", + "PRIMARY", + "SECONDARY" + ], + "enumDescriptions": [ + "Cluster role is not set. The behavior is equivalent to NONE.", + "This cluster does not participate in cross cluster replication. It is an independent cluster and does not replicate to or from any other clusters.", + "A cluster that allows both reads and writes. Any data written to this cluster is also replicated to the attached secondary clusters.", + "A cluster that allows only reads and replicates data from a primary cluster." + ], + "type": "string" + }, + "membership": { + "$ref": "Membership", + "description": "Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication.", + "readOnly": true + }, + "primaryCluster": { + "$ref": "RemoteCluster", + "description": "Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster." + }, + "secondaryClusters": { + "description": "List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster.", "items": { - "$ref": "DatabaseMetadata" + "$ref": "RemoteCluster" }, "type": "array" + }, + "updateTime": { + "description": "Output only. The last time cross cluster replication config was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "DatabaseMetadata": { - "description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.", - "id": "DatabaseMetadata", + "CustomMetadataData": { + "description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data", + "id": "CustomMetadataData", "properties": { - "backupConfiguration": { - "$ref": "BackupConfiguration", - "description": "Backup configuration for this database" - }, - "backupRun": { - "$ref": "BackupRun", - "description": "Information about the last backup attempt for this database" - }, - "product": { - "$ref": "Product" - }, - "resourceId": { - "$ref": "DatabaseResourceId" - }, - "resourceName": { - "description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", - "type": "string" + "internalResourceMetadata": { + "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.", + "items": { + "$ref": "InternalResourceMetadata" + }, + "type": "array" } }, "type": "object" @@ -1231,8 +1256,7 @@ "type": "string" }, "observabilityMetricData": { - "$ref": "ObservabilityMetricData", - "description": "More feed data would be added in subsequent CLs" + "$ref": "ObservabilityMetricData" }, "recommendationSignalData": { "$ref": "DatabaseResourceRecommendationSignalData" @@ -1341,6 +1365,24 @@ "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", "type": "string" }, + "signalSeverity": { + "description": "The severity of the signal, such as if it's a HIGH or LOW severity.", + "enum": [ + "SIGNAL_SEVERITY_UNSPECIFIED", + "CRITICAL", + "HIGH", + "MEDIUM", + "LOW" + ], + "enumDescriptions": [ + "This value is used for findings when a source doesn't write a severity value.", + "A critical vulnerability is easily discoverable by an external actor, exploitable.", + "A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.", + "A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.", + "A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment." + ], + "type": "string" + }, "signalType": { "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.", "enum": [ @@ -1637,7 +1679,7 @@ "type": "string" }, "resourceType": { - "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", + "description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -2578,6 +2620,31 @@ }, "type": "object" }, + "InternalResourceMetadata": { + "description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.", + "id": "InternalResourceMetadata", + "properties": { + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "Backup configuration for this database" + }, + "backupRun": { + "$ref": "BackupRun", + "description": "Information about the last backup attempt for this database" + }, + "product": { + "$ref": "Product" + }, + "resourceId": { + "$ref": "DatabaseResourceId" + }, + "resourceName": { + "description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"", + "type": "string" + } + }, + "type": "object" + }, "ListClustersResponse": { "description": "Response for ListClusters.", "id": "ListClustersResponse", @@ -2788,6 +2855,26 @@ }, "type": "object" }, + "Membership": { + "description": "An output only view of all the member clusters participating in the cross cluster replication.", + "id": "Membership", + "properties": { + "primaryCluster": { + "$ref": "RemoteCluster", + "description": "Output only. The primary cluster that acts as the source of replication for the secondary clusters.", + "readOnly": true + }, + "secondaryClusters": { + "description": "Output only. The list of secondary clusters replicating from the primary cluster.", + "items": { + "$ref": "RemoteCluster" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "NodeInfo": { "description": "Node specific properties.", "id": "NodeInfo", @@ -3058,7 +3145,9 @@ "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT", "ENGINE_MEMORYSTORE_FOR_REDIS", "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER", - "ENGINE_OTHER" + "ENGINE_OTHER", + "ENGINE_FIRESTORE_WITH_NATIVE_MODE", + "ENGINE_FIRESTORE_WITH_DATASTORE_MODE" ], "enumDeprecated": [ false, @@ -3074,6 +3163,8 @@ false, false, false, + false, + false, false ], "enumDescriptions": [ @@ -3090,7 +3181,9 @@ "Cloud Spanner with Google SQL dialect.", "Memorystore with Redis dialect.", "Memorystore with Redis cluster dialect.", - "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum." + "Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.", + "Firestore with native mode.", + "Firestore with datastore mode." ], "type": "string" }, @@ -3107,7 +3200,8 @@ "ON_PREM", "PRODUCT_TYPE_MEMORYSTORE", "PRODUCT_TYPE_BIGTABLE", - "PRODUCT_TYPE_OTHER" + "PRODUCT_TYPE_OTHER", + "PRODUCT_TYPE_FIRESTORE" ], "enumDeprecated": [ false, @@ -3120,6 +3214,7 @@ true, false, false, + false, false ], "enumDescriptions": [ @@ -3133,7 +3228,8 @@ "On premises database product.", "Memorystore product area in GCP", "Bigtable product area in GCP", - "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum." + "Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.", + "Firestore product area in GCP." ], "type": "string" }, @@ -3246,6 +3342,22 @@ }, "type": "object" }, + "RemoteCluster": { + "description": "Details of the remote cluster associated with this cluster in a cross cluster replication setup.", + "id": "RemoteCluster", + "properties": { + "cluster": { + "description": "The full resource path of the remote cluster in the format: projects//locations//clusters/", + "type": "string" + }, + "uid": { + "description": "Output only. The unique identifier of the remote cluster.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "RescheduleMaintenanceRequest": { "description": "Request for RescheduleMaintenance.", "id": "RescheduleMaintenanceRequest", diff --git a/discovery/retail-v2.json b/discovery/retail-v2.json index f8bc69d5f2..3de0589e55 100644 --- a/discovery/retail-v2.json +++ b/discovery/retail-v2.json @@ -2092,7 +2092,7 @@ } } }, - "revision": "20240614", + "revision": "20240801", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2637,14 +2637,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" - }, - "mergedFacetValues": { - "deprecated": true, - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", - "items": { - "$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue" - }, - "type": "array" } }, "type": "object" @@ -2710,6 +2702,13 @@ "description": "Response of the autocomplete query.", "id": "GoogleCloudRetailV2CompleteQueryResponse", "properties": { + "attributeResults": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2CompleteQueryResponseAttributeResult" + }, + "description": "A map of matched attribute suggestions. This field is only available for \"cloud-retail\" dataset. Current supported keys: * `brands` * `categories`", + "type": "object" + }, "attributionToken": { "description": "A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.", "type": "string" @@ -2732,6 +2731,19 @@ }, "type": "object" }, + "GoogleCloudRetailV2CompleteQueryResponseAttributeResult": { + "description": "Resource that represents attribute results.", + "id": "GoogleCloudRetailV2CompleteQueryResponseAttributeResult", + "properties": { + "suggestions": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2CompleteQueryResponseCompletionResult": { "description": "Resource that represents completion results.", "id": "GoogleCloudRetailV2CompleteQueryResponseCompletionResult", @@ -2752,7 +2764,7 @@ }, "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult": { "deprecated": true, - "description": "Recent search of this user.", + "description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index 12c8b7f9a9..9d4b416a1f 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -1030,6 +1030,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "export": { + "description": "Exports multiple Products.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:export", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.branches.products.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+parent}/products:export", + "request": { + "$ref": "GoogleCloudRetailV2alphaExportProductsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a Product.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}", @@ -2259,6 +2287,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "export": { + "description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", + "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+parent}/userEvents:export", + "request": { + "$ref": "GoogleCloudRetailV2alphaExportUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2557,7 +2613,7 @@ } } }, - "revision": "20240614", + "revision": "20240801", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3405,7 +3461,7 @@ "id": "GoogleCloudRetailV2alphaAlertConfigAlertPolicy", "properties": { "alertGroup": { - "description": "The feature that provides alerting capability. Supported value is only `search-data-quality` for now.", + "description": "The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.", "type": "string" }, "enrollStatus": { @@ -3610,16 +3666,6 @@ "readOnly": true, "type": "array" }, - "productCounts": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "deprecated": true, - "description": "Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * \"primary-in-stock\", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * \"primary-out-of-stock\", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * \"primary-preorder\", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * \"primary-backorder\", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * \"variant-in-stock\", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * \"variant-out-of-stock\", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * \"variant-preorder\", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * \"variant-backorder\", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * \"price-discounted\", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view.", - "readOnly": true, - "type": "object" - }, "qualityMetrics": { "description": "Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view.", "items": { @@ -3902,14 +3948,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" - }, - "mergedFacetValues": { - "deprecated": true, - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", - "items": { - "$ref": "GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue" - }, - "type": "array" } }, "type": "object" @@ -4009,7 +4047,6 @@ "id": "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult", "properties": { "suggestions": { - "description": "The list of suggestions for the attribute.", "items": { "type": "string" }, @@ -4050,7 +4087,7 @@ }, "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": { "deprecated": true, - "description": "Recent search of this user.", + "description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { @@ -4479,6 +4516,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaExportProductsRequest": { + "description": "Request message for ExportProducts method.", + "id": "GoogleCloudRetailV2alphaExportProductsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2alphaOutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaExportProductsResponse": { "description": "Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2alphaExportProductsResponse", @@ -4501,6 +4553,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaExportUserEventsRequest": { + "description": "Request message for the `ExportUserEvents` method.", + "id": "GoogleCloudRetailV2alphaExportUserEventsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2alphaOutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2alphaExportUserEventsResponse", diff --git a/discovery/retail-v2beta.json b/discovery/retail-v2beta.json index 97f75ae690..63fea33970 100644 --- a/discovery/retail-v2beta.json +++ b/discovery/retail-v2beta.json @@ -106,6 +106,67 @@ "protocol": "rest", "resources": { "projects": { + "methods": { + "getAlertConfig": { + "description": "Get the AlertConfig of the requested project.", + "flatPath": "v2beta/projects/{projectsId}/alertConfig", + "httpMethod": "GET", + "id": "retail.projects.getAlertConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig", + "location": "path", + "pattern": "^projects/[^/]+/alertConfig$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+name}", + "response": { + "$ref": "GoogleCloudRetailV2betaAlertConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "updateAlertConfig": { + "description": "Update the alert config of the requested project.", + "flatPath": "v2beta/projects/{projectsId}/alertConfig", + "httpMethod": "PATCH", + "id": "retail.projects.updateAlertConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig", + "location": "path", + "pattern": "^projects/[^/]+/alertConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta/{+name}", + "request": { + "$ref": "GoogleCloudRetailV2betaAlertConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2betaAlertConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "locations": { "resources": { @@ -712,6 +773,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "export": { + "description": "Exports multiple Products.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products:export", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.branches.products.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+/branches/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+parent}/products:export", + "request": { + "$ref": "GoogleCloudRetailV2betaExportProductsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets a Product.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/branches/{branchesId}/products/{productsId}", @@ -1854,6 +1943,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "export": { + "description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", + "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", + "httpMethod": "POST", + "id": "retail.projects.locations.catalogs.userEvents.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2beta/{+parent}/userEvents:export", + "request": { + "$ref": "GoogleCloudRetailV2betaExportUserEventsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "import": { "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2120,7 +2237,7 @@ } } }, - "revision": "20240614", + "revision": "20240801", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3769,6 +3886,67 @@ "properties": {}, "type": "object" }, + "GoogleCloudRetailV2betaAlertConfig": { + "description": "Project level alert config.", + "id": "GoogleCloudRetailV2betaAlertConfig", + "properties": { + "alertPolicies": { + "description": "Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]", + "items": { + "$ref": "GoogleCloudRetailV2betaAlertConfigAlertPolicy" + }, + "type": "array" + }, + "name": { + "description": "Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaAlertConfigAlertPolicy": { + "description": "Alert policy for a customer.", + "id": "GoogleCloudRetailV2betaAlertConfigAlertPolicy", + "properties": { + "alertGroup": { + "description": "The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.", + "type": "string" + }, + "enrollStatus": { + "description": "The enrollment status of a customer.", + "enum": [ + "ENROLL_STATUS_UNSPECIFIED", + "ENROLLED", + "DECLINED" + ], + "enumDescriptions": [ + "Default value. Used for customers who have not responded to the alert policy.", + "Customer is enrolled in this policy.", + "Customer declined this policy." + ], + "type": "string" + }, + "recipients": { + "description": "Recipients for the alert policy. One alert policy should not exceed 20 recipients.", + "items": { + "$ref": "GoogleCloudRetailV2betaAlertConfigAlertPolicyRecipient" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2betaAlertConfigAlertPolicyRecipient": { + "description": "Recipient contact information.", + "id": "GoogleCloudRetailV2betaAlertConfigAlertPolicyRecipient", + "properties": { + "emailAddress": { + "description": "Email address of the recipient.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaAttributesConfig": { "description": "Catalog level attribute config.", "id": "GoogleCloudRetailV2betaAttributesConfig", @@ -4113,14 +4291,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" - }, - "mergedFacetValues": { - "deprecated": true, - "description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", - "items": { - "$ref": "GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue" - }, - "type": "array" } }, "type": "object" @@ -4186,6 +4356,13 @@ "description": "Response of the autocomplete query.", "id": "GoogleCloudRetailV2betaCompleteQueryResponse", "properties": { + "attributeResults": { + "additionalProperties": { + "$ref": "GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult" + }, + "description": "A map of matched attribute suggestions. This field is only available for \"cloud-retail\" dataset. Current supported keys: * `brands` * `categories`", + "type": "object" + }, "attributionToken": { "description": "A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.", "type": "string" @@ -4208,6 +4385,19 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult": { + "description": "Resource that represents attribute results.", + "id": "GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult", + "properties": { + "suggestions": { + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult": { "description": "Resource that represents completion results.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseCompletionResult", @@ -4228,7 +4418,7 @@ }, "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult": { "deprecated": true, - "description": "Recent search of this user.", + "description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { @@ -4592,6 +4782,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaExportProductsRequest": { + "description": "Request message for ExportProducts method.", + "id": "GoogleCloudRetailV2betaExportProductsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime<\"2012-04-23T18:25:43.511Z\" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-\"tagA\"`', which is equivalent to '`NOT \"tagA\"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" lastModifiedTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\" productType = \"variant\"` * Example 3: `tag=(\"Red\" OR \"Blue\") tag=\"New-Arrival\" tag=(NOT \"promotional\") productType = \"primary\" lastModifiedTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `lastModifiedTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `availability = (IN_STOCK OR BACKORDER)`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2betaOutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaExportProductsResponse": { "description": "Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2betaExportProductsResponse", @@ -4614,6 +4819,21 @@ }, "type": "object" }, + "GoogleCloudRetailV2betaExportUserEventsRequest": { + "description": "Request message for the `ExportUserEvents` method.", + "id": "GoogleCloudRetailV2betaExportUserEventsRequest", + "properties": { + "filter": { + "description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", + "type": "string" + }, + "outputConfig": { + "$ref": "GoogleCloudRetailV2betaOutputConfig", + "description": "Required. The output location of the data." + } + }, + "type": "object" + }, "GoogleCloudRetailV2betaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2betaExportUserEventsResponse", diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 1c29b457a7..74c691efd2 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -17,204 +17,204 @@ "documentationLink": "https://cloud.google.com/run/", "endpoints": [ { + "description": "Locational Endpoint", "endpointUrl": "https://africa-south1-run.googleapis.com/", - "location": "africa-south1", - "description": "Locational Endpoint" + "location": "africa-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east1-run.googleapis.com/", - "location": "asia-east1", - "description": "Locational Endpoint" + "location": "asia-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-run.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "location": "asia-east2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-run.googleapis.com/", - "location": "asia-northeast1", - "description": "Locational Endpoint" + "location": "asia-northeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast2-run.googleapis.com/", - "location": "asia-northeast2", - "description": "Locational Endpoint" + "location": "asia-northeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-run.googleapis.com/", - "location": "asia-northeast3", - "description": "Locational Endpoint" + "location": "asia-northeast3" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-south1-run.googleapis.com/", - "location": "asia-south1", - "description": "Locational Endpoint" + "location": "asia-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-south2-run.googleapis.com/", - "location": "asia-south2", - "description": "Locational Endpoint" + "location": "asia-south2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-run.googleapis.com/", - "location": "asia-southeast1", - "description": "Locational Endpoint" + "location": "asia-southeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast2-run.googleapis.com/", - "location": "asia-southeast2", - "description": "Locational Endpoint" + "location": "asia-southeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-run.googleapis.com/", - "location": "australia-southeast1", - "description": "Locational Endpoint" + "location": "australia-southeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast2-run.googleapis.com/", - "location": "australia-southeast2", - "description": "Locational Endpoint" + "location": "australia-southeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-central2-run.googleapis.com/", - "location": "europe-central2", - "description": "Locational Endpoint" + "location": "europe-central2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-north1-run.googleapis.com/", - "location": "europe-north1", - "description": "Locational Endpoint" + "location": "europe-north1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-run.googleapis.com/", - "location": "europe-southwest1", - "description": "Locational Endpoint" + "location": "europe-southwest1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west1-run.googleapis.com/", - "location": "europe-west1", - "description": "Locational Endpoint" + "location": "europe-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west10-run.googleapis.com/", - "location": "europe-west10", - "description": "Locational Endpoint" + "location": "europe-west10" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west12-run.googleapis.com/", - "location": "europe-west12", - "description": "Locational Endpoint" + "location": "europe-west12" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-run.googleapis.com/", - "location": "europe-west2", - "description": "Locational Endpoint" + "location": "europe-west2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-run.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" + "location": "europe-west3" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west4-run.googleapis.com/", - "location": "europe-west4", - "description": "Locational Endpoint" + "location": "europe-west4" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west6-run.googleapis.com/", - "location": "europe-west6", - "description": "Locational Endpoint" + "location": "europe-west6" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west8-run.googleapis.com/", - "location": "europe-west8", - "description": "Locational Endpoint" + "location": "europe-west8" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west9-run.googleapis.com/", - "location": "europe-west9", - "description": "Locational Endpoint" + "location": "europe-west9" }, { + "description": "Locational Endpoint", "endpointUrl": "https://me-central1-run.googleapis.com/", - "location": "me-central1", - "description": "Locational Endpoint" + "location": "me-central1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://me-central2-run.googleapis.com/", - "location": "me-central2", - "description": "Locational Endpoint" + "location": "me-central2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://me-west1-run.googleapis.com/", - "location": "me-west1", - "description": "Locational Endpoint" + "location": "me-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast1-run.googleapis.com/", - "location": "northamerica-northeast1", - "description": "Locational Endpoint" + "location": "northamerica-northeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-run.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Locational Endpoint" + "location": "northamerica-northeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-run.googleapis.com/", - "location": "southamerica-east1", - "description": "Locational Endpoint" + "location": "southamerica-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-run.googleapis.com/", - "location": "southamerica-west1", - "description": "Locational Endpoint" + "location": "southamerica-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-central1-run.googleapis.com/", - "location": "us-central1", - "description": "Locational Endpoint" + "location": "us-central1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east1-run.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" + "location": "us-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east4-run.googleapis.com/", - "location": "us-east4", - "description": "Locational Endpoint" + "location": "us-east4" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east5-run.googleapis.com/", - "location": "us-east5", - "description": "Locational Endpoint" + "location": "us-east5" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-south1-run.googleapis.com/", - "location": "us-south1", - "description": "Locational Endpoint" + "location": "us-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west1-run.googleapis.com/", - "location": "us-west1", - "description": "Locational Endpoint" + "location": "us-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west2-run.googleapis.com/", - "location": "us-west2", - "description": "Locational Endpoint" + "location": "us-west2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west3-run.googleapis.com/", - "location": "us-west3", - "description": "Locational Endpoint" + "location": "us-west3" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west4-run.googleapis.com/", - "location": "us-west4", - "description": "Locational Endpoint" + "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -2614,7 +2614,7 @@ } } }, - "revision": "20240524", + "revision": "20240802", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -3229,6 +3229,26 @@ "description": "Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.", "id": "ExecutionReference", "properties": { + "completionStatus": { + "description": "Optional. Status for the execution completion.", + "enum": [ + "COMPLETION_STATUS_UNSPECIFIED", + "EXECUTION_SUCCEEDED", + "EXECUTION_FAILED", + "EXECUTION_RUNNING", + "EXECUTION_PENDING", + "EXECUTION_CANCELLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Job execution has succeeded.", + "Job execution has failed.", + "Job execution is running normally.", + "Waiting for backing resources to be provisioned.", + "Job execution has been cancelled by the user." + ], + "type": "string" + }, "completionTimestamp": { "description": "Optional. Completion timestamp of the execution.", "format": "google-datetime", @@ -3239,6 +3259,11 @@ "format": "google-datetime", "type": "string" }, + "deletionTimestamp": { + "description": "Optional. The read-only soft deletion timestamp of the execution.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "Optional. Name of the execution.", "type": "string" @@ -4172,26 +4197,6 @@ }, "type": "object" }, - "GoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "GoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "GoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "GoogleDevtoolsCloudbuildV1GitConfig", @@ -4255,12 +4260,8 @@ "id": "GoogleDevtoolsCloudbuildV1HttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" - }, - "proxySslCaInfo": { - "$ref": "GoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" @@ -5380,7 +5381,7 @@ "additionalProperties": { "type": "string" }, - "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", + "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/enable-automatic-updates`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/image-uri`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", "type": "object" }, "clusterName": { @@ -5673,12 +5674,12 @@ "id": "RevisionSpec", "properties": { "containerConcurrency": { - "description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80.", + "description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, "containers": { - "description": "Required. Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided.", + "description": "Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle.", "items": { "$ref": "Container" }, diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 707d6deba9..4b7e89ce83 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -17,204 +17,204 @@ "documentationLink": "https://cloud.google.com/run/", "endpoints": [ { + "description": "Locational Endpoint", "endpointUrl": "https://africa-south1-run.googleapis.com/", - "location": "africa-south1", - "description": "Locational Endpoint" + "location": "africa-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east1-run.googleapis.com/", - "location": "asia-east1", - "description": "Locational Endpoint" + "location": "asia-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-run.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "location": "asia-east2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-run.googleapis.com/", - "location": "asia-northeast1", - "description": "Locational Endpoint" + "location": "asia-northeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast2-run.googleapis.com/", - "location": "asia-northeast2", - "description": "Locational Endpoint" + "location": "asia-northeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-run.googleapis.com/", - "location": "asia-northeast3", - "description": "Locational Endpoint" + "location": "asia-northeast3" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-south1-run.googleapis.com/", - "location": "asia-south1", - "description": "Locational Endpoint" + "location": "asia-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-south2-run.googleapis.com/", - "location": "asia-south2", - "description": "Locational Endpoint" + "location": "asia-south2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-run.googleapis.com/", - "location": "asia-southeast1", - "description": "Locational Endpoint" + "location": "asia-southeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast2-run.googleapis.com/", - "location": "asia-southeast2", - "description": "Locational Endpoint" + "location": "asia-southeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast1-run.googleapis.com/", - "location": "australia-southeast1", - "description": "Locational Endpoint" + "location": "australia-southeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://australia-southeast2-run.googleapis.com/", - "location": "australia-southeast2", - "description": "Locational Endpoint" + "location": "australia-southeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-central2-run.googleapis.com/", - "location": "europe-central2", - "description": "Locational Endpoint" + "location": "europe-central2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-north1-run.googleapis.com/", - "location": "europe-north1", - "description": "Locational Endpoint" + "location": "europe-north1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-southwest1-run.googleapis.com/", - "location": "europe-southwest1", - "description": "Locational Endpoint" + "location": "europe-southwest1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west1-run.googleapis.com/", - "location": "europe-west1", - "description": "Locational Endpoint" + "location": "europe-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west10-run.googleapis.com/", - "location": "europe-west10", - "description": "Locational Endpoint" + "location": "europe-west10" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west12-run.googleapis.com/", - "location": "europe-west12", - "description": "Locational Endpoint" + "location": "europe-west12" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west2-run.googleapis.com/", - "location": "europe-west2", - "description": "Locational Endpoint" + "location": "europe-west2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west3-run.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" + "location": "europe-west3" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west4-run.googleapis.com/", - "location": "europe-west4", - "description": "Locational Endpoint" + "location": "europe-west4" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west6-run.googleapis.com/", - "location": "europe-west6", - "description": "Locational Endpoint" + "location": "europe-west6" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west8-run.googleapis.com/", - "location": "europe-west8", - "description": "Locational Endpoint" + "location": "europe-west8" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west9-run.googleapis.com/", - "location": "europe-west9", - "description": "Locational Endpoint" + "location": "europe-west9" }, { + "description": "Locational Endpoint", "endpointUrl": "https://me-central1-run.googleapis.com/", - "location": "me-central1", - "description": "Locational Endpoint" + "location": "me-central1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://me-central2-run.googleapis.com/", - "location": "me-central2", - "description": "Locational Endpoint" + "location": "me-central2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://me-west1-run.googleapis.com/", - "location": "me-west1", - "description": "Locational Endpoint" + "location": "me-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast1-run.googleapis.com/", - "location": "northamerica-northeast1", - "description": "Locational Endpoint" + "location": "northamerica-northeast1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://northamerica-northeast2-run.googleapis.com/", - "location": "northamerica-northeast2", - "description": "Locational Endpoint" + "location": "northamerica-northeast2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-east1-run.googleapis.com/", - "location": "southamerica-east1", - "description": "Locational Endpoint" + "location": "southamerica-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-run.googleapis.com/", - "location": "southamerica-west1", - "description": "Locational Endpoint" + "location": "southamerica-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-central1-run.googleapis.com/", - "location": "us-central1", - "description": "Locational Endpoint" + "location": "us-central1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east1-run.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" + "location": "us-east1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east4-run.googleapis.com/", - "location": "us-east4", - "description": "Locational Endpoint" + "location": "us-east4" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east5-run.googleapis.com/", - "location": "us-east5", - "description": "Locational Endpoint" + "location": "us-east5" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-south1-run.googleapis.com/", - "location": "us-south1", - "description": "Locational Endpoint" + "location": "us-south1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west1-run.googleapis.com/", - "location": "us-west1", - "description": "Locational Endpoint" + "location": "us-west1" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west2-run.googleapis.com/", - "location": "us-west2", - "description": "Locational Endpoint" + "location": "us-west2" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west3-run.googleapis.com/", - "location": "us-west3", - "description": "Locational Endpoint" + "location": "us-west3" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-west4-run.googleapis.com/", - "location": "us-west4", - "description": "Locational Endpoint" + "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -388,6 +388,31 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "exportProjectMetadata": { + "description": "Export generated customer metadata for a given project.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}:exportProjectMetadata", + "httpMethod": "GET", + "id": "run.projects.locations.exportProjectMetadata", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the project of which metadata should be exported. Format: `projects/{project_id_or_number}/locations/{location}` for Project in a given location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}:exportProjectMetadata", + "response": { + "$ref": "GoogleCloudRunV2Metadata" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -1469,7 +1494,7 @@ } } }, - "revision": "20240621", + "revision": "20240802", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2029,6 +2054,26 @@ "description": "Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status.", "id": "GoogleCloudRunV2ExecutionReference", "properties": { + "completionStatus": { + "description": "Status for the execution completion.", + "enum": [ + "COMPLETION_STATUS_UNSPECIFIED", + "EXECUTION_SUCCEEDED", + "EXECUTION_FAILED", + "EXECUTION_RUNNING", + "EXECUTION_PENDING", + "EXECUTION_CANCELLED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "Job execution has succeeded.", + "Job execution has failed.", + "Job execution is running normally.", + "Waiting for backing resources to be provisioned.", + "Job execution has been cancelled by the user." + ], + "type": "string" + }, "completionTime": { "description": "Creation timestamp of the execution.", "format": "google-datetime", @@ -2039,6 +2084,11 @@ "format": "google-datetime", "type": "string" }, + "deleteTime": { + "description": "The deletion time of the execution. It is only populated as a response to a Delete request.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "Name of the execution.", "type": "string" @@ -2141,7 +2191,7 @@ "id": "GoogleCloudRunV2GCSVolumeSource", "properties": { "bucket": { - "description": "Cloud Storage Bucket name. TODO (b/344678062) Fix the error validation once dynamic mounting is public.", + "description": "Cloud Storage Bucket name.", "type": "string" }, "readOnly": { @@ -2818,6 +2868,10 @@ "description": "Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has.", "type": "string" }, + "serviceMesh": { + "$ref": "GoogleCloudRunV2ServiceMesh", + "description": "Enables service mesh connectivity." + }, "sessionAffinity": { "description": "Enable session affinity.", "type": "boolean" @@ -2929,7 +2983,7 @@ "type": "object" }, "maxInstanceRequestConcurrency": { - "description": "Optional. Sets the maximum number of requests that each serving instance can receive.", + "description": "Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, @@ -2949,6 +3003,10 @@ "description": "Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account.", "type": "string" }, + "serviceMesh": { + "$ref": "GoogleCloudRunV2ServiceMesh", + "description": "Optional. Enables service mesh connectivity." + }, "sessionAffinity": { "description": "Optional. Enable session affinity.", "type": "boolean" @@ -3240,6 +3298,17 @@ }, "type": "object" }, + "GoogleCloudRunV2ServiceMesh": { + "description": "Service mesh configuration.", + "id": "GoogleCloudRunV2ServiceMesh", + "properties": { + "mesh": { + "description": "The service mesh resource name. Format: projects/{project_number}/locations/global/meshes/{mesh}.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRunV2ServiceScaling": { "description": "Scaling settings applied at the service level rather than at the revision level.", "id": "GoogleCloudRunV2ServiceScaling", @@ -4464,26 +4533,6 @@ }, "type": "object" }, - "GoogleDevtoolsCloudbuildV1GCSLocation": { - "description": "Represents a storage location in Cloud Storage", - "id": "GoogleDevtoolsCloudbuildV1GCSLocation", - "properties": { - "bucket": { - "description": "Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements", - "type": "string" - }, - "generation": { - "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", - "format": "int64", - "type": "string" - }, - "object": { - "description": "Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames", - "type": "string" - } - }, - "type": "object" - }, "GoogleDevtoolsCloudbuildV1GitConfig": { "description": "GitConfig is a configuration for git operations.", "id": "GoogleDevtoolsCloudbuildV1GitConfig", @@ -4547,12 +4596,8 @@ "id": "GoogleDevtoolsCloudbuildV1HttpConfig", "properties": { "proxySecretVersionName": { - "description": "SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port].", + "description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" - }, - "proxySslCaInfo": { - "$ref": "GoogleDevtoolsCloudbuildV1GCSLocation", - "description": "Optional. Cloud Storage object storing the certificate to use with the HTTP proxy." } }, "type": "object" diff --git a/discovery/sasportal-v1alpha1.json b/discovery/sasportal-v1alpha1.json index 74a037041c..d00133afdc 100644 --- a/discovery/sasportal-v1alpha1.json +++ b/discovery/sasportal-v1alpha1.json @@ -2652,7 +2652,7 @@ } } }, - "revision": "20240521", + "revision": "20240801", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2861,7 +2861,8 @@ "DOODLE_CBRS", "CW", "REDLINE", - "TARANA_WIRELESS" + "TARANA_WIRELESS", + "FAROS" ], "enumDescriptions": [ "", @@ -2872,6 +2873,7 @@ "", "", "", + "", "" ], "type": "string" diff --git a/discovery/searchconsole-v1.json b/discovery/searchconsole-v1.json index 9066b7e97c..5d3f2c873e 100644 --- a/discovery/searchconsole-v1.json +++ b/discovery/searchconsole-v1.json @@ -17,7 +17,7 @@ "canonicalName": "Search Console", "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", "discoveryVersion": "v1", - "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", + "documentationLink": "https://developers.google.com/webmaster-tools/about", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -400,7 +400,7 @@ } } }, - "revision": "20230920", + "revision": "20240708", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/discovery/secretmanager-v1.json b/discovery/secretmanager-v1.json index 29b97a90a9..3fe31d2822 100644 --- a/discovery/secretmanager-v1.json +++ b/discovery/secretmanager-v1.json @@ -17,79 +17,84 @@ "documentationLink": "https://cloud.google.com/secret-manager/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.me-west1.rep.googleapis.com/", - "location": "me-west1", - "description": "Regional Endpoint" + "location": "me-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west6.rep.googleapis.com/", + "location": "europe-west6" } ], "fullyEncodeReservedExpansion": true, @@ -1185,7 +1190,7 @@ } } }, - "revision": "20240527", + "revision": "20240726", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta1.json b/discovery/secretmanager-v1beta1.json index 67d2a1d19e..cf48bdae6d 100644 --- a/discovery/secretmanager-v1beta1.json +++ b/discovery/secretmanager-v1beta1.json @@ -17,79 +17,84 @@ "documentationLink": "https://cloud.google.com/secret-manager/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.me-west1.rep.googleapis.com/", - "location": "me-west1", - "description": "Regional Endpoint" + "location": "me-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west6.rep.googleapis.com/", + "location": "europe-west6" } ], "fullyEncodeReservedExpansion": true, @@ -705,7 +710,7 @@ } } }, - "revision": "20240527", + "revision": "20240726", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/secretmanager-v1beta2.json b/discovery/secretmanager-v1beta2.json index 77e7d3847f..b51c46cac6 100644 --- a/discovery/secretmanager-v1beta2.json +++ b/discovery/secretmanager-v1beta2.json @@ -17,79 +17,84 @@ "documentationLink": "https://cloud.google.com/secret-manager/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.me-west1.rep.googleapis.com/", - "location": "me-west1", - "description": "Regional Endpoint" + "location": "me-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central1.rep.googleapis.com/", - "location": "us-central1", - "description": "Regional Endpoint" + "location": "us-central1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east1.rep.googleapis.com/", - "location": "us-east1", - "description": "Regional Endpoint" + "location": "us-east1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-central2.rep.googleapis.com/", - "location": "us-central2", - "description": "Regional Endpoint" + "location": "us-central2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west1.rep.googleapis.com/", - "location": "us-west1", - "description": "Regional Endpoint" + "location": "us-west1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west2.rep.googleapis.com/", - "location": "us-west2", - "description": "Regional Endpoint" + "location": "us-west2" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west3.rep.googleapis.com/", - "location": "us-west3", - "description": "Regional Endpoint" + "location": "us-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-west4.rep.googleapis.com/", - "location": "us-west4", - "description": "Regional Endpoint" + "location": "us-west4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east4.rep.googleapis.com/", - "location": "us-east4", - "description": "Regional Endpoint" + "location": "us-east4" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-east5.rep.googleapis.com/", - "location": "us-east5", - "description": "Regional Endpoint" + "location": "us-east5" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.us-south1.rep.googleapis.com/", - "location": "us-south1", - "description": "Regional Endpoint" + "location": "us-south1" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west8.rep.googleapis.com/", - "location": "europe-west8", - "description": "Regional Endpoint" + "location": "europe-west8" }, { + "description": "Regional Endpoint", "endpointUrl": "https://secretmanager.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://secretmanager.europe-west6.rep.googleapis.com/", + "location": "europe-west6" } ], "fullyEncodeReservedExpansion": true, @@ -1185,7 +1190,7 @@ } } }, - "revision": "20240527", + "revision": "20240726", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index 52642277af..2e6904c851 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -15,6 +15,13 @@ "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/security-command-center", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", + "location": "me-central2" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -120,7 +127,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the parent to group the assets by. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -182,7 +189,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -262,7 +269,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource of the new BigQuery export. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -290,7 +297,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -315,7 +322,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^folders/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -351,7 +358,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -414,7 +421,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -446,7 +453,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -474,7 +481,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -499,7 +506,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -535,7 +542,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -571,7 +578,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -596,7 +603,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -634,7 +641,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -670,7 +677,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -701,7 +708,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -740,7 +747,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+$", "required": true, @@ -768,7 +775,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -793,7 +800,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -829,7 +836,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs$", "required": true, @@ -854,7 +861,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^folders/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -899,7 +906,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -927,7 +934,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -952,7 +959,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -988,7 +995,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1013,7 +1020,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^folders/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -1056,7 +1063,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1084,7 +1091,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -1109,7 +1116,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^folders/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -1210,7 +1217,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new custom module's parent. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1238,7 +1245,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -1263,7 +1270,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -1299,7 +1306,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1335,7 +1342,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list descendant custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1426,7 +1433,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the effective custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", + "description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -1462,7 +1469,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list effective custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1504,7 +1511,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1533,7 +1540,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+$", "required": true, @@ -1594,7 +1601,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+$", "required": true, @@ -1659,7 +1666,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1687,7 +1694,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^folders/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -1803,7 +1810,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the organization to get organization settings for. Its format is \"organizations/[organization_id]/organizationSettings\".", + "description": "Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`.", "location": "path", "pattern": "^organizations/[^/]+/organizationSettings$", "required": true, @@ -1867,7 +1874,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the parent to group the assets by. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1929,7 +1936,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -1961,7 +1968,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the organization to run asset discovery for. Its format is \"organizations/[organization_id]\".", + "description": "Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2038,7 +2045,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource of the new BigQuery export. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2066,7 +2073,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2091,7 +2098,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^organizations/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -2127,7 +2134,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2190,7 +2197,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2222,7 +2229,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2250,7 +2257,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2275,7 +2282,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2311,7 +2318,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2347,7 +2354,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2372,7 +2379,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2410,7 +2417,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -2446,7 +2453,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2477,7 +2484,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2516,7 +2523,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -2544,7 +2551,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2569,7 +2576,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2605,7 +2612,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs$", "required": true, @@ -2630,7 +2637,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2675,7 +2682,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2703,7 +2710,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2728,7 +2735,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2764,7 +2771,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2789,7 +2796,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^organizations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -2832,7 +2839,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -2860,7 +2867,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -2885,7 +2892,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^organizations/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -3157,7 +3164,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the resource value config to retrieve. Its format is organizations/{organization}/resourceValueConfigs/{config_id}.", + "description": "Required. Name of the resource value config to retrieve. Its format is `organizations/{organization}/resourceValueConfigs/{config_id}`.", "location": "path", "pattern": "^organizations/[^/]+/resourceValueConfigs/[^/]+$", "required": true, @@ -3193,7 +3200,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of resource value configs. Its format is \"organizations/[organization_id]\"", + "description": "Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]`", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3258,7 +3265,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new custom module's parent. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3286,7 +3293,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -3311,7 +3318,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -3347,7 +3354,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3383,7 +3390,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list descendant custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3474,7 +3481,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the effective custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", + "description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -3510,7 +3517,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list effective custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -3541,7 +3548,7 @@ ], "parameters": { "name": { - "description": "Required. The organization name or simulation name of this simulation Valid format: \"organizations/{organization}/simulations/latest\" \"organizations/{organization}/simulations/{simulation}\"", + "description": "Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization}/simulations/latest` `organizations/{organization}/simulations/{simulation}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3588,7 +3595,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list attack paths. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\" \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/attackExposureResults/[^/]+$", "required": true, @@ -3622,7 +3629,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a \" ASC\" or a \" DESC\" suffix, respectively; for example: `exposed_score DESC`.", + "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, @@ -3638,7 +3645,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list valued resources. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\"", + "description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/attackExposureResults/[^/]+$", "required": true, @@ -3685,7 +3692,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list attack paths. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\" \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3714,7 +3721,7 @@ ], "parameters": { "name": { - "description": "Required. The name of this valued resource Valid format: \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. The name of this valued resource Valid format: `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/valuedResources/[^/]+$", "required": true, @@ -3744,7 +3751,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a \" ASC\" or a \" DESC\" suffix, respectively; for example: `exposed_score DESC`.", + "description": "Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`.", "location": "query", "type": "string" }, @@ -3760,7 +3767,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list valued resources. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\"", + "description": "Required. Name of parent to list valued resources. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+$", "required": true, @@ -3805,7 +3812,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list attack paths. Valid formats: \"organizations/{organization}\", \"organizations/{organization}/simulations/{simulation}\" \"organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}\" \"organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}\"", + "description": "Required. Name of parent to list attack paths. Valid formats: `organizations/{organization}`, `organizations/{organization}/simulations/{simulation}` `organizations/{organization}/simulations/{simulation}/attackExposureResults/{attack_exposure_result_v2}` `organizations/{organization}/simulations/{simulation}/valuedResources/{valued_resource}`", "location": "path", "pattern": "^organizations/[^/]+/simulations/[^/]+/valuedResources/[^/]+$", "required": true, @@ -3838,7 +3845,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new source's parent. Its format should be \"organizations/[organization_id]\".", + "description": "Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -3866,7 +3873,7 @@ ], "parameters": { "name": { - "description": "Required. Relative resource name of the source. Its format is \"organizations/[organization_id]/source/[source_id]\".", + "description": "Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -3930,7 +3937,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -4054,7 +4061,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new finding's parent. Its format should be \"organizations/[organization_id]/sources/[source_id]\".", + "description": "Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4082,7 +4089,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4143,7 +4150,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+$", "required": true, @@ -4208,7 +4215,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -4236,7 +4243,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^organizations/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -4355,7 +4362,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the parent to group the assets by. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4417,7 +4424,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4497,7 +4504,7 @@ "type": "string" }, "parent": { - "description": "Required. The name of the parent resource of the new BigQuery export. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4525,7 +4532,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the BigQuery export to delete. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. The name of the BigQuery export to delete. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -4550,7 +4557,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization}/bigQueryExports/{export_id}, folders/{folder}/bigQueryExports/{export_id}, or projects/{project}/bigQueryExports/{export_id}", + "description": "Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization}/bigQueryExports/{export_id}`, `folders/{folder}/bigQueryExports/{export_id}`, or `projects/{project}/bigQueryExports/{export_id}`", "location": "path", "pattern": "^projects/[^/]+/bigQueryExports/[^/]+$", "required": true, @@ -4586,7 +4593,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4649,7 +4656,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4681,7 +4688,7 @@ ], "parameters": { "parent": { - "description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4709,7 +4716,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4734,7 +4741,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4770,7 +4777,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4806,7 +4813,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4831,7 +4838,7 @@ ], "parameters": { "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4869,7 +4876,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -4905,7 +4912,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", + "description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4936,7 +4943,7 @@ ], "parameters": { "parent": { - "description": "Required. The parent, at which bulk action needs to be applied. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -4975,7 +4982,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -5003,7 +5010,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5028,7 +5035,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5064,7 +5071,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs$", "required": true, @@ -5089,7 +5096,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5134,7 +5141,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new mute configs's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5162,7 +5169,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to delete. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to delete. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5187,7 +5194,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the mute config to retrieve. Its format is organizations/{organization}/muteConfigs/{config_id}, folders/{folder}/muteConfigs/{config_id}, projects/{project}/muteConfigs/{config_id}, organizations/{organization}/locations/global/muteConfigs/{config_id}, folders/{folder}/locations/global/muteConfigs/{config_id}, or projects/{project}/locations/global/muteConfigs/{config_id}.", + "description": "Required. Name of the mute config to retrieve. Its format is `organizations/{organization}/muteConfigs/{config_id}`, `folders/{folder}/muteConfigs/{config_id}`, `projects/{project}/muteConfigs/{config_id}`, `organizations/{organization}/locations/global/muteConfigs/{config_id}`, `folders/{folder}/locations/global/muteConfigs/{config_id}`, or `projects/{project}/locations/global/muteConfigs/{config_id}`.", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5223,7 +5230,7 @@ "type": "string" }, "parent": { - "description": "Required. The parent, which owns the collection of mute configs. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", \"projects/[project_id]\".", + "description": "Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5248,7 +5255,7 @@ ], "parameters": { "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", "location": "path", "pattern": "^projects/[^/]+/muteConfigs/[^/]+$", "required": true, @@ -5291,7 +5298,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the new notification config's parent. Its format is \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5319,7 +5326,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to delete. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -5344,7 +5351,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the notification config to get. Its format is \"organizations/[organization_id]/notificationConfigs/[config_id]\", \"folders/[folder_id]/notificationConfigs/[config_id]\", or \"projects/[project_id]/notificationConfigs/[config_id]\".", + "description": "Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`.", "location": "path", "pattern": "^projects/[^/]+/notificationConfigs/[^/]+$", "required": true, @@ -5445,7 +5452,7 @@ ], "parameters": { "parent": { - "description": "Required. Resource name of the new custom module's parent. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Resource name of the new custom module's parent. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5473,7 +5480,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to delete. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to delete. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -5498,7 +5505,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}\"", + "description": "Required. Name of the custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/customModules/[^/]+$", "required": true, @@ -5534,7 +5541,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5570,7 +5577,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list descendant custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5661,7 +5668,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the effective custom module to get. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", \"folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\", or \"projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}\"", + "description": "Required. Name of the effective custom module to get. Its format is `organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, `folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`, or `projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -5697,7 +5704,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of parent to list effective custom modules. Its format is \"organizations/{organization}/securityHealthAnalyticsSettings\", \"folders/{folder}/securityHealthAnalyticsSettings\", or \"projects/{project}/securityHealthAnalyticsSettings\"", + "description": "Required. Name of parent to list effective custom modules. Its format is `organizations/{organization}/securityHealthAnalyticsSettings`, `folders/{folder}/securityHealthAnalyticsSettings`, or `projects/{project}/securityHealthAnalyticsSettings`", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -5739,7 +5746,7 @@ "type": "string" }, "parent": { - "description": "Required. Resource name of the parent of sources to list. Its format should be \"organizations/[organization_id]\", \"folders/[folder_id]\", or \"projects/[project_id]\".", + "description": "Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -5768,7 +5775,7 @@ ], "parameters": { "parent": { - "description": "Required. Name of the source to groupBy. Its format is \"organizations/[organization_id]/sources/[source_id]\", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-, or projects/{project_id}/sources/-", + "description": "Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-, folders/{folder_id}/sources/-`, or `projects/{project_id}/sources/-`", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+$", "required": true, @@ -5829,7 +5836,7 @@ "type": "string" }, "parent": { - "description": "Required. Name of the source the findings belong to. Its format is \"organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]\". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/-, folders/{folder_id}/sources/- or projects/{projects_id}/sources/-", + "description": "Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id}/sources/-`, `folders/{folder_id}/sources/-` or `projects/{projects_id}/sources/-`", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+$", "required": true, @@ -5894,7 +5901,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -5922,7 +5929,7 @@ ], "parameters": { "name": { - "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: \"organizations/{organization_id}/sources/{source_id}/findings/{finding_id}\", \"folders/{folder_id}/sources/{source_id}/findings/{finding_id}\", \"projects/{project_id}/sources/{source_id}/findings/{finding_id}\".", + "description": "Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id}/sources/{source_id}/findings/{finding_id}`, `folders/{folder_id}/sources/{source_id}/findings/{finding_id}`, `projects/{project_id}/sources/{source_id}/findings/{finding_id}`.", "location": "path", "pattern": "^projects/[^/]+/sources/[^/]+/findings/[^/]+$", "required": true, @@ -6027,7 +6034,7 @@ } } }, - "revision": "20240622", + "revision": "20240809", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -6251,7 +6258,7 @@ "id": "AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -6359,11 +6366,11 @@ "type": "string" }, "resource": { - "description": "The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](\"https://cloud.google.com/asset-inventory/docs/resource-name-format\")", + "description": "The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format)", "type": "string" }, "resourceType": { - "description": "The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types\")", + "description": "The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types)", "type": "string" }, "uuid": { @@ -6537,7 +6544,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -6585,7 +6592,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -6710,6 +6717,20 @@ "deprecated": true, "description": "This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter.", "type": "string" + }, + "muteState": { + "description": "Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings.", + "enum": [ + "MUTE_STATE_UNSPECIFIED", + "MUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unused.", + "Matching findings will be muted (default).", + "Matching findings will have their mute state cleared." + ], + "type": "string" } }, "type": "object" @@ -7054,6 +7075,11 @@ "$ref": "Cvssv3", "description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" }, + "exploitReleaseDate": { + "description": "Date the first publicly available exploit or PoC was released.", + "format": "google-datetime", + "type": "string" + }, "exploitationActivity": { "description": "The exploitation activity of the vulnerability in the wild.", "enum": [ @@ -7319,6 +7345,22 @@ }, "type": "object" }, + "DynamicMuteRecord": { + "description": "The record of a dynamic mute rule that matches the finding.", + "id": "DynamicMuteRecord", + "properties": { + "matchTime": { + "description": "When the dynamic mute rule first matched the finding.", + "format": "google-datetime", + "type": "string" + }, + "muteConfig": { + "description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", + "type": "string" + } + }, + "type": "object" + }, "EffectiveEventThreatDetectionCustomModule": { "description": "An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only.", "id": "EffectiveEventThreatDetectionCustomModule", @@ -7358,7 +7400,7 @@ "type": "string" }, "name": { - "description": "Output only. The resource name of the effective ETD custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", + "description": "Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "readOnly": true, "type": "string" }, @@ -7438,7 +7480,7 @@ "type": "string" }, "name": { - "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", + "description": "Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "type": "string" }, "type": { @@ -7756,6 +7798,11 @@ ], "type": "string" }, + "muteInfo": { + "$ref": "MuteInfo", + "description": "Output only. The mute information regarding this finding.", + "readOnly": true + }, "muteInitiator": { "description": "Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" @@ -8198,6 +8245,11 @@ "description": "The human readable name to be displayed for the mute config.", "type": "string" }, + "expiryTime": { + "description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", + "format": "google-datetime", + "type": "string" + }, "filter": { "description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" @@ -8208,7 +8260,21 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", + "type": "string" + }, + "type": { + "description": "Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.", + "enum": [ + "MUTE_CONFIG_TYPE_UNSPECIFIED", + "STATIC", + "DYNAMIC" + ], + "enumDescriptions": [ + "Unused.", + "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", + "A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." + ], "type": "string" }, "updateTime": { @@ -8327,7 +8393,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -8393,11 +8459,11 @@ "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { @@ -8419,7 +8485,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -8427,7 +8493,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -8938,7 +9004,7 @@ "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -9056,7 +9122,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -9104,7 +9170,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -9178,7 +9244,7 @@ "type": "string" }, "dataset": { - "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -9195,7 +9261,7 @@ "type": "string" }, "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", + "description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -9480,6 +9546,11 @@ "$ref": "GoogleCloudSecuritycenterV2Cvssv3", "description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" }, + "exploitReleaseDate": { + "description": "Date the first publicly available exploit or PoC was released.", + "format": "google-datetime", + "type": "string" + }, "exploitationActivity": { "description": "The exploitation activity of the vulnerability in the wild.", "enum": [ @@ -9745,6 +9816,22 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2DynamicMuteRecord": { + "description": "The record of a dynamic mute rule that matches the finding.", + "id": "GoogleCloudSecuritycenterV2DynamicMuteRecord", + "properties": { + "matchTime": { + "description": "When the dynamic mute rule first matched the finding.", + "format": "google-datetime", + "type": "string" + }, + "muteConfig": { + "description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2EnvironmentVariable": { "description": "A name-value pair representing an environment variable used in an operating system process.", "id": "GoogleCloudSecuritycenterV2EnvironmentVariable", @@ -10099,6 +10186,11 @@ ], "type": "string" }, + "muteInfo": { + "$ref": "GoogleCloudSecuritycenterV2MuteInfo", + "description": "Output only. The mute information regarding this finding.", + "readOnly": true + }, "muteInitiator": { "description": "Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" @@ -10534,8 +10626,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -10599,8 +10693,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -10648,7 +10744,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -10709,8 +10805,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -10774,8 +10872,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -10823,7 +10923,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -10853,6 +10953,11 @@ "description": "A description of the mute config.", "type": "string" }, + "expiryTime": { + "description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", + "format": "google-datetime", + "type": "string" + }, "filter": { "description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" @@ -10863,18 +10968,20 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", + "description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { "description": "Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", - "STATIC" + "STATIC", + "DYNAMIC" ], "enumDescriptions": [ "Unused.", - "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state." + "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", + "A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." ], "type": "string" }, @@ -10887,6 +10994,24 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2MuteInfo": { + "description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", + "id": "GoogleCloudSecuritycenterV2MuteInfo", + "properties": { + "dynamicMuteRecords": { + "description": "The list of dynamic mute rules that currently match the finding.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2DynamicMuteRecord" + }, + "type": "array" + }, + "staticMute": { + "$ref": "GoogleCloudSecuritycenterV2StaticMute", + "description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -11249,7 +11374,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -11351,22 +11476,22 @@ "type": "string" }, "name": { - "description": "Name for the resource value configuration", + "description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { - "description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", + "description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -11384,7 +11509,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -11392,7 +11517,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -11597,6 +11722,34 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2StaticMute": { + "description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", + "id": "GoogleCloudSecuritycenterV2StaticMute", + "properties": { + "applyTime": { + "description": "When the static mute was applied.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", + "enum": [ + "MUTE_UNSPECIFIED", + "MUTED", + "UNMUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unspecified.", + "Finding has been muted.", + "Finding has been unmuted.", + "Finding has never been muted/unmuted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Subject": { "description": "Represents a Kubernetes subject.", "id": "GoogleCloudSecuritycenterV2Subject", @@ -11670,7 +11823,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -12541,8 +12694,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -12606,8 +12761,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -12716,8 +12873,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -12781,8 +12940,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -12846,6 +13007,24 @@ }, "type": "object" }, + "MuteInfo": { + "description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", + "id": "MuteInfo", + "properties": { + "dynamicMuteRecords": { + "description": "The list of dynamic mute rules that currently match the finding.", + "items": { + "$ref": "DynamicMuteRecord" + }, + "type": "array" + }, + "staticMute": { + "$ref": "StaticMute", + "description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." + } + }, + "type": "object" + }, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -13050,7 +13229,7 @@ "id": "PathNodeAssociatedFinding", "properties": { "canonicalFinding": { - "description": "Canonical name of the associated findings. Example: organizations/123/sources/456/findings/789", + "description": "Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789`", "type": "string" }, "findingCategory": { @@ -13359,7 +13538,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -13803,7 +13982,7 @@ "type": "string" }, "name": { - "description": "Full resource name of the Simulation: organizations/123/simulations/456", + "description": "Full resource name of the Simulation: `organizations/123/simulations/456`", "type": "string" }, "resourceValueConfigsMetadata": { @@ -13839,6 +14018,34 @@ }, "type": "object" }, + "StaticMute": { + "description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", + "id": "StaticMute", + "properties": { + "applyTime": { + "description": "When the static mute was applied.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", + "enum": [ + "MUTE_UNSPECIFIED", + "MUTED", + "UNMUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unspecified.", + "Finding has been muted.", + "Finding has been unmuted.", + "Finding has never been muted/unmuted." + ], + "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", @@ -13978,7 +14185,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index ac2ab6fd8f..dcb9d4e857 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -15,6 +15,13 @@ "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/security-command-center", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", + "location": "me-central2" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -896,7 +903,7 @@ } } }, - "revision": "20240622", + "revision": "20240809", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1105,7 +1112,7 @@ "id": "AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -1270,7 +1277,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -1318,7 +1325,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -1698,6 +1705,11 @@ "$ref": "Cvssv3", "description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" }, + "exploitReleaseDate": { + "description": "Date the first publicly available exploit or PoC was released.", + "format": "google-datetime", + "type": "string" + }, "exploitationActivity": { "description": "The exploitation activity of the vulnerability in the wild.", "enum": [ @@ -1963,6 +1975,22 @@ }, "type": "object" }, + "DynamicMuteRecord": { + "description": "The record of a dynamic mute rule that matches the finding.", + "id": "DynamicMuteRecord", + "properties": { + "matchTime": { + "description": "When the dynamic mute rule first matched the finding.", + "format": "google-datetime", + "type": "string" + }, + "muteConfig": { + "description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", + "type": "string" + } + }, + "type": "object" + }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -2286,6 +2314,11 @@ ], "type": "string" }, + "muteInfo": { + "$ref": "MuteInfo", + "description": "Output only. The mute information regarding this finding.", + "readOnly": true + }, "muteInitiator": { "description": "Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" @@ -2728,6 +2761,11 @@ "description": "The human readable name to be displayed for the mute config.", "type": "string" }, + "expiryTime": { + "description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", + "format": "google-datetime", + "type": "string" + }, "filter": { "description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" @@ -2738,7 +2776,21 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", + "type": "string" + }, + "type": { + "description": "Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.", + "enum": [ + "MUTE_CONFIG_TYPE_UNSPECIFIED", + "STATIC", + "DYNAMIC" + ], + "enumDescriptions": [ + "Unused.", + "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", + "A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." + ], "type": "string" }, "updateTime": { @@ -2857,7 +2909,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -2923,11 +2975,11 @@ "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { @@ -2949,7 +3001,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -2957,7 +3009,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -3549,7 +3601,7 @@ "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -3667,7 +3719,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -3715,7 +3767,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -3789,7 +3841,7 @@ "type": "string" }, "dataset": { - "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -3806,7 +3858,7 @@ "type": "string" }, "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", + "description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -4091,6 +4143,11 @@ "$ref": "GoogleCloudSecuritycenterV2Cvssv3", "description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" }, + "exploitReleaseDate": { + "description": "Date the first publicly available exploit or PoC was released.", + "format": "google-datetime", + "type": "string" + }, "exploitationActivity": { "description": "The exploitation activity of the vulnerability in the wild.", "enum": [ @@ -4356,6 +4413,22 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2DynamicMuteRecord": { + "description": "The record of a dynamic mute rule that matches the finding.", + "id": "GoogleCloudSecuritycenterV2DynamicMuteRecord", + "properties": { + "matchTime": { + "description": "When the dynamic mute rule first matched the finding.", + "format": "google-datetime", + "type": "string" + }, + "muteConfig": { + "description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2EnvironmentVariable": { "description": "A name-value pair representing an environment variable used in an operating system process.", "id": "GoogleCloudSecuritycenterV2EnvironmentVariable", @@ -4710,6 +4783,11 @@ ], "type": "string" }, + "muteInfo": { + "$ref": "GoogleCloudSecuritycenterV2MuteInfo", + "description": "Output only. The mute information regarding this finding.", + "readOnly": true + }, "muteInitiator": { "description": "Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" @@ -5145,8 +5223,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -5210,8 +5290,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -5259,7 +5341,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -5320,8 +5402,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -5385,8 +5469,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -5434,7 +5520,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -5464,6 +5550,11 @@ "description": "A description of the mute config.", "type": "string" }, + "expiryTime": { + "description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", + "format": "google-datetime", + "type": "string" + }, "filter": { "description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" @@ -5474,18 +5565,20 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", + "description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { "description": "Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", - "STATIC" + "STATIC", + "DYNAMIC" ], "enumDescriptions": [ "Unused.", - "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state." + "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", + "A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." ], "type": "string" }, @@ -5498,6 +5591,24 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2MuteInfo": { + "description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", + "id": "GoogleCloudSecuritycenterV2MuteInfo", + "properties": { + "dynamicMuteRecords": { + "description": "The list of dynamic mute rules that currently match the finding.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2DynamicMuteRecord" + }, + "type": "array" + }, + "staticMute": { + "$ref": "GoogleCloudSecuritycenterV2StaticMute", + "description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -5860,7 +5971,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -5962,22 +6073,22 @@ "type": "string" }, "name": { - "description": "Name for the resource value configuration", + "description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { - "description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", + "description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -5995,7 +6106,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6003,7 +6114,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -6208,6 +6319,34 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2StaticMute": { + "description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", + "id": "GoogleCloudSecuritycenterV2StaticMute", + "properties": { + "applyTime": { + "description": "When the static mute was applied.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", + "enum": [ + "MUTE_UNSPECIFIED", + "MUTED", + "UNMUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unspecified.", + "Finding has been muted.", + "Finding has been unmuted.", + "Finding has never been muted/unmuted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Subject": { "description": "Represents a Kubernetes subject.", "id": "GoogleCloudSecuritycenterV2Subject", @@ -6281,7 +6420,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -6873,8 +7012,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -6938,8 +7079,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7048,8 +7191,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -7113,8 +7258,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7178,6 +7325,24 @@ }, "type": "object" }, + "MuteInfo": { + "description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", + "id": "MuteInfo", + "properties": { + "dynamicMuteRecords": { + "description": "The list of dynamic mute rules that currently match the finding.", + "items": { + "$ref": "DynamicMuteRecord" + }, + "type": "array" + }, + "staticMute": { + "$ref": "StaticMute", + "description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." + } + }, + "type": "object" + }, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -7858,6 +8023,34 @@ }, "type": "object" }, + "StaticMute": { + "description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", + "id": "StaticMute", + "properties": { + "applyTime": { + "description": "When the static mute was applied.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", + "enum": [ + "MUTE_UNSPECIFIED", + "MUTED", + "UNMUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unspecified.", + "Finding has been muted.", + "Finding has been unmuted.", + "Finding has never been muted/unmuted." + ], + "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", @@ -7986,7 +8179,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index 431ba799d4..8bc0816d52 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -15,6 +15,13 @@ "description": "Security Command Center API provides access to temporal views of assets and findings within an organization.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/security-command-center", + "endpoints": [ + { + "description": "Regional Endpoint", + "endpointUrl": "https://securitycenter.me-central2.rep.googleapis.com/", + "location": "me-central2" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -292,7 +299,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -326,7 +333,7 @@ ], "parameters": { "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -394,7 +401,7 @@ ], "parameters": { "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -428,7 +435,7 @@ ], "parameters": { "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -462,7 +469,7 @@ ], "parameters": { "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, @@ -876,7 +883,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -910,7 +917,7 @@ ], "parameters": { "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -978,7 +985,7 @@ ], "parameters": { "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1012,7 +1019,7 @@ ], "parameters": { "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1046,7 +1053,7 @@ ], "parameters": { "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1435,7 +1442,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1469,7 +1476,7 @@ ], "parameters": { "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1537,7 +1544,7 @@ ], "parameters": { "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1571,7 +1578,7 @@ ], "parameters": { "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1605,7 +1612,7 @@ ], "parameters": { "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1728,7 +1735,7 @@ ], "parameters": { "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1906,7 +1913,7 @@ } } }, - "revision": "20240622", + "revision": "20240809", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2051,7 +2058,7 @@ "id": "AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -2168,7 +2175,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -2216,7 +2223,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -2599,11 +2606,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", + "description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -2644,6 +2651,11 @@ "$ref": "Cvssv3", "description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" }, + "exploitReleaseDate": { + "description": "Date the first publicly available exploit or PoC was released.", + "format": "google-datetime", + "type": "string" + }, "exploitationActivity": { "description": "The exploitation activity of the vulnerability in the wild.", "enum": [ @@ -2946,6 +2958,22 @@ }, "type": "object" }, + "DynamicMuteRecord": { + "description": "The record of a dynamic mute rule that matches the finding.", + "id": "DynamicMuteRecord", + "properties": { + "matchTime": { + "description": "When the dynamic mute rule first matched the finding.", + "format": "google-datetime", + "type": "string" + }, + "muteConfig": { + "description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", + "type": "string" + } + }, + "type": "object" + }, "EnvironmentVariable": { "description": "A name-value pair representing an environment variable used in an operating system process.", "id": "EnvironmentVariable", @@ -2969,11 +2997,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", + "description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "type": "string" }, "serviceEnablementState": { @@ -3303,6 +3331,11 @@ ], "type": "string" }, + "muteInfo": { + "$ref": "MuteInfo", + "description": "Output only. The mute information regarding this finding.", + "readOnly": true + }, "muteInitiator": { "description": "Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" @@ -3722,6 +3755,11 @@ "description": "The human readable name to be displayed for the mute config.", "type": "string" }, + "expiryTime": { + "description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", + "format": "google-datetime", + "type": "string" + }, "filter": { "description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" @@ -3732,7 +3770,21 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. Format \"organizations/{organization}/muteConfigs/{mute_config}\" \"folders/{folder}/muteConfigs/{mute_config}\" \"projects/{project}/muteConfigs/{mute_config}\" \"organizations/{organization}/locations/global/muteConfigs/{mute_config}\" \"folders/{folder}/locations/global/muteConfigs/{mute_config}\" \"projects/{project}/locations/global/muteConfigs/{mute_config}\"", + "description": "This field will be ignored if provided on config creation. Format `organizations/{organization}/muteConfigs/{mute_config}` `folders/{folder}/muteConfigs/{mute_config}` `projects/{project}/muteConfigs/{mute_config}` `organizations/{organization}/locations/global/muteConfigs/{mute_config}` `folders/{folder}/locations/global/muteConfigs/{mute_config}` `projects/{project}/locations/global/muteConfigs/{mute_config}`", + "type": "string" + }, + "type": { + "description": "Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation.", + "enum": [ + "MUTE_CONFIG_TYPE_UNSPECIFIED", + "STATIC", + "DYNAMIC" + ], + "enumDescriptions": [ + "Unused.", + "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", + "A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." + ], "type": "string" }, "updateTime": { @@ -3851,7 +3903,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -3917,11 +3969,11 @@ "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, `\"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"}` will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { @@ -3943,7 +3995,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -3951,7 +4003,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -4462,7 +4514,7 @@ "id": "GoogleCloudSecuritycenterV2AttackExposure", "properties": { "attackExposureResult": { - "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789", + "description": "The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789`", "type": "string" }, "exposedHighValueResourcesCount": { @@ -4580,7 +4632,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure management group, for example, \"20000000-0001-0000-0000-000000000000\".", + "description": "The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`.", "type": "string" } }, @@ -4628,7 +4680,7 @@ "type": "string" }, "id": { - "description": "The UUID of the Azure subscription, for example, \"291bba3f-e0a5-47bc-a099-3bdcb2a50a05\".", + "description": "The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`.", "type": "string" } }, @@ -4702,7 +4754,7 @@ "type": "string" }, "dataset": { - "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -4719,7 +4771,7 @@ "type": "string" }, "name": { - "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", + "description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -5004,6 +5056,11 @@ "$ref": "GoogleCloudSecuritycenterV2Cvssv3", "description": "Describe Common Vulnerability Scoring System specified at https://www.first.org/cvss/v3.1/specification-document" }, + "exploitReleaseDate": { + "description": "Date the first publicly available exploit or PoC was released.", + "format": "google-datetime", + "type": "string" + }, "exploitationActivity": { "description": "The exploitation activity of the vulnerability in the wild.", "enum": [ @@ -5269,6 +5326,22 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2DynamicMuteRecord": { + "description": "The record of a dynamic mute rule that matches the finding.", + "id": "GoogleCloudSecuritycenterV2DynamicMuteRecord", + "properties": { + "matchTime": { + "description": "When the dynamic mute rule first matched the finding.", + "format": "google-datetime", + "type": "string" + }, + "muteConfig": { + "description": "The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2EnvironmentVariable": { "description": "A name-value pair representing an environment variable used in an operating system process.", "id": "GoogleCloudSecuritycenterV2EnvironmentVariable", @@ -5623,6 +5696,11 @@ ], "type": "string" }, + "muteInfo": { + "$ref": "GoogleCloudSecuritycenterV2MuteInfo", + "description": "Output only. The mute information regarding this finding.", + "readOnly": true + }, "muteInitiator": { "description": "Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding.", "type": "string" @@ -6058,8 +6136,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -6123,8 +6203,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -6172,7 +6254,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -6233,8 +6315,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -6298,8 +6382,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -6347,7 +6433,7 @@ "T1588", "T1595", "T1595.001", - "T1613", + "T1609", "T1611", "T1613", "T1649" @@ -6377,6 +6463,11 @@ "description": "A description of the mute config.", "type": "string" }, + "expiryTime": { + "description": "Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings.", + "format": "google-datetime", + "type": "string" + }, "filter": { "description": "Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:`", "type": "string" @@ -6387,18 +6478,20 @@ "type": "string" }, "name": { - "description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", + "description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { "description": "Required. The type of the mute config, which determines what type of mute state the config affects. Immutable after creation.", "enum": [ "MUTE_CONFIG_TYPE_UNSPECIFIED", - "STATIC" + "STATIC", + "DYNAMIC" ], "enumDescriptions": [ "Unused.", - "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state." + "A static mute config, which sets the static mute state of future matching findings to muted. Once the static mute state has been set, finding or config modifications will not affect the state.", + "A dynamic mute config, which is applied to existing and future matching findings, setting their dynamic mute state to \"muted\". If the config is updated or deleted, or a matching finding is updated, such that the finding doesn't match the config, the config will be removed from the finding, and the finding's dynamic mute state may become \"unmuted\" (unless other configs still match)." ], "type": "string" }, @@ -6411,6 +6504,24 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2MuteInfo": { + "description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", + "id": "GoogleCloudSecuritycenterV2MuteInfo", + "properties": { + "dynamicMuteRecords": { + "description": "The list of dynamic mute rules that currently match the finding.", + "items": { + "$ref": "GoogleCloudSecuritycenterV2DynamicMuteRecord" + }, + "type": "array" + }, + "staticMute": { + "$ref": "GoogleCloudSecuritycenterV2StaticMute", + "description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Node": { "description": "Kubernetes nodes associated with the finding.", "id": "GoogleCloudSecuritycenterV2Node", @@ -6773,7 +6884,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { - "description": "A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", + "description": "A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id}/folders/{folder_id}/folders/{folder_id}/projects/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { @@ -6875,22 +6986,22 @@ "type": "string" }, "name": { - "description": "Name for the resource value configuration", + "description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { "additionalProperties": { "type": "string" }, - "description": "List of resource labels to search for, evaluated with AND. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" AND \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", + "description": "List of resource labels to search for, evaluated with `AND`. For example, \"resource_labels_selector\": {\"key\": \"value\", \"env\": \"prod\"} will match resources with labels \"key\": \"value\" `AND` \"env\": \"prod\" https://cloud.google.com/resource-manager/docs/creating-managing-labels", "type": "object" }, "resourceType": { - "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", + "description": "Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, \"storage.googleapis.com/Bucket\" with resource_value \"HIGH\" will apply \"HIGH\" value only to \"storage.googleapis.com/Bucket\" resources.", "type": "string" }, "resourceValue": { - "description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", + "description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -6908,7 +7019,7 @@ "type": "string" }, "scope": { - "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with AND of other resources.", + "description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6916,7 +7027,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { - "description": "Required. Tag values combined with AND to check against. Values in the form \"tagValues/123\" Example: [ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", + "description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -7121,6 +7232,34 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV2StaticMute": { + "description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", + "id": "GoogleCloudSecuritycenterV2StaticMute", + "properties": { + "applyTime": { + "description": "When the static mute was applied.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", + "enum": [ + "MUTE_UNSPECIFIED", + "MUTED", + "UNMUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unspecified.", + "Finding has been muted.", + "Finding has been unmuted.", + "Finding has never been muted/unmuted." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV2Subject": { "description": "Represents a Kubernetes subject.", "id": "GoogleCloudSecuritycenterV2Subject", @@ -7194,7 +7333,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -7537,8 +7676,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -7602,8 +7743,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7712,8 +7855,10 @@ "COMMAND_AND_SCRIPTING_INTERPRETER", "UNIX_SHELL", "PYTHON", + "EXPLOITATION_FOR_PRIVILEGE_ESCALATION", "PERMISSION_GROUPS_DISCOVERY", "CLOUD_GROUPS", + "INDICATOR_REMOVAL_FILE_DELETION", "APPLICATION_LAYER_PROTOCOL", "DNS", "SOFTWARE_DEPLOYMENT_TOOLS", @@ -7777,8 +7922,10 @@ "T1059", "T1059.004", "T1059.006", + "T1068", "T1069", "T1069.003", + "T1070.004", "T1071", "T1071.004", "T1072", @@ -7842,6 +7989,24 @@ }, "type": "object" }, + "MuteInfo": { + "description": "Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules.", + "id": "MuteInfo", + "properties": { + "dynamicMuteRecords": { + "description": "The list of dynamic mute rules that currently match the finding.", + "items": { + "$ref": "DynamicMuteRecord" + }, + "type": "array" + }, + "staticMute": { + "$ref": "StaticMute", + "description": "If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute." + } + }, + "type": "object" + }, "Node": { "description": "Kubernetes nodes associated with the finding.", "id": "Node", @@ -8316,11 +8481,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", + "description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "type": "string" }, "serviceAccount": { @@ -8451,6 +8616,34 @@ }, "type": "object" }, + "StaticMute": { + "description": "Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly.", + "id": "StaticMute", + "properties": { + "applyTime": { + "description": "When the static mute was applied.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value.", + "enum": [ + "MUTE_UNSPECIFIED", + "MUTED", + "UNMUTED", + "UNDEFINED" + ], + "enumDescriptions": [ + "Unspecified.", + "Finding has been muted.", + "Finding has been unmuted.", + "Finding has never been muted/unmuted." + ], + "type": "string" + } + }, + "type": "object" + }, "Subject": { "description": "Represents a Kubernetes subject.", "id": "Subject", @@ -8557,7 +8750,7 @@ "type": "number" }, "relatedFindings": { - "description": "List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789.", + "description": "List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`.", "items": { "type": "string" }, @@ -8574,11 +8767,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", + "description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -8693,11 +8886,11 @@ "additionalProperties": { "$ref": "Config" }, - "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", + "description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { - "description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", + "description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "type": "string" }, "serviceEnablementState": { diff --git a/discovery/serviceconsumermanagement-v1.json b/discovery/serviceconsumermanagement-v1.json index 152879431f..a902f01048 100644 --- a/discovery/serviceconsumermanagement-v1.json +++ b/discovery/serviceconsumermanagement-v1.json @@ -542,7 +542,7 @@ } } }, - "revision": "20240623", + "revision": "20240712", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1003,14 +1003,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1495,7 +1495,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/discovery/serviceconsumermanagement-v1beta1.json b/discovery/serviceconsumermanagement-v1beta1.json index 85aea90165..cf0a1321fc 100644 --- a/discovery/serviceconsumermanagement-v1beta1.json +++ b/discovery/serviceconsumermanagement-v1beta1.json @@ -715,7 +715,7 @@ } } }, - "revision": "20240623", + "revision": "20240712", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1110,14 +1110,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1580,7 +1580,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/discovery/servicecontrol-v1.json b/discovery/servicecontrol-v1.json index b635ead0a1..8afd31af6d 100644 --- a/discovery/servicecontrol-v1.json +++ b/discovery/servicecontrol-v1.json @@ -197,7 +197,7 @@ } } }, - "revision": "20240607", + "revision": "20240802", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -2178,6 +2178,11 @@ "description": "Report v2 extension proto for passing the resource metadata associated with a resource create/update/delete/undelete event from ESF to Chemist. ResourceEvent proto should be serialized into the ReportRequest.operations.extensions.", "id": "V1ResourceEvent", "properties": { + "contextId": { + "description": "The ESF unique context id of the api request, from which this resource event originated. This field is only needed for CAIS integration via api annotation. See go/cais-lro-delete for more details.", + "format": "int64", + "type": "string" + }, "destinations": { "description": "The destinations field determines which backend services should handle the event. This should be specified as a comma-delimited string.", "type": "string" diff --git a/discovery/servicecontrol-v2.json b/discovery/servicecontrol-v2.json index 6f19c10e69..2f67f7f46e 100644 --- a/discovery/servicecontrol-v2.json +++ b/discovery/servicecontrol-v2.json @@ -169,7 +169,7 @@ } } }, - "revision": "20240607", + "revision": "20240802", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -1191,6 +1191,11 @@ "description": "Report v2 extension proto for passing the resource metadata associated with a resource create/update/delete/undelete event from ESF to Chemist. ResourceEvent proto should be serialized into the ReportRequest.operations.extensions.", "id": "V2ResourceEvent", "properties": { + "contextId": { + "description": "The ESF unique context id of the api request, from which this resource event originated. This field is only needed for CAIS integration via api annotation. See go/cais-lro-delete for more details.", + "format": "int64", + "type": "string" + }, "destinations": { "description": "The destinations field determines which backend services should handle the event. This should be specified as a comma-delimited string.", "type": "string" diff --git a/discovery/servicemanagement-v1.json b/discovery/servicemanagement-v1.json index efefee8aa0..6f787a57db 100644 --- a/discovery/servicemanagement-v1.json +++ b/discovery/servicemanagement-v1.json @@ -830,7 +830,7 @@ } } }, - "revision": "20240531", + "revision": "20240712", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1427,14 +1427,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -2043,7 +2043,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/discovery/servicenetworking-v1.json b/discovery/servicenetworking-v1.json index 7491df43d9..4c00b645c5 100644 --- a/discovery/servicenetworking-v1.json +++ b/discovery/servicenetworking-v1.json @@ -1029,7 +1029,7 @@ } } }, - "revision": "20240626", + "revision": "20240716", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1765,14 +1765,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1957,7 +1957,7 @@ "type": "object" }, "Documentation": { - "description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", + "description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2421,7 +2421,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/discovery/servicenetworking-v1beta.json b/discovery/servicenetworking-v1beta.json index edfdf0293d..50898c0b41 100644 --- a/discovery/servicenetworking-v1beta.json +++ b/discovery/servicenetworking-v1beta.json @@ -307,7 +307,7 @@ } } }, - "revision": "20240626", + "revision": "20240716", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -918,14 +918,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1073,7 +1073,7 @@ "type": "object" }, "Documentation": { - "description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", + "description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1505,7 +1505,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json index 99b819e396..d9788e7b35 100644 --- a/discovery/serviceusage-v1.json +++ b/discovery/serviceusage-v1.json @@ -426,7 +426,7 @@ } } }, - "revision": "20240623", + "revision": "20240811", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -488,6 +488,83 @@ }, "type": "object" }, + "Analysis": { + "description": "A message to group the analysis information.", + "id": "Analysis", + "properties": { + "analysis": { + "$ref": "AnalysisResult", + "description": "Output only. Analysis result of updating a policy.", + "readOnly": true + }, + "analysisType": { + "description": "Output only. The type of analysis.", + "enum": [ + "ANALYSIS_TYPE_UNSPECIFIED", + "ANALYSIS_TYPE_DEPENDENCY", + "ANALYSIS_TYPE_RESOURCE_USAGE" + ], + "enumDescriptions": [ + "Unspecified analysis type. Do not use.", + "The analysis of service dependencies.", + "The analysis of service resource usage." + ], + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc.", + "readOnly": true, + "type": "string" + }, + "service": { + "description": "The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "AnalysisResult": { + "description": "An analysis result including blockers and warnings.", + "id": "AnalysisResult", + "properties": { + "blockers": { + "description": "Blocking information that would prevent the policy changes at runtime.", + "items": { + "$ref": "Impact" + }, + "type": "array" + }, + "warnings": { + "description": "Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime.", + "items": { + "$ref": "Impact" + }, + "type": "array" + } + }, + "type": "object" + }, + "AnalyzeConsumerPolicyMetadata": { + "description": "Metadata for the `AnalyzeConsumerPolicy` method.", + "id": "AnalyzeConsumerPolicyMetadata", + "properties": {}, + "type": "object" + }, + "AnalyzeConsumerPolicyResponse": { + "description": "The response of analyzing a consumer policy update.", + "id": "AnalyzeConsumerPolicyResponse", + "properties": { + "analysis": { + "description": "The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers.", + "items": { + "$ref": "Analysis" + }, + "type": "array" + } + }, + "type": "object" + }, "Api": { "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", "id": "Api", @@ -998,14 +1075,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1971,7 +2048,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { @@ -2020,6 +2097,31 @@ }, "type": "object" }, + "Impact": { + "description": "A message to group impacts of updating a policy.", + "id": "Impact", + "properties": { + "detail": { + "description": "Output only. User friendly impact detail in a free form message.", + "readOnly": true, + "type": "string" + }, + "impactType": { + "description": "Output only. The type of impact.", + "enum": [ + "IMPACT_TYPE_UNSPECIFIED", + "DEPENDENCY_MISSING_DEPENDENCIES" + ], + "enumDescriptions": [ + "Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE ...", + "Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ImportAdminOverridesMetadata": { "description": "Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides.", "id": "ImportAdminOverridesMetadata", diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json index 6a2282f59c..faf7a5e813 100644 --- a/discovery/serviceusage-v1beta1.json +++ b/discovery/serviceusage-v1beta1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20240623", + "revision": "20240811", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1026,6 +1026,83 @@ }, "type": "object" }, + "Analysis": { + "description": "A message to group the analysis information.", + "id": "Analysis", + "properties": { + "analysis": { + "$ref": "AnalysisResult", + "description": "Output only. Analysis result of updating a policy.", + "readOnly": true + }, + "analysisType": { + "description": "Output only. The type of analysis.", + "enum": [ + "ANALYSIS_TYPE_UNSPECIFIED", + "ANALYSIS_TYPE_DEPENDENCY", + "ANALYSIS_TYPE_RESOURCE_USAGE" + ], + "enumDescriptions": [ + "Unspecified analysis type. Do not use.", + "The analysis of service dependencies.", + "The analysis of service resource usage." + ], + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc.", + "readOnly": true, + "type": "string" + }, + "service": { + "description": "The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`.", + "type": "string" + } + }, + "type": "object" + }, + "AnalysisResult": { + "description": "An analysis result including blockers and warnings.", + "id": "AnalysisResult", + "properties": { + "blockers": { + "description": "Blocking information that would prevent the policy changes at runtime.", + "items": { + "$ref": "Impact" + }, + "type": "array" + }, + "warnings": { + "description": "Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime.", + "items": { + "$ref": "Impact" + }, + "type": "array" + } + }, + "type": "object" + }, + "AnalyzeConsumerPolicyMetadata": { + "description": "Metadata for the `AnalyzeConsumerPolicy` method.", + "id": "AnalyzeConsumerPolicyMetadata", + "properties": {}, + "type": "object" + }, + "AnalyzeConsumerPolicyResponse": { + "description": "The response of analyzing a consumer policy update.", + "id": "AnalyzeConsumerPolicyResponse", + "properties": { + "analysis": { + "description": "The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers.", + "items": { + "$ref": "Analysis" + }, + "type": "array" + } + }, + "type": "object" + }, "Api": { "description": "Api is a light-weight descriptor for an API Interface. Interfaces are also described as \"protocol buffer services\" in some contexts, such as by the \"service\" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as \"APIs\" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology.", "id": "Api", @@ -1594,14 +1671,14 @@ "type": "array" }, "provided": { - "description": "A list of full type names of provided contexts.", + "description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { - "description": "A list of full type names of requested contexts.", + "description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -2548,7 +2625,7 @@ "type": "object" }, "HttpRule": { - "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", + "description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { @@ -2597,6 +2674,31 @@ }, "type": "object" }, + "Impact": { + "description": "A message to group impacts of updating a policy.", + "id": "Impact", + "properties": { + "detail": { + "description": "Output only. User friendly impact detail in a free form message.", + "readOnly": true, + "type": "string" + }, + "impactType": { + "description": "Output only. The type of impact.", + "enum": [ + "IMPACT_TYPE_UNSPECIFIED", + "DEPENDENCY_MISSING_DEPENDENCIES" + ], + "enumDescriptions": [ + "Reserved Blocks (Block n contains codes from 100n to 100(n+1) -1 Block 0 - Special/Admin codes Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY Block 2 - Impact Type of ANALYSIS_TYPE_RESOURCE_USAGE ...", + "Block 1 - Impact Type of ANALYSIS_TYPE_DEPENDENCY" + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ImportAdminOverridesMetadata": { "description": "Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides.", "id": "ImportAdminOverridesMetadata", diff --git a/discovery/sheets-v4.json b/discovery/sheets-v4.json index b506cf5b4f..3ee4ce23fa 100644 --- a/discovery/sheets-v4.json +++ b/discovery/sheets-v4.json @@ -870,7 +870,7 @@ } } }, - "revision": "20240521", + "revision": "20240730", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -934,7 +934,7 @@ "type": "object" }, "AddDataSourceRequest": { - "description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope.", + "description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.", "id": "AddDataSourceRequest", "properties": { "dataSource": { @@ -2330,7 +2330,7 @@ "type": "object" }, "CancelDataSourceRefreshRequest": { - "description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references.", + "description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.", "id": "CancelDataSourceRefreshRequest", "properties": { "dataSourceId": { @@ -3699,6 +3699,10 @@ "$ref": "BigQueryDataSourceSpec", "description": "A BigQueryDataSourceSpec." }, + "looker": { + "$ref": "LookerDataSourceSpec", + "description": "A LookerDatasourceSpec." + }, "parameters": { "description": "The parameters of the data source, used when querying the data source.", "items": { @@ -5123,6 +5127,25 @@ }, "type": "object" }, + "LookerDataSourceSpec": { + "description": "The specification of a Looker data source.", + "id": "LookerDataSourceSpec", + "properties": { + "explore": { + "description": "Name of a Looker model explore.", + "type": "string" + }, + "instanceUri": { + "description": "A Looker instance URL.", + "type": "string" + }, + "model": { + "description": "Name of a Looker model.", + "type": "string" + } + }, + "type": "object" + }, "ManualRule": { "description": "Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+", "id": "ManualRule", @@ -5960,7 +5983,7 @@ "type": "object" }, "RefreshDataSourceRequest": { - "description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", + "description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", "id": "RefreshDataSourceRequest", "properties": { "dataSourceId": { @@ -7468,7 +7491,7 @@ "type": "object" }, "UpdateDataSourceRequest": { - "description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope.", + "description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.", "id": "UpdateDataSourceRequest", "properties": { "dataSource": { diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index ee57f051e2..419b6517e2 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -23,9 +23,14 @@ "documentationLink": "https://cloud.google.com/spanner/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://spanner.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" + }, + { + "description": "Regional Endpoint", + "endpointUrl": "https://spanner.us-west1.rep.googleapis.com/", + "location": "us-west1" } ], "fullyEncodeReservedExpansion": true, @@ -123,7 +128,7 @@ "instanceConfigOperations": { "methods": { "list": { - "description": "Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", + "description": "Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", "flatPath": "v1/projects/{projectsId}/instanceConfigOperations", "httpMethod": "GET", "id": "spanner.projects.instanceConfigOperations.list", @@ -132,7 +137,7 @@ ], "parameters": { "filter": { - "description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", + "description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", "location": "query", "type": "string" }, @@ -148,7 +153,7 @@ "type": "string" }, "parent": { - "description": "Required. The project of the instance config operations. Values are of the form `projects/`.", + "description": "Required. The project of the instance configuration operations. Values are of the form `projects/`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -169,7 +174,7 @@ "instanceConfigs": { "methods": { "create": { - "description": "Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", + "description": "Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "POST", "id": "spanner.projects.instanceConfigs.create", @@ -178,7 +183,7 @@ ], "parameters": { "parent": { - "description": "Required. The name of the project in which to create the instance config. Values are of the form `projects/`.", + "description": "Required. The name of the project in which to create the instance configuration. Values are of the form `projects/`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -198,7 +203,7 @@ ] }, "delete": { - "description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", + "description": "Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "DELETE", "id": "spanner.projects.instanceConfigs.delete", @@ -207,7 +212,7 @@ ], "parameters": { "etag": { - "description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.", + "description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration.", "location": "query", "type": "string" }, @@ -260,7 +265,7 @@ ] }, "list": { - "description": "Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.", + "description": "Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "GET", "id": "spanner.projects.instanceConfigs.list", @@ -297,7 +302,7 @@ ] }, "patch": { - "description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", + "description": "Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "PATCH", "id": "spanner.projects.instanceConfigs.patch", @@ -306,7 +311,7 @@ ], "parameters": { "name": { - "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", + "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", "location": "path", "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", "required": true, @@ -748,7 +753,7 @@ ] }, "move": { - "description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", + "description": "Moves an instance to the target instance configuration. You can use the returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup` * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. If not cancelled, upon completion of the returned operation: * The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration. Authorization requires the `spanner.instances.update` permission on the resource instance. For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance).", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:move", "httpMethod": "POST", "id": "spanner.projects.instances.move", @@ -1397,7 +1402,7 @@ "databases": { "methods": { "changequorum": { - "description": "ChangeQuorum is strictly restricted to databases that use dual region instance configurations. Initiates a background operation to change quorum a database from dual-region mode to single-region mode and vice versa. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track execution of the ChangeQuorum. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.", + "description": "`ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:changequorum", "httpMethod": "POST", "id": "spanner.projects.instances.databases.changequorum", @@ -1406,7 +1411,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`.", + "description": "Required. Name of the database in which to apply `ChangeQuorum`. Values are of the form `projects//instances//databases/`.", "location": "path", "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", "required": true, @@ -1426,7 +1431,7 @@ ] }, "create": { - "description": "Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", + "description": "Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", "httpMethod": "POST", "id": "spanner.projects.instances.databases.create", @@ -1804,6 +1809,255 @@ } }, "resources": { + "backupSchedules": { + "methods": { + "create": { + "description": "Creates a new backup schedule.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "backupScheduleId": { + "description": "Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the database that this backup schedule applies to.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupSchedules", + "request": { + "$ref": "BackupSchedule" + }, + "response": { + "$ref": "BackupSchedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "delete": { + "description": "Deletes a backup schedule.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", + "httpMethod": "DELETE", + "id": "spanner.projects.instances.databases.backupSchedules.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "get": { + "description": "Gets backup schedule for the input schedule name.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", + "httpMethod": "GET", + "id": "spanner.projects.instances.databases.backupSchedules.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "BackupSchedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "list": { + "description": "Lists all the backup schedules for the database.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules", + "httpMethod": "GET", + "id": "spanner.projects.instances.databases.backupSchedules.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/backupSchedules", + "response": { + "$ref": "ListBackupSchedulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "patch": { + "description": "Updates a backup schedule.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", + "httpMethod": "PATCH", + "id": "spanner.projects.instances.databases.backupSchedules.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "BackupSchedule" + }, + "response": { + "$ref": "BackupSchedule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.setIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "testIamPermissions": { + "description": "Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.", + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions", + "httpMethod": "POST", + "id": "spanner.projects.instances.databases.backupSchedules.testIamPermissions", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", + "location": "path", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + } + } + }, "databaseRoles": { "methods": { "list": { @@ -3005,11 +3259,11 @@ } } }, - "revision": "20240612", + "revision": "20240807", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { - "description": "Autoscaling config for an instance.", + "description": "Autoscaling configuration for an instance.", "id": "AutoscalingConfig", "properties": { "autoscalingLimits": { @@ -3071,6 +3325,14 @@ "description": "A backup of a Cloud Spanner database.", "id": "Backup", "properties": { + "backupSchedules": { + "description": "Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`.", "format": "google-datetime", @@ -3109,11 +3371,28 @@ "readOnly": true, "type": "array" }, + "exclusiveSizeBytes": { + "description": "Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "expireTime": { "description": "Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup.", "format": "google-datetime", "type": "string" }, + "freeableSizeBytes": { + "description": "Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "incrementalBackupChainId": { + "description": "Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`.", + "readOnly": true, + "type": "string" + }, "maxExpireTime": { "description": "Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`.", "format": "google-datetime", @@ -3124,6 +3403,12 @@ "description": "Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`.", "type": "string" }, + "oldestVersionTime": { + "description": "Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "referencingBackups": { "description": "Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed.", "items": { @@ -3141,7 +3426,7 @@ "type": "array" }, "sizeBytes": { - "description": "Output only. Size of the backup in bytes.", + "description": "Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain.", "format": "int64", "readOnly": true, "type": "string" @@ -3194,6 +3479,55 @@ }, "type": "object" }, + "BackupSchedule": { + "description": "BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10", + "id": "BackupSchedule", + "properties": { + "encryptionConfig": { + "$ref": "CreateBackupEncryptionConfig", + "description": "Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database." + }, + "fullBackupSpec": { + "$ref": "FullBackupSpec", + "description": "The schedule creates only full backups." + }, + "incrementalBackupSpec": { + "$ref": "IncrementalBackupSpec", + "description": "The schedule creates incremental backup chains." + }, + "name": { + "description": "Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length.", + "type": "string" + }, + "retentionDuration": { + "description": "Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.", + "format": "google-duration", + "type": "string" + }, + "spec": { + "$ref": "BackupScheduleSpec", + "description": "Optional. The schedule specification based on which the backup creations are triggered." + }, + "updateTime": { + "description": "Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BackupScheduleSpec": { + "description": "Defines specifications of the backup schedule.", + "id": "BackupScheduleSpec", + "properties": { + "cronSpec": { + "$ref": "CrontabSpec", + "description": "Cron style schedule specification." + } + }, + "type": "object" + }, "BatchCreateSessionsRequest": { "description": "The request for BatchCreateSessions.", "id": "BatchCreateSessionsRequest", @@ -3333,16 +3667,16 @@ "id": "ChangeQuorumRequest", "properties": { "etag": { - "description": "Optional. The etag is the hash of the QuorumInfo. The ChangeQuorum operation will only be performed if the etag matches that of the QuorumInfo in the current database resource. Otherwise the API will return an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition.", + "description": "Optional. The etag is the hash of the `QuorumInfo`. The `ChangeQuorum` operation is only performed if the etag matches that of the `QuorumInfo` in the current database resource. Otherwise the API returns an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition.", "type": "string" }, "name": { - "description": "Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`.", + "description": "Required. Name of the database in which to apply `ChangeQuorum`. Values are of the form `projects//instances//databases/`.", "type": "string" }, "quorumType": { "$ref": "QuorumType", - "description": "Required. The type of this Quorum." + "description": "Required. The type of this quorum." } }, "type": "object" @@ -3551,6 +3885,40 @@ }, "type": "object" }, + "CreateBackupEncryptionConfig": { + "description": "Encryption configuration for the backup to create.", + "id": "CreateBackupEncryptionConfig", + "properties": { + "encryptionType": { + "description": "Required. The encryption type of the backup.", + "enum": [ + "ENCRYPTION_TYPE_UNSPECIFIED", + "USE_DATABASE_ENCRYPTION", + "GOOGLE_DEFAULT_ENCRYPTION", + "CUSTOMER_MANAGED_ENCRYPTION" + ], + "enumDescriptions": [ + "Unspecified. Do not use.", + "Use the same encryption configuration as the database. This is the default option when encryption_config is empty. For example, if the database is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the database.", + "Use Google default encryption.", + "Use customer managed encryption. If specified, `kms_key_name` must contain a valid Cloud KMS key." + ], + "type": "string" + }, + "kmsKeyName": { + "description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", + "type": "string" + }, + "kmsKeyNames": { + "description": "Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "CreateBackupMetadata": { "description": "Metadata type for the operation returned by CreateBackup.", "id": "CreateBackupMetadata", @@ -3620,7 +3988,7 @@ "type": "array" }, "protoDescriptors": { - "description": "Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).", + "description": "Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).", "format": "byte", "type": "string" } @@ -3638,7 +4006,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", - "description": "The target instance config end state." + "description": "The target instance configuration end state." }, "progress": { "$ref": "InstanceOperationProgress", @@ -3653,10 +4021,10 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", - "description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." + "description": "Required. The `InstanceConfig` proto of the configuration to create. `instance_config.name` must be `/instanceConfigs/`. `instance_config.base_config` must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." }, "instanceConfigId": { - "description": "Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations.", + "description": "Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations.", "type": "string" }, "validateOnly": { @@ -3773,6 +4141,28 @@ }, "type": "object" }, + "CrontabSpec": { + "description": "CrontabSpec can be used to specify the version time and frequency at which the backup should be created.", + "id": "CrontabSpec", + "properties": { + "creationWindow": { + "description": "Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "text": { + "description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.", + "type": "string" + }, + "timeZone": { + "description": "Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Database": { "description": "A Cloud Spanner database.", "id": "Database", @@ -3810,7 +4200,7 @@ "type": "string" }, "enableDropProtection": { - "description": "Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion).", + "description": "Optional. Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion).", "type": "boolean" }, "encryptionConfig": { @@ -3832,7 +4222,7 @@ }, "quorumInfo": { "$ref": "QuorumInfo", - "description": "Output only. Applicable only for databases that use dual region instance configurations. Contains information about the quorum.", + "description": "Output only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum.", "readOnly": true }, "reconciling": { @@ -4152,7 +4542,7 @@ "enumDescriptions": [ "The default mode. Only the statement results are returned.", "This mode returns only the query plan, without any results or execution statistics information.", - "This mode returns both the query plan and the execution statistics along with the results." + "This mode returns both the query plan and the execution statistics along with the results. This has a performance overhead compared to the NORMAL mode. It is not recommended to use this mode for production traffic." ], "type": "string" }, @@ -4256,6 +4646,12 @@ }, "type": "object" }, + "FullBackupSpec": { + "description": "The specification for full backups. A full backup stores the entire contents of the database at a given version time.", + "id": "FullBackupSpec", + "properties": {}, + "type": "object" + }, "GetDatabaseDdlResponse": { "description": "The response for GetDatabaseDdl.", "id": "GetDatabaseDdlResponse", @@ -4316,6 +4712,12 @@ }, "type": "object" }, + "IncrementalBackupSpec": { + "description": "The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup.", + "id": "IncrementalBackupSpec", + "properties": {}, + "type": "object" + }, "IndexAdvice": { "description": "Recommendation to add new indexes to run queries more efficiently.", "id": "IndexAdvice", @@ -4386,6 +4788,22 @@ "description": "Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.", "type": "string" }, + "edition": { + "description": "Optional. The `Edition` of the current instance.", + "enum": [ + "EDITION_UNSPECIFIED", + "STANDARD", + "ENTERPRISE", + "ENTERPRISE_PLUS" + ], + "enumDescriptions": [ + "Edition not specified.", + "Standard edition.", + "Enterprise edition.", + "Enterprise Plus edition." + ], + "type": "string" + }, "endpointUris": { "description": "Deprecated. This field is not populated.", "items": { @@ -4423,12 +4841,12 @@ "type": "string" }, "nodeCount": { - "description": "The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", + "description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, "processingUnits": { - "description": "The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", + "description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, @@ -4461,11 +4879,11 @@ "id": "InstanceConfig", "properties": { "baseConfig": { - "description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.", + "description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration.", "type": "string" }, "configType": { - "description": "Output only. Whether this instance config is a Google or User Managed Configuration.", + "description": "Output only. Whether this instance configuration is a Google-managed or user-managed configuration.", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_MANAGED", @@ -4473,8 +4891,8 @@ ], "enumDescriptions": [ "Unspecified.", - "Google managed configuration.", - "User managed configuration." + "Google-managed configuration.", + "User-managed configuration." ], "readOnly": true, "type": "string" @@ -4484,11 +4902,11 @@ "type": "string" }, "etag": { - "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.", + "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.", "type": "string" }, "freeInstanceAvailability": { - "description": "Output only. Describes whether free instances are available to be created in this instance config.", + "description": "Output only. Describes whether free instances are available to be created in this instance configuration.", "enum": [ "FREE_INSTANCE_AVAILABILITY_UNSPECIFIED", "AVAILABLE", @@ -4498,10 +4916,10 @@ ], "enumDescriptions": [ "Not specified.", - "Indicates that free instances are available to be created in this instance config.", - "Indicates that free instances are not supported in this instance config.", - "Indicates that free instances are currently not available to be created in this instance config.", - "Indicates that additional free instances cannot be created in this instance config because the project has reached its limit of free instances." + "Indicates that free instances are available to be created in this instance configuration.", + "Indicates that free instances are not supported in this instance configuration.", + "Indicates that free instances are currently not available to be created in this instance configuration.", + "Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances." ], "readOnly": true, "type": "string" @@ -4521,11 +4939,11 @@ "type": "array" }, "name": { - "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", + "description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", "type": "string" }, "optionalReplicas": { - "description": "Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.", + "description": "Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.", "items": { "$ref": "ReplicaInfo" }, @@ -4541,28 +4959,28 @@ "MULTI_REGION" ], "enumDescriptions": [ - "Not specified.", - "An instance configuration tagged with REGION quorum type forms a write quorum in a single region.", - "An instance configuration tagged with DUAL_REGION quorum type forms a write quorums with exactly two read-write regions in a multi-region configuration. This instance configurations requires reconfiguration in the event of regional failures.", - "An instance configuration tagged with MULTI_REGION quorum type forms a write quorums from replicas are spread across more than one region in a multi-region configuration." + "Quorum type not specified.", + "An instance configuration tagged with `REGION` quorum type forms a write quorum in a single region.", + "An instance configuration tagged with the `DUAL_REGION` quorum type forms a write quorum with exactly two read-write regions in a multi-region configuration. This instance configuration requires failover in the event of regional failures.", + "An instance configuration tagged with the `MULTI_REGION` quorum type forms a write quorum from replicas that are spread across more than one region in a multi-region configuration." ], "readOnly": true, "type": "string" }, "reconciling": { - "description": "Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.", + "description": "Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration.", "readOnly": true, "type": "boolean" }, "replicas": { - "description": "The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.", + "description": "The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.", "items": { "$ref": "ReplicaInfo" }, "type": "array" }, "state": { - "description": "Output only. The current instance config state. Applicable only for USER_MANAGED configs.", + "description": "Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.", "enum": [ "STATE_UNSPECIFIED", "CREATING", @@ -4570,8 +4988,8 @@ ], "enumDescriptions": [ "Not specified.", - "The instance config is still being created.", - "The instance config is fully created and ready to be used to create instances." + "The instance configuration is still being created.", + "The instance configuration is fully created and ready to be used to create instances." ], "readOnly": true, "type": "string" @@ -4634,17 +5052,18 @@ "type": "string" }, "nodeCount": { - "description": "The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", + "description": "The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", "format": "int32", "type": "integer" }, "processingUnits": { - "description": "The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", + "description": "The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state.", "format": "int32", "type": "integer" }, "referencingBackups": { - "description": "Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.", + "deprecated": true, + "description": "Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted.", "items": { "type": "string" }, @@ -4834,6 +5253,24 @@ }, "type": "object" }, + "ListBackupSchedulesResponse": { + "description": "The response for ListBackupSchedules.", + "id": "ListBackupSchedulesResponse", + "properties": { + "backupSchedules": { + "description": "The list of backup schedules for a database.", + "items": { + "$ref": "BackupSchedule" + }, + "type": "array" + }, + "nextPageToken": { + "description": "`next_page_token` can be sent in a subsequent ListBackupSchedules call to fetch more of the schedules.", + "type": "string" + } + }, + "type": "object" + }, "ListBackupsResponse": { "description": "The response for ListBackups.", "id": "ListBackupsResponse", @@ -4915,7 +5352,7 @@ "type": "string" }, "operations": { - "description": "The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", + "description": "The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the name of the instance configuration. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", "items": { "$ref": "Operation" }, @@ -5199,7 +5636,7 @@ "id": "MoveInstanceRequest", "properties": { "targetConfig": { - "description": "Required. The target instance config for the instance to move. Values are of the form `projects//instanceConfigs/`.", + "description": "Required. The target instance configuration where to move the instance. Values are of the form `projects//instanceConfigs/`.", "type": "string" } }, @@ -5402,7 +5839,7 @@ "description": "Additional options that affect how many partitions are created." }, "sql": { - "description": "Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.", + "description": "Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations.", "type": "string" }, "transaction": { @@ -5629,16 +6066,16 @@ "type": "object" }, "QuorumInfo": { - "description": "Information about the dual region quorum.", + "description": "Information about the dual-region quorum.", "id": "QuorumInfo", "properties": { "etag": { - "description": "Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous ChangeQuorum requests that could create a race condition.", + "description": "Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous `ChangeQuorum` requests that might create a race condition.", "readOnly": true, "type": "string" }, "initiator": { - "description": "Output only. Whether this ChangeQuorum is a Google or User initiated.", + "description": "Output only. Whether this `ChangeQuorum` is Google or User initiated.", "enum": [ "INITIATOR_UNSPECIFIED", "GOOGLE", @@ -5646,8 +6083,8 @@ ], "enumDescriptions": [ "Unspecified.", - "ChangeQuorum initiated by Google.", - "ChangeQuorum initiated by User." + "`ChangeQuorum` initiated by Google.", + "`ChangeQuorum` initiated by User." ], "readOnly": true, "type": "string" @@ -5667,16 +6104,16 @@ "type": "object" }, "QuorumType": { - "description": "Information about the database quorum type. this applies only for dual region instance configs.", + "description": "Information about the database quorum type. This only applies to dual-region instance configs.", "id": "QuorumType", "properties": { "dualRegion": { "$ref": "DualRegionQuorum", - "description": "Dual region quorum type." + "description": "Dual-region quorum type." }, "singleRegion": { "$ref": "SingleRegionQuorum", - "description": "Single region quorum type." + "description": "Single-region quorum type." } }, "type": "object" @@ -5933,7 +6370,7 @@ "type": "string" }, "kmsKeyNames": { - "description": "Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", + "description": "Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations.", "items": { "type": "string" }, @@ -6238,7 +6675,7 @@ "id": "SingleRegionQuorum", "properties": { "servingLocation": { - "description": "Required. The location of the serving region, e.g. \"us-central1\". The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type.", + "description": "Required. The location of the serving region, e.g. \"us-central1\". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type.", "type": "string" } }, @@ -6585,7 +7022,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", - "description": "The desired instance config after updating." + "description": "The desired instance configuration after updating." }, "progress": { "$ref": "InstanceOperationProgress", @@ -6600,7 +7037,7 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", - "description": "Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." + "description": "Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." }, "updateMask": { "description": "Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.", diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 714597fb0a..e020557744 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { - "description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", + "description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { - "description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", + "description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, - "revision": "20240618", + "revision": "20240724", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2572,6 +2572,12 @@ "description": "Location of the backups.", "type": "string" }, + "maxChargeableBytes": { + "description": "Output only. The maximum chargeable bytes for the backup.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "selfLink": { "description": "The URI of this resource.", "type": "string" @@ -2915,6 +2921,20 @@ "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." + }, + "serverCaMode": { + "description": "Specify what type of CA is used for the server certificate.", + "enum": [ + "CA_MODE_UNSPECIFIED", + "GOOGLE_MANAGED_INTERNAL_CA", + "GOOGLE_MANAGED_CAS_CA" + ], + "enumDescriptions": [ + "CA mode is unknown.", + "Google-managed self-signed internal CA.", + "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." + ], + "type": "string" } }, "type": "object" @@ -3319,6 +3339,11 @@ "description": "Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "This status indicates whether the instance satisfies PZS. The status is reserved for future use.", "type": "boolean" @@ -3415,6 +3440,10 @@ }, "type": "array" }, + "switchTransactionLogsToCloudStorageEnabled": { + "description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", + "type": "boolean" + }, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -3711,6 +3740,20 @@ "description": "Optional. Whether or not the export should be parallel.", "type": "boolean" }, + "postgresExportOptions": { + "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", + "properties": { + "clean": { + "description": "Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.", + "type": "boolean" + } + }, + "type": "object" + }, "schemaOnly": { "description": "Export only schemas.", "type": "boolean" @@ -4193,6 +4236,20 @@ "description": "Optional. Whether or not the import should be parallel.", "type": "boolean" }, + "postgresImportOptions": { + "description": "Optional. Options for importing from a Cloud SQL for PostgreSQL instance.", + "properties": { + "clean": { + "description": "Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + } + }, + "type": "object" + }, "threads": { "description": "Optional. The number of threads to use for parallel import.", "format": "int32", @@ -4462,6 +4519,20 @@ "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag.", "type": "boolean" }, + "serverCaMode": { + "description": "Specify what type of CA is used for the server certificate.", + "enum": [ + "CA_MODE_UNSPECIFIED", + "GOOGLE_MANAGED_INTERNAL_CA", + "GOOGLE_MANAGED_CAS_CA" + ], + "enumDescriptions": [ + "CA mode is unknown.", + "Google-managed self-signed internal CA.", + "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." + ], + "type": "string" + }, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4779,7 +4850,8 @@ "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", - "SWITCHOVER_TO_REPLICA" + "SWITCHOVER_TO_REPLICA", + "MAJOR_VERSION_UPGRADE" ], "enumDeprecated": [ false, @@ -4826,6 +4898,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4873,7 +4946,8 @@ "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", - "Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." + "Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", + "Updates the major version of a Cloud SQL instance." ], "type": "string" }, @@ -5551,7 +5625,8 @@ "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", - "EXTENSIONS_NOT_ENABLED_IN_REPLICA" + "EXTENSIONS_NOT_ENABLED_IN_REPLICA", + "UNSUPPORTED_COLUMNS" ], "enumDescriptions": [ "", @@ -5602,7 +5677,8 @@ "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", - "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." + "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", + "The source database has generated columns that can't be migrated. Please change them to regular columns before migration." ], "type": "string" } diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 40660b458c..103d8f79fa 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { - "description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", + "description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { - "description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", + "description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, - "revision": "20240618", + "revision": "20240724", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2572,6 +2572,12 @@ "description": "Location of the backups.", "type": "string" }, + "maxChargeableBytes": { + "description": "Output only. The maximum chargeable bytes for the backup.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "selfLink": { "description": "The URI of this resource.", "type": "string" @@ -2915,6 +2921,20 @@ "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." + }, + "serverCaMode": { + "description": "Specify what type of CA is used for the server certificate.", + "enum": [ + "CA_MODE_UNSPECIFIED", + "GOOGLE_MANAGED_INTERNAL_CA", + "GOOGLE_MANAGED_CAS_CA" + ], + "enumDescriptions": [ + "CA mode is unknown.", + "Google-managed self-signed internal CA.", + "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." + ], + "type": "string" } }, "type": "object" @@ -3319,6 +3339,11 @@ "description": "Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances.", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "satisfiesPzs": { "description": "This status indicates whether the instance satisfies PZS. The status is reserved for future use.", "type": "boolean" @@ -3416,6 +3441,10 @@ }, "type": "array" }, + "switchTransactionLogsToCloudStorageEnabled": { + "description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", + "type": "boolean" + }, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -3712,6 +3741,20 @@ "description": "Optional. Whether or not the export should be parallel.", "type": "boolean" }, + "postgresExportOptions": { + "description": "Options for exporting from a Cloud SQL for PostgreSQL instance.", + "properties": { + "clean": { + "description": "Optional. Use this option to include DROP SQL statements. These statements are used to delete database objects before running the import operation.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. Option to include an IF EXISTS SQL statement with each DROP statement produced by clean.", + "type": "boolean" + } + }, + "type": "object" + }, "schemaOnly": { "description": "Export only schemas.", "type": "boolean" @@ -4194,6 +4237,20 @@ "description": "Optional. Whether or not the import should be parallel.", "type": "boolean" }, + "postgresImportOptions": { + "description": "Optional. Options for importing from a Cloud SQL for PostgreSQL instance.", + "properties": { + "clean": { + "description": "Optional. The --clean flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + }, + "ifExists": { + "description": "Optional. The --if-exists flag for the pg_restore utility. This flag applies only if you enabled Cloud SQL to import files in parallel.", + "type": "boolean" + } + }, + "type": "object" + }, "threads": { "description": "Optional. The number of threads to use for parallel import.", "format": "int32", @@ -4463,6 +4520,20 @@ "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag.", "type": "boolean" }, + "serverCaMode": { + "description": "Specify what type of CA is used for the server certificate.", + "enum": [ + "CA_MODE_UNSPECIFIED", + "GOOGLE_MANAGED_INTERNAL_CA", + "GOOGLE_MANAGED_CAS_CA" + ], + "enumDescriptions": [ + "CA mode is unknown.", + "Google-managed self-signed internal CA.", + "Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." + ], + "type": "string" + }, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4780,7 +4851,8 @@ "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", - "SWITCHOVER_TO_REPLICA" + "SWITCHOVER_TO_REPLICA", + "MAJOR_VERSION_UPGRADE" ], "enumDeprecated": [ false, @@ -4827,6 +4899,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -4874,7 +4947,8 @@ "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", - "Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." + "Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", + "Updates the major version of a Cloud SQL instance." ], "type": "string" }, @@ -5552,7 +5626,8 @@ "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", - "EXTENSIONS_NOT_ENABLED_IN_REPLICA" + "EXTENSIONS_NOT_ENABLED_IN_REPLICA", + "UNSUPPORTED_COLUMNS" ], "enumDescriptions": [ "", @@ -5603,7 +5678,8 @@ "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", - "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." + "This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", + "The source database has generated columns that can't be migrated. Please change them to regular columns before migration." ], "type": "string" } diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 9c69351ac3..8271b1b420 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -28,22 +28,22 @@ "documentationLink": "https://developers.google.com/storage/docs/json_api/", "endpoints": [ { + "description": "Regional Endpoint", "endpointUrl": "https://storage.europe-west3.rep.googleapis.com/", - "location": "europe-west3", - "description": "Regional Endpoint" + "location": "europe-west3" }, { + "description": "Regional Endpoint", "endpointUrl": "https://storage.europe-west9.rep.googleapis.com/", - "location": "europe-west9", - "description": "Regional Endpoint" + "location": "europe-west9" }, { + "description": "Regional Endpoint", "endpointUrl": "https://storage.me-central2.rep.googleapis.com/", - "location": "me-central2", - "description": "Regional Endpoint" + "location": "me-central2" } ], - "etag": "\"39393931363036383932333134343736343437\"", + "etag": "\"34373939373134303235393739323331393435\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -560,7 +560,7 @@ "buckets": { "methods": { "delete": { - "description": "Permanently deletes an empty bucket.", + "description": "Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket.", "httpMethod": "DELETE", "id": "storage.buckets.delete", "parameterOrder": [ @@ -612,6 +612,12 @@ "required": true, "type": "string" }, + "generation": { + "description": "If present, specifies the generation of the bucket. This is required if softDeleted is true.", + "format": "int64", + "location": "query", + "type": "string" + }, "ifMetagenerationMatch": { "description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.", "format": "int64", @@ -637,6 +643,11 @@ "location": "query", "type": "string" }, + "softDeleted": { + "description": "If true, return the soft-deleted version of this bucket. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).", + "location": "query", + "type": "boolean" + }, "userProject": { "description": "The project to be billed for this request. Required for Requester Pays buckets.", "location": "query", @@ -860,6 +871,11 @@ "location": "query", "type": "string" }, + "softDeleted": { + "description": "If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).", + "location": "query", + "type": "boolean" + }, "userProject": { "description": "The project to be billed for this request.", "location": "query", @@ -1013,6 +1029,41 @@ "https://www.googleapis.com/auth/devstorage.full_control" ] }, + "restore": { + "description": "Restores a soft-deleted bucket.", + "httpMethod": "POST", + "id": "storage.buckets.restore", + "parameterOrder": [ + "bucket", + "generation" + ], + "parameters": { + "bucket": { + "description": "Name of a bucket.", + "location": "path", + "required": true, + "type": "string" + }, + "generation": { + "description": "Generation of a bucket.", + "format": "int64", + "location": "query", + "required": true, + "type": "string" + }, + "userProject": { + "description": "The project to be billed for this request. Required for Requester Pays buckets.", + "location": "query", + "type": "string" + } + }, + "path": "b/{bucket}/restore", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/devstorage.full_control", + "https://www.googleapis.com/auth/devstorage.read_write" + ] + }, "setIamPolicy": { "description": "Updates an IAM policy for the specified bucket.", "httpMethod": "PUT", @@ -2779,7 +2830,7 @@ "type": "string" }, "softDeleted": { - "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.", + "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).", "location": "query", "type": "boolean" }, @@ -3041,7 +3092,7 @@ "type": "string" }, "softDeleted": { - "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.", + "description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).", "location": "query", "type": "boolean" }, @@ -3056,7 +3107,7 @@ "type": "string" }, "versions": { - "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.", + "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).", "location": "query", "type": "boolean" } @@ -3235,7 +3286,7 @@ "type": "string" }, "object": { - "description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.", + "description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", "location": "path", "required": true, "type": "string" @@ -3704,7 +3755,7 @@ "type": "string" }, "versions": { - "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.", + "description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).", "location": "query", "type": "boolean" } @@ -4006,7 +4057,7 @@ ] }, "update": { - "description": "Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.", + "description": "Updates the state of an HMAC key. See the [HMAC Key resource descriptor](https://cloud.google.com/storage/docs/json_api/v1/projects/hmacKeys/update#request-body) for valid states.", "httpMethod": "PUT", "id": "storage.projects.hmacKeys.update", "parameterOrder": [ @@ -4085,7 +4136,7 @@ } } }, - "revision": "20240625", + "revision": "20240809", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { @@ -4293,6 +4344,11 @@ "description": "HTTP 1.1 Entity tag for the bucket.", "type": "string" }, + "generation": { + "description": "The generation of this bucket.", + "format": "int64", + "type": "string" + }, "hierarchicalNamespace": { "description": "The bucket's hierarchical namespace configuration.", "properties": { @@ -4347,6 +4403,49 @@ "description": "The ID of the bucket. For buckets, the id and name properties are the same.", "type": "string" }, + "ipFilter": { + "description": "The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'.", + "properties": { + "mode": { + "description": "The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.", + "type": "string" + }, + "publicNetworkSource": { + "description": "The public network source of the bucket's IP filter.", + "properties": { + "allowedIpCidrRanges": { + "description": "The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "vpcNetworkSources": { + "description": "The list of [VPC network](https://cloud.google.com/vpc/docs/vpc) sources of the bucket's IP filter.", + "items": { + "properties": { + "allowedIpCidrRanges": { + "description": "The list of IPv4, IPv6 cidr ranges subnetworks that are allowed to access the bucket.", + "items": { + "type": "string" + }, + "type": "array" + }, + "network": { + "description": "Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + } + }, + "type": "object" + }, "kind": { "default": "storage#bucket", "description": "The kind of item this is. For buckets, this is always storage#bucket.", @@ -4361,7 +4460,7 @@ "type": "object" }, "lifecycle": { - "description": "The bucket's lifecycle configuration. See lifecycle management for more information.", + "description": "The bucket's lifecycle configuration. See [Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle) for more information.", "properties": { "rule": { "description": "A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.", @@ -4460,7 +4559,7 @@ "type": "object" }, "location": { - "description": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.", + "description": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [Developer's Guide](https://cloud.google.com/storage/docs/locations) for the authoritative list.", "type": "string" }, "locationType": { @@ -4548,6 +4647,10 @@ "description": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.", "type": "string" }, + "satisfiesPZI": { + "description": "Reserved for future use.", + "type": "boolean" + }, "satisfiesPZS": { "description": "Reserved for future use.", "type": "boolean" @@ -4573,7 +4676,7 @@ "type": "object" }, "storageClass": { - "description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.", + "description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes).", "type": "string" }, "timeCreated": { @@ -4597,7 +4700,7 @@ "type": "object" }, "website": { - "description": "The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.", + "description": "The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the [Static Website Examples](https://cloud.google.com/storage/docs/static-website) for more information.", "properties": { "mainPageSuffix": { "description": "If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.", @@ -5392,7 +5495,7 @@ "type": "string" }, "crc32c": { - "description": "CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.", + "description": "CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation).", "type": "string" }, "customTime": { @@ -5446,7 +5549,7 @@ "type": "string" }, "md5Hash": { - "description": "MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.", + "description": "MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation).", "type": "string" }, "mediaLink": { diff --git a/discovery/sts-v1.json b/discovery/sts-v1.json index 6f057ef5a9..3c7a8f826f 100644 --- a/discovery/sts-v1.json +++ b/discovery/sts-v1.json @@ -116,7 +116,7 @@ } } }, - "revision": "20240501", + "revision": "20240704", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -216,6 +216,11 @@ "description": "Response message for ExchangeToken.", "id": "GoogleIdentityStsV1ExchangeTokenResponse", "properties": { + "access_boundary_session_key": { + "description": "The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`.", + "format": "byte", + "type": "string" + }, "access_token": { "description": "An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time.", "type": "string" diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index 309afd8213..9d96a3dad1 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -374,14 +374,19 @@ ] }, "lookup": { - "description": "Looks up a Container by destination ID.", + "description": "Looks up a Container by destination ID or tag ID.", "flatPath": "tagmanager/v2/accounts/containers:lookup", "httpMethod": "GET", "id": "tagmanager.accounts.containers.lookup", "parameterOrder": [], "parameters": { "destinationId": { - "description": "Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id}.", + "description": "Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id}. Only one of destination_id or tag_id should be set.", + "location": "query", + "type": "string" + }, + "tagId": { + "description": "Tag ID for a GTM Container, e.g. GTM-123456789. Example: accounts/containers:lookup?tag_id={tag_id}. Only one of destination_id or tag_id should be set.", "location": "query", "type": "string" } @@ -3890,7 +3895,7 @@ } } }, - "revision": "20240619", + "revision": "20240701", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/transcoder-v1.json b/discovery/transcoder-v1.json index a86c766589..ce3f1148d9 100644 --- a/discovery/transcoder-v1.json +++ b/discovery/transcoder-v1.json @@ -385,7 +385,7 @@ } } }, - "revision": "20240207", + "revision": "20240626", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { @@ -1541,7 +1541,7 @@ "id": "Output", "properties": { "uri": { - "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).", + "description": "URI for the output file(s). For example, `gs://my-bucket/outputs/`. Must be a directory and not a top-level bucket. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats).", "type": "string" } }, diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index c4f967756e..7ecefeba0d 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -1260,7 +1260,8 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-translation" ] } }, @@ -1395,7 +1396,7 @@ ], "parameters": { "name": { - "description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", + "description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/glossaryEntries/[^/]+$", "required": true, @@ -1706,7 +1707,7 @@ } } }, - "revision": "20240126", + "revision": "20240718", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { @@ -1817,7 +1818,7 @@ "id": "AdaptiveMtTranslateRequest", "properties": { "content": { - "description": "Required. The content of the input in string format. For now only one sentence per request is supported.", + "description": "Required. The content of the input in string format.", "items": { "type": "string" }, @@ -1826,6 +1827,14 @@ "dataset": { "description": "Required. The resource name for the dataset to use for adaptive MT. `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}`", "type": "string" + }, + "glossaryConfig": { + "$ref": "TranslateTextGlossaryConfig", + "description": "Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned." + }, + "referenceSentenceConfig": { + "$ref": "ReferenceSentenceConfig", + "description": "Configuration for caller provided reference sentences." } }, "type": "object" @@ -1834,6 +1843,13 @@ "description": "An AdaptiveMtTranslate response.", "id": "AdaptiveMtTranslateResponse", "properties": { + "glossaryTranslations": { + "description": "Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply.", + "items": { + "$ref": "AdaptiveMtTranslation" + }, + "type": "array" + }, "languageCode": { "description": "Output only. The translation's language code.", "readOnly": true, @@ -2360,7 +2376,7 @@ "type": "string" }, "name": { - "description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", + "description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "type": "string" }, "termsPair": { @@ -2848,6 +2864,57 @@ }, "type": "object" }, + "ReferenceSentenceConfig": { + "description": "Message of caller-provided reference configuration.", + "id": "ReferenceSentenceConfig", + "properties": { + "referenceSentencePairLists": { + "description": "Reference sentences pair lists. Each list will be used as the references to translate the sentence under \"content\" field at the corresponding index. Length of the list is required to be equal to the length of \"content\" field.", + "items": { + "$ref": "ReferenceSentencePairList" + }, + "type": "array" + }, + "sourceLanguageCode": { + "description": "Source language code.", + "type": "string" + }, + "targetLanguageCode": { + "description": "Target language code.", + "type": "string" + } + }, + "type": "object" + }, + "ReferenceSentencePair": { + "description": "A pair of sentences used as reference in source and target languages.", + "id": "ReferenceSentencePair", + "properties": { + "sourceSentence": { + "description": "Source sentence in the sentence pair.", + "type": "string" + }, + "targetSentence": { + "description": "Target sentence in the sentence pair.", + "type": "string" + } + }, + "type": "object" + }, + "ReferenceSentencePairList": { + "description": "A list of reference sentence pairs.", + "id": "ReferenceSentencePairList", + "properties": { + "referenceSentencePairs": { + "description": "Reference sentence pairs.", + "items": { + "$ref": "ReferenceSentencePair" + }, + "type": "array" + } + }, + "type": "object" + }, "Romanization": { "description": "A single romanization response.", "id": "Romanization", @@ -3078,7 +3145,7 @@ "type": "string" }, "model": { - "description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", + "description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", "type": "string" }, "sourceLanguageCode": { diff --git a/discovery/vault-v1.json b/discovery/vault-v1.json index f05e5590f9..abe2d52cc0 100644 --- a/discovery/vault-v1.json +++ b/discovery/vault-v1.json @@ -1203,7 +1203,7 @@ } } }, - "revision": "20240617", + "revision": "20240806", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { @@ -2297,6 +2297,22 @@ }, "type": "array" }, + "matterRegion": { + "description": "Optional. The requested data region for the matter.", + "enum": [ + "MATTER_REGION_UNSPECIFIED", + "ANY", + "US", + "EUROPE" + ], + "enumDescriptions": [ + "The region is unspecified. Defaults to ANY.", + "Any region.", + "United States region.", + "Europe region." + ], + "type": "string" + }, "name": { "description": "The name of the matter.", "type": "string" diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index fa7cc65e46..8dc686259f 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -1180,6 +1180,66 @@ } } }, + "diskMigrationJobs": { + "methods": { + "cancel": { + "description": "Cancels the disk migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Runs the disk migration job.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:run", + "request": { + "$ref": "RunDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "migratingVms": { "methods": { "create": { @@ -2220,7 +2280,7 @@ } } }, - "revision": "20240613", + "revision": "20240712", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2873,13 +2933,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -2906,6 +2968,12 @@ "properties": {}, "type": "object" }, + "CancelDiskMigrationJobRequest": { + "description": "Request message for 'CancelDiskMigrationJob' request.", + "id": "CancelDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3137,13 +3205,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3267,13 +3337,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3713,7 +3785,7 @@ "id": "DiskImageTargetDetails", "properties": { "additionalLicenses": { - "description": "Optional. Additional licenses to assign to the image.", + "description": "Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", "items": { "type": "string" }, @@ -3984,6 +4056,10 @@ "$ref": "Encryption", "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine." }, + "machineImageTargetDefaults": { + "$ref": "MachineImageTargetDetails", + "description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob." + }, "name": { "description": "Output only. The resource path of the ImageImport.", "readOnly": true, @@ -4042,6 +4118,11 @@ "readOnly": true, "type": "array" }, + "machineImageTargetDetails": { + "$ref": "MachineImageTargetDetails", + "description": "Output only. Target details used to import a machine image.", + "readOnly": true + }, "name": { "description": "Output only. The resource path of the ImageImportJob.", "readOnly": true, @@ -4581,6 +4662,92 @@ }, "type": "object" }, + "MachineImageParametersOverrides": { + "description": "Parameters overriding decisions based on the source machine image configurations.", + "id": "MachineImageParametersOverrides", + "properties": { + "machineType": { + "description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", + "type": "string" + } + }, + "type": "object" + }, + "MachineImageTargetDetails": { + "description": "The target details of the machine image resource that will be created by the image import job.", + "id": "MachineImageTargetDetails", + "properties": { + "additionalLicenses": { + "description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Optional. An optional description of the machine image.", + "type": "string" + }, + "encryption": { + "$ref": "Encryption", + "description": "Immutable. The encryption to apply to the machine image." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to apply to the instance created by the machine image.", + "type": "object" + }, + "machineImageName": { + "description": "Required. The name of the machine image to be created.", + "type": "string" + }, + "machineImageParametersOverrides": { + "$ref": "MachineImageParametersOverrides", + "description": "Optional. Parameters overriding decisions based on the source machine image configurations." + }, + "networkInterfaces": { + "description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" + }, + "osAdaptationParameters": { + "$ref": "ImageImportOsAdaptationParameters", + "description": "Optional. Use to set the parameters relevant for the OS adaptation process." + }, + "serviceAccount": { + "$ref": "ServiceAccount", + "description": "Optional. The service account to assign to the instance created by the machine image." + }, + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig", + "description": "Optional. Shielded instance configuration." + }, + "singleRegionStorage": { + "description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", + "type": "boolean" + }, + "skipOsAdaptation": { + "$ref": "SkipOsAdaptation", + "description": "Optional. Use to skip OS adaptation process." + }, + "tags": { + "description": "Optional. The tags to apply to the instance created by the machine image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetProject": { + "description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created.", + "type": "string" + } + }, + "type": "object" + }, "MigratingVm": { "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state.", "id": "MigratingVm", @@ -4873,8 +5040,22 @@ "description": "The network to connect the NIC to.", "type": "string" }, + "networkTier": { + "description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", + "enum": [ + "COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", + "NETWORK_TIER_STANDARD", + "NETWORK_TIER_PREMIUM" + ], + "enumDescriptions": [ + "An unspecified network tier. Will be used as PREMIUM.", + "A standard network tier.", + "A premium network tier." + ], + "type": "string" + }, "subnetwork": { - "description": "The subnetwork to connect the NIC to.", + "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" } }, @@ -5045,13 +5226,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -5066,7 +5249,7 @@ }, "vmAttachmentDetails": { "$ref": "VmAttachmentDetails", - "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM." + "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM." } }, "type": "object" @@ -5214,6 +5397,12 @@ "properties": {}, "type": "object" }, + "RunDiskMigrationJobRequest": { + "description": "Request message for 'RunDiskMigrationJobRequest' request.", + "id": "RunDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", @@ -5262,12 +5451,65 @@ }, "type": "object" }, + "ServiceAccount": { + "description": "Service account to assign to the instance created by the machine image.", + "id": "ServiceAccount", + "properties": { + "email": { + "description": "Required. The email address of the service account.", + "type": "string" + }, + "scopes": { + "description": "Optional. The list of scopes to be made available for this service account.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ShieldedInstanceConfig": { + "description": "Shielded instance configuration.", + "id": "ShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", + "type": "boolean" + }, + "secureBoot": { + "description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", + "enum": [ + "SECURE_BOOT_UNSPECIFIED", + "TRUE", + "FALSE" + ], + "enumDescriptions": [ + "No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", + "Use secure boot. This can be set to true only if the image boot option is EFI.", + "Do not use secure boot." + ], + "type": "string" + } + }, + "type": "object" + }, "ShuttingDownSourceVMStep": { "description": "ShuttingDownSourceVMStep contains specific step details.", "id": "ShuttingDownSourceVMStep", "properties": {}, "type": "object" }, + "SkipOsAdaptation": { + "description": "Mentions that the machine image import is not using OS adaptation process.", + "id": "SkipOsAdaptation", + "properties": {}, + "type": "object" + }, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index ecc11a46c2..338595c212 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -1180,6 +1180,66 @@ } } }, + "diskMigrationJobs": { + "methods": { + "cancel": { + "description": "Cancels the disk migration job.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:cancel", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:cancel", + "request": { + "$ref": "CancelDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "run": { + "description": "Runs the disk migration job.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/sources/{sourcesId}/diskMigrationJobs/{diskMigrationJobsId}:run", + "httpMethod": "POST", + "id": "vmmigration.projects.locations.sources.diskMigrationJobs.run", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DiskMigrationJob.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/sources/[^/]+/diskMigrationJobs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+name}:run", + "request": { + "$ref": "RunDiskMigrationJobRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "migratingVms": { "methods": { "create": { @@ -2220,7 +2280,7 @@ } } }, - "revision": "20240613", + "revision": "20240712", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -2873,13 +2933,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -2906,6 +2968,12 @@ "properties": {}, "type": "object" }, + "CancelDiskMigrationJobRequest": { + "description": "Request message for 'CancelDiskMigrationJob' request.", + "id": "CancelDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "CancelImageImportJobRequest": { "description": "Request message for 'CancelImageImportJob' request.", "id": "CancelImageImportJobRequest", @@ -3149,13 +3217,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3279,13 +3349,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -3748,7 +3820,7 @@ "id": "DiskImageTargetDetails", "properties": { "additionalLicenses": { - "description": "Optional. Additional licenses to assign to the image.", + "description": "Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", "items": { "type": "string" }, @@ -4019,6 +4091,10 @@ "$ref": "Encryption", "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine." }, + "machineImageTargetDefaults": { + "$ref": "MachineImageTargetDetails", + "description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob." + }, "name": { "description": "Output only. The resource path of the ImageImport.", "readOnly": true, @@ -4077,6 +4153,11 @@ "readOnly": true, "type": "array" }, + "machineImageTargetDetails": { + "$ref": "MachineImageTargetDetails", + "description": "Output only. Target details used to import a machine image.", + "readOnly": true + }, "name": { "description": "Output only. The resource path of the ImageImportJob.", "readOnly": true, @@ -4616,6 +4697,92 @@ }, "type": "object" }, + "MachineImageParametersOverrides": { + "description": "Parameters overriding decisions based on the source machine image configurations.", + "id": "MachineImageParametersOverrides", + "properties": { + "machineType": { + "description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", + "type": "string" + } + }, + "type": "object" + }, + "MachineImageTargetDetails": { + "description": "The target details of the machine image resource that will be created by the image import job.", + "id": "MachineImageTargetDetails", + "properties": { + "additionalLicenses": { + "description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Optional. An optional description of the machine image.", + "type": "string" + }, + "encryption": { + "$ref": "Encryption", + "description": "Immutable. The encryption to apply to the machine image." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to apply to the instance created by the machine image.", + "type": "object" + }, + "machineImageName": { + "description": "Required. The name of the machine image to be created.", + "type": "string" + }, + "machineImageParametersOverrides": { + "$ref": "MachineImageParametersOverrides", + "description": "Optional. Parameters overriding decisions based on the source machine image configurations." + }, + "networkInterfaces": { + "description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import.", + "items": { + "$ref": "NetworkInterface" + }, + "type": "array" + }, + "osAdaptationParameters": { + "$ref": "ImageImportOsAdaptationParameters", + "description": "Optional. Use to set the parameters relevant for the OS adaptation process." + }, + "serviceAccount": { + "$ref": "ServiceAccount", + "description": "Optional. The service account to assign to the instance created by the machine image." + }, + "shieldedInstanceConfig": { + "$ref": "ShieldedInstanceConfig", + "description": "Optional. Shielded instance configuration." + }, + "singleRegionStorage": { + "description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", + "type": "boolean" + }, + "skipOsAdaptation": { + "$ref": "SkipOsAdaptation", + "description": "Optional. Use to skip OS adaptation process." + }, + "tags": { + "description": "Optional. The tags to apply to the instance created by the machine image.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetProject": { + "description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created.", + "type": "string" + } + }, + "type": "object" + }, "MigratingVm": { "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state.", "id": "MigratingVm", @@ -4918,8 +5085,22 @@ "description": "The network to connect the NIC to.", "type": "string" }, + "networkTier": { + "description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", + "enum": [ + "COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", + "NETWORK_TIER_STANDARD", + "NETWORK_TIER_PREMIUM" + ], + "enumDescriptions": [ + "An unspecified network tier. Will be used as PREMIUM.", + "A standard network tier.", + "A premium network tier." + ], + "type": "string" + }, "subnetwork": { - "description": "The subnetwork to connect the NIC to.", + "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" } }, @@ -5090,13 +5271,15 @@ "COMPUTE_ENGINE_DISK_TYPE_UNSPECIFIED", "COMPUTE_ENGINE_DISK_TYPE_STANDARD", "COMPUTE_ENGINE_DISK_TYPE_SSD", - "COMPUTE_ENGINE_DISK_TYPE_BALANCED" + "COMPUTE_ENGINE_DISK_TYPE_BALANCED", + "COMPUTE_ENGINE_DISK_TYPE_HYPERDISK_BALANCED" ], "enumDescriptions": [ "An unspecified disk type. Will be used as STANDARD.", "A Standard disk type.", "SSD hard disk type.", - "An alternative to SSD persistent disks that balance performance and cost." + "An alternative to SSD persistent disks that balance performance and cost.", + "Hyperdisk balanced disk type." ], "type": "string" }, @@ -5111,7 +5294,7 @@ }, "vmAttachmentDetails": { "$ref": "VmAttachmentDetails", - "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM." + "description": "Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM." } }, "type": "object" @@ -5265,6 +5448,12 @@ "properties": {}, "type": "object" }, + "RunDiskMigrationJobRequest": { + "description": "Request message for 'RunDiskMigrationJobRequest' request.", + "id": "RunDiskMigrationJobRequest", + "properties": {}, + "type": "object" + }, "SchedulePolicy": { "description": "A policy for scheduling replications.", "id": "SchedulePolicy", @@ -5313,12 +5502,65 @@ }, "type": "object" }, + "ServiceAccount": { + "description": "Service account to assign to the instance created by the machine image.", + "id": "ServiceAccount", + "properties": { + "email": { + "description": "Required. The email address of the service account.", + "type": "string" + }, + "scopes": { + "description": "Optional. The list of scopes to be made available for this service account.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ShieldedInstanceConfig": { + "description": "Shielded instance configuration.", + "id": "ShieldedInstanceConfig", + "properties": { + "enableIntegrityMonitoring": { + "description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled.", + "type": "boolean" + }, + "enableVtpm": { + "description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", + "type": "boolean" + }, + "secureBoot": { + "description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", + "enum": [ + "SECURE_BOOT_UNSPECIFIED", + "TRUE", + "FALSE" + ], + "enumDescriptions": [ + "No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", + "Use secure boot. This can be set to true only if the image boot option is EFI.", + "Do not use secure boot." + ], + "type": "string" + } + }, + "type": "object" + }, "ShuttingDownSourceVMStep": { "description": "ShuttingDownSourceVMStep contains specific step details.", "id": "ShuttingDownSourceVMStep", "properties": {}, "type": "object" }, + "SkipOsAdaptation": { + "description": "Mentions that the machine image import is not using OS adaptation process.", + "id": "SkipOsAdaptation", + "properties": {}, + "type": "object" + }, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json index e90a85b188..b4094df5dd 100644 --- a/discovery/vmwareengine-v1.json +++ b/discovery/vmwareengine-v1.json @@ -3173,7 +3173,7 @@ } } }, - "revision": "20240528", + "revision": "20240701", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AuditConfig": { @@ -3224,6 +3224,67 @@ }, "type": "object" }, + "AutoscalingPolicy": { + "description": "Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds.", + "id": "AutoscalingPolicy", + "properties": { + "consumedMemoryThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to amount of consumed memory." + }, + "cpuThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to CPU utilization." + }, + "grantedMemoryThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to amount of granted memory." + }, + "nodeTypeId": { + "description": "Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`.", + "type": "string" + }, + "scaleOutSize": { + "description": "Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration.", + "format": "int32", + "type": "integer" + }, + "storageThresholds": { + "$ref": "Thresholds", + "description": "Optional. Utilization thresholds pertaining to amount of consumed storage." + } + }, + "type": "object" + }, + "AutoscalingSettings": { + "description": "Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud.", + "id": "AutoscalingSettings", + "properties": { + "autoscalingPolicies": { + "additionalProperties": { + "$ref": "AutoscalingPolicy" + }, + "description": "Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes.", + "type": "object" + }, + "coolDownPeriod": { + "description": "Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes).", + "format": "google-duration", + "type": "string" + }, + "maxClusterNodeCount": { + "description": "Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply.", + "format": "int32", + "type": "integer" + }, + "minClusterNodeCount": { + "description": "Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -3250,6 +3311,10 @@ "description": "A cluster in a private cloud.", "id": "Cluster", "properties": { + "autoscalingSettings": { + "$ref": "AutoscalingSettings", + "description": "Optional. Configuration of the autoscaling applied to this cluster." + }, "createTime": { "description": "Output only. Creation time of this resource.", "format": "google-datetime", @@ -5382,6 +5447,23 @@ }, "type": "object" }, + "Thresholds": { + "description": "Thresholds define the utilization of resources triggering scale-out and scale-in operations.", + "id": "Thresholds", + "properties": { + "scaleIn": { + "description": "Required. The utilization triggering the scale-in operation in percent.", + "format": "int32", + "type": "integer" + }, + "scaleOut": { + "description": "Required. The utilization triggering the scale-out operation in percent.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "UndeletePrivateCloudRequest": { "description": "Request message for VmwareEngine.UndeletePrivateCloud", "id": "UndeletePrivateCloudRequest", diff --git a/discovery/walletobjects-v1.json b/discovery/walletobjects-v1.json index 45fa23b42c..4f8ffd3424 100644 --- a/discovery/walletobjects-v1.json +++ b/discovery/walletobjects-v1.json @@ -2681,7 +2681,7 @@ } } }, - "revision": "20240628", + "revision": "20240809", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -4207,6 +4207,13 @@ "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#eventTicketObject\"`.", "type": "string" }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this event ticket object. If a user had saved this event ticket, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linkedOfferIds": { "description": "A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.", "items": { @@ -4244,6 +4251,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "seatInfo": { "$ref": "EventSeat", "description": "Seating details for this ticket." @@ -4662,15 +4673,15 @@ "description": "Links module data. If links module data is also defined on the object, both will be displayed." }, "localBoardingDateTime": { - "description": "The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.", + "description": "The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.", "type": "string" }, "localEstimatedOrActualArrivalDateTime": { - "description": "The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.", + "description": "The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.", "type": "string" }, "localEstimatedOrActualDepartureDateTime": { - "description": "The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.", + "description": "The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.", "type": "string" }, "localGateClosingDateTime": { @@ -4678,7 +4689,7 @@ "type": "string" }, "localScheduledArrivalDateTime": { - "description": "The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.", + "description": "The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.", "type": "string" }, "localScheduledDepartureDateTime": { @@ -4951,6 +4962,13 @@ "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#flightObject\"`.", "type": "string" }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this flight object. If a user had saved this boarding pass, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linksModuleData": { "$ref": "LinksModuleData", "description": "Links module data. If links module data is also defined on the class, both will be displayed." @@ -4985,6 +5003,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "securityProgramLogo": { "$ref": "Image", "description": "An image for the security program that applies to the passenger." @@ -5319,6 +5341,13 @@ }, "type": "array" }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object. If a user had saved this generic card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linksModuleData": { "$ref": "LinksModuleData", "description": "Links module data. If `linksModuleData` is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object." @@ -5327,6 +5356,13 @@ "$ref": "Image", "description": "The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter of `cardTitle` would be shown as logo." }, + "messages": { + "description": "An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.", + "items": { + "$ref": "Message" + }, + "type": "array" + }, "notifications": { "$ref": "Notifications", "description": "The notification settings that are enabled for this object." @@ -5339,6 +5375,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode settings/details." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -5783,6 +5823,13 @@ "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#giftCardObject\"`.", "type": "string" }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linksModuleData": { "$ref": "LinksModuleData", "description": "Links module data. If links module data is also defined on the class, both will be displayed." @@ -5813,6 +5860,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -6600,6 +6651,13 @@ "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#loyaltyObject\"`.", "type": "string" }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object. If a user had saved this loyalty card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linkedOfferIds": { "description": "A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you.", "items": { @@ -6637,6 +6695,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "secondaryLoyaltyPoints": { "$ref": "LoyaltyPoints", "description": "The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points." @@ -7537,6 +7599,13 @@ "description": "Identifies what kind of resource this is. Value: the fixed string `\"walletobjects#offerObject\"`.", "type": "string" }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this offer object. If a user had saved this offer, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID.identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linksModuleData": { "$ref": "LinksModuleData", "description": "Links module data. If links module data is also defined on the class, both will be displayed." @@ -7563,6 +7632,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -8132,6 +8205,17 @@ }, "type": "object" }, + "SaveRestrictions": { + "description": "Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support.", + "id": "SaveRestrictions", + "properties": { + "restrictToEmailSha256": { + "description": "Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like \".\" or \"+\", except \"@\". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.", + "type": "string" + } + }, + "type": "object" + }, "SecurityAnimation": { "id": "SecurityAnimation", "properties": { @@ -8935,6 +9019,13 @@ "$ref": "InfoModuleData", "description": "Deprecated. Use textModulesData instead." }, + "linkedObjectIds": { + "description": "linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this transit object. If a user had saved this transit card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you.", + "items": { + "type": "string" + }, + "type": "array" + }, "linksModuleData": { "$ref": "LinksModuleData", "description": "Links module data. If links module data is also defined on the class, both will be displayed." @@ -8994,6 +9085,10 @@ "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, + "saveRestrictions": { + "$ref": "SaveRestrictions", + "description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." + }, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" diff --git a/discovery/workflowexecutions-v1.json b/discovery/workflowexecutions-v1.json index 5d607dace1..587c75c04f 100644 --- a/discovery/workflowexecutions-v1.json +++ b/discovery/workflowexecutions-v1.json @@ -457,7 +457,7 @@ } } }, - "revision": "20240617", + "revision": "20240715", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -578,6 +578,20 @@ "description": "Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`.", "readOnly": true }, + "executionHistoryLevel": { + "description": "Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction.", + "enum": [ + "EXECUTION_HISTORY_LEVEL_UNSPECIFIED", + "EXECUTION_HISTORY_BASIC", + "EXECUTION_HISTORY_DETAILED" + ], + "enumDescriptions": [ + "The default/unset value.", + "Enable execution history basic feature for this execution.", + "Enable execution history detailed feature for this execution." + ], + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" diff --git a/discovery/workflows-v1.json b/discovery/workflows-v1.json index 332396fa0c..cbc7c6b73c 100644 --- a/discovery/workflows-v1.json +++ b/discovery/workflows-v1.json @@ -485,7 +485,7 @@ } } }, - "revision": "20240612", + "revision": "20240710", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -722,7 +722,7 @@ "type": "object" }, "Workflow": { - "description": "Workflow program to be executed by Workflows.", + "description": "LINT.IfChange Workflow program to be executed by Workflows.", "id": "Workflow", "properties": { "allKmsKeys": { diff --git a/discovery/workloadmanager-v1.json b/discovery/workloadmanager-v1.json index dcea7499b3..b3a865767c 100644 --- a/discovery/workloadmanager-v1.json +++ b/discovery/workloadmanager-v1.json @@ -772,7 +772,7 @@ } } }, - "revision": "20240619", + "revision": "20240717", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -797,6 +797,10 @@ "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", "id": "AssetLocation", "properties": { + "ccfeRmsPath": { + "description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", + "type": "string" + }, "expected": { "$ref": "IsolationExpectations", "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." @@ -1108,7 +1112,7 @@ "id": "ExternalDataSources", "properties": { "assetType": { - "description": "Required. The asset type of the external data source must be one of go/cai-asset-types", + "description": "Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule", "type": "string" }, "name": { @@ -1191,6 +1195,10 @@ "IsolationExpectations": { "id": "IsolationExpectations", "properties": { + "requirementOverride": { + "$ref": "RequirementOverride", + "description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." + }, "ziOrgPolicy": { "enum": [ "ZI_UNSPECIFIED", @@ -1650,6 +1658,44 @@ }, "type": "object" }, + "RequirementOverride": { + "id": "RequirementOverride", + "properties": { + "ziOverride": { + "enum": [ + "ZI_UNSPECIFIED", + "ZI_UNKNOWN", + "ZI_NOT_REQUIRED", + "ZI_PREFERRED", + "ZI_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "", + "" + ], + "type": "string" + }, + "zsOverride": { + "enum": [ + "ZS_UNSPECIFIED", + "ZS_UNKNOWN", + "ZS_NOT_REQUIRED", + "ZS_REQUIRED" + ], + "enumDescriptions": [ + "", + "To be used if tracking is not available", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "Resource": { "description": "Message represent resource in execution result", "id": "Resource", @@ -2124,14 +2170,36 @@ "INSTANCE_ROLE_ASCS", "INSTANCE_ROLE_ERS", "INSTANCE_ROLE_APP_SERVER", - "INSTANCE_ROLE_DATABASE" + "INSTANCE_ROLE_DATABASE", + "INSTANCE_ROLE_ASCS_ERS", + "INSTANCE_ROLE_ASCS_APP_SERVER", + "INSTANCE_ROLE_ASCS_DATABASE", + "INSTANCE_ROLE_ERS_APP_SERVER", + "INSTANCE_ROLE_ERS_DATABASE", + "INSTANCE_ROLE_APP_SERVER_DATABASE", + "INSTANCE_ROLE_ASCS_ERS_APP_SERVER", + "INSTANCE_ROLE_ASCS_ERS_DATABASE", + "INSTANCE_ROLE_ASCS_APP_SERVER_DATABASE", + "INSTANCE_ROLE_ERS_APP_SERVER_DATABASE", + "INSTANCE_ROLE_ASCS_ERS_APP_SERVER_DATABASE" ], "enumDescriptions": [ "Unspecified instance role.", "Application central services.", "Enqueue replication server.", "Application server.", - "Database node." + "Database node.", + "Combinations of roles. Application central services and enqueue replication server.", + "Application central services and application server.", + "Application central services and database.", + "Enqueue replication server and application server.", + "Enqueue replication server and database.", + "Application server and database.", + "Application central services, enqueue replication server and application server.", + "Application central services, enqueue replication server and database.", + "Application central services, application server and database.", + "Enqueue replication server, application server and database.", + "Application central services, enqueue replication server, application server and database." ], "type": "string" }, @@ -2318,7 +2386,15 @@ "SpannerLocation": { "id": "SpannerLocation", "properties": { + "backupName": { + "description": "Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata", + "items": { + "type": "string" + }, + "type": "array" + }, "dbName": { + "description": "Set of databases used by the resource in format /span//", "items": { "type": "string" }, diff --git a/discovery/workspaceevents-v1.json b/discovery/workspaceevents-v1.json index a48653c230..406f5af3f2 100644 --- a/discovery/workspaceevents-v1.json +++ b/discovery/workspaceevents-v1.json @@ -6,25 +6,25 @@ "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, "https://www.googleapis.com/auth/chat.memberships": { - "description": "View, add, update, and remove members from conversations in Google Chat" + "description": "See, add, update, and remove members from conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.memberships.readonly": { "description": "View members in Google Chat conversations." }, "https://www.googleapis.com/auth/chat.messages": { - "description": "View, compose, send, update, and delete messages, and add, view, and delete reactions to messages." + "description": "See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages." }, "https://www.googleapis.com/auth/chat.messages.reactions": { - "description": "View, add, and delete reactions to messages in Google Chat" + "description": "See, add, and delete reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.reactions.readonly": { "description": "View reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.readonly": { - "description": "View messages and reactions in Google Chat" + "description": "See messages and their associated reactions and attachments in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces": { - "description": "Create conversations and spaces and see or edit metadata (including history settings and access settings) in Google Chat" + "description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.readonly": { "description": "View chat and spaces in Google Chat" @@ -424,7 +424,7 @@ } } }, - "revision": "20240505", + "revision": "20240723", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index 75acfc3442..aceacad5e4 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -1195,7 +1195,7 @@ } } }, - "revision": "20240619", + "revision": "20240723", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1347,11 +1347,11 @@ "type": "object" }, "DomainConfig": { - "description": "Configuration options for private workstation clusters.", + "description": "Configuration options for a custom domain.", "id": "DomainConfig", "properties": { "domain": { - "description": "Immutable. Whether Workstations endpoint is private.", + "description": "Immutable. Domain used by Workstations for HTTP ingress.", "type": "string" } }, @@ -1435,7 +1435,7 @@ "type": "boolean" }, "enableNestedVirtualization": { - "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", + "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "machineType": { @@ -1479,7 +1479,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as https://cloud.google.com/resource-manager/docs/tags/tags-overview Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.", + "description": "Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.", "type": "object" } }, @@ -1940,23 +1940,45 @@ }, "type": "object" }, + "PortRange": { + "description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", + "id": "PortRange", + "properties": { + "first": { + "description": "Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.", + "format": "int32", + "type": "integer" + }, + "last": { + "description": "Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "PrivateClusterConfig": { + "description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { + "description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { + "description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { + "description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { + "description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2282,6 +2304,13 @@ "description": "A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.", "id": "WorkstationConfig", "properties": { + "allowedPorts": { + "description": "Optional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535.", + "items": { + "$ref": "PortRange" + }, + "type": "array" + }, "annotations": { "additionalProperties": { "type": "string" @@ -2327,7 +2356,7 @@ "type": "string" }, "enableAuditAgent": { - "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).", + "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index 6a06a9a850..1cb7624964 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -1127,7 +1127,7 @@ } } }, - "revision": "20240619", + "revision": "20240803", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1233,7 +1233,7 @@ "type": "integer" }, "enableNestedVirtualization": { - "description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false.", + "description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "id": { @@ -1315,11 +1315,11 @@ "type": "object" }, "DomainConfig": { - "description": "Configuration options for private workstation clusters.", + "description": "Configuration options for a custom domain.", "id": "DomainConfig", "properties": { "domain": { - "description": "Immutable. Whether Workstations endpoint is private.", + "description": "Immutable. Domain used by Workstations for HTTP ingress.", "type": "string" } }, @@ -1410,7 +1410,7 @@ "type": "boolean" }, "enableNestedVirtualization": { - "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", + "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "machineType": { @@ -1454,7 +1454,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as https://cloud.google.com/resource-manager/docs/tags/tags-overview Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.", + "description": "Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`.", "type": "object" } }, @@ -1596,7 +1596,7 @@ "type": "object" }, "HttpOptions": { - "description": "Http options for the running workstations.", + "description": "HTTP options for the running workstations.", "id": "HttpOptions", "properties": { "allowedUnauthenticatedCorsPreflightRequests": { @@ -1875,16 +1875,16 @@ "type": "object" }, "PortRange": { - "description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", + "description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", "id": "PortRange", "properties": { "first": { - "description": "Required. Starting port number for the current range of ports.", + "description": "Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.", "format": "int32", "type": "integer" }, "last": { - "description": "Required. Ending port number for the current range of ports.", + "description": "Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535.", "format": "int32", "type": "integer" } @@ -1892,22 +1892,27 @@ "type": "object" }, "PrivateClusterConfig": { + "description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { + "description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { + "description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { + "description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { + "description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2046,6 +2051,14 @@ "description": "Optional. Client-specified annotations.", "type": "object" }, + "boostConfigs": { + "description": "Output only. List of available boost configuration ids that this workstation can be boosted up to", + "items": { + "$ref": "WorkstationBoostConfig" + }, + "readOnly": true, + "type": "array" + }, "createTime": { "description": "Output only. Time when this workstation was created.", "format": "google-datetime", @@ -2099,8 +2112,18 @@ "readOnly": true, "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "sourceWorkstation": { - "description": "Optional. The source workstation from which this workstations persistent directories were cloned on creation.", + "description": "Optional. The source workstation from which this workstation's persistent directories were cloned on creation.", "type": "string" }, "startTime": { @@ -2142,6 +2165,18 @@ }, "type": "object" }, + "WorkstationBoostConfig": { + "description": "Boost config for this workstation. This object is populated from the parent workstation config.", + "id": "WorkstationBoostConfig", + "properties": { + "id": { + "description": "Output only. Boost config id.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "WorkstationCluster": { "description": "A workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.", "id": "WorkstationCluster", @@ -2219,6 +2254,16 @@ "readOnly": true, "type": "boolean" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "subnetwork": { "description": "Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.", "type": "string" @@ -2242,7 +2287,7 @@ "id": "WorkstationConfig", "properties": { "allowedPorts": { - "description": "Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", + "description": "Optional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535.", "items": { "$ref": "PortRange" }, @@ -2293,7 +2338,7 @@ "type": "string" }, "enableAuditAgent": { - "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).", + "description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { @@ -2317,7 +2362,7 @@ }, "httpOptions": { "$ref": "HttpOptions", - "description": "Optional. Http options that customize the behavior of the workstation service's http proxy." + "description": "Optional. HTTP options that customize the behavior of the workstation service's HTTP proxy." }, "idleTimeout": { "description": "Optional. Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `\"7200s\"` (2 hours). The default is `\"1200s\"` (20 minutes).", @@ -2331,6 +2376,11 @@ "description": "Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources.", "type": "object" }, + "maxUsableWorkstations": { + "description": "Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited.", + "format": "int32", + "type": "integer" + }, "name": { "description": "Identifier. Full name of this workstation configuration.", "type": "string" @@ -2366,6 +2416,16 @@ "format": "google-duration", "type": "string" }, + "satisfiesPzi": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, + "satisfiesPzs": { + "description": "Output only. Reserved for future use.", + "readOnly": true, + "type": "boolean" + }, "uid": { "description": "Output only. A system-assigned unique identifier for this workstation configuration.", "readOnly": true, diff --git a/release-please-config.json b/release-please-config.json index 66bfca6f90..14241fec14 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -299,6 +299,9 @@ "src/apis/meet": {}, "src/apis/pollen": {}, "src/apis/airquality": {}, - "src/apis/apim": {} + "src/apis/apim": {}, + "src/apis/adsenseplatform": {}, + "src/apis/keep": {}, + "src/apis/css": {} } } \ No newline at end of file diff --git a/src/apis/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 8a5e9a2eec..13989311aa 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -389,7 +389,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$EgressFrom { /** - * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -521,7 +521,7 @@ export namespace accesscontextmanager_v1 { */ export interface Schema$IngressFrom { /** - * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** diff --git a/src/apis/acmedns/README.md b/src/apis/acmedns/README.md index da90020a38..f6f63349cc 100644 --- a/src/apis/acmedns/README.md +++ b/src/apis/acmedns/README.md @@ -2,7 +2,7 @@ # acmedns -> Google Domains ACME DNS API that allows users to complete ACME DNS-01 challenges for a domain. +> ## Installation diff --git a/src/apis/addressvalidation/v1.ts b/src/apis/addressvalidation/v1.ts index e26afbdc55..3c283b6eab 100644 --- a/src/apis/addressvalidation/v1.ts +++ b/src/apis/addressvalidation/v1.ts @@ -395,7 +395,7 @@ export namespace addressvalidation_v1 { */ dpvDrop?: string | null; /** - * Indicates that more than one DPV return code is valid for the address. Returns a single character. * `Y`: Address was DPV confirmed for primary and any secondary numbers. * `N`: Primary and any secondary number information failed to DPV confirm. * `S`: Address was DPV confirmed for the primary number only, and the secondary number information was present by not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required. * `D`: Address was DPV confirmed for the primary number only, and the secondary number information was missing. * `R`: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided. + * Indicates that more than one DPV return code is valid for the address. Returns a single character. * `Y`: Address was DPV confirmed for primary and any secondary numbers. * `N`: Primary and any secondary number information failed to DPV confirm. * `S`: Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required. * `D`: Address was DPV confirmed for the primary number only, and the secondary number information was missing. * `R`: Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided. */ dpvEnhancedDeliveryCode?: string | null; /** diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index fdfc77260e..165c5cd01a 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -13914,7 +13914,7 @@ export namespace admin_directory_v1 { } /** - * Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. + * Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/adsenseplatform/README.md b/src/apis/adsenseplatform/README.md new file mode 100644 index 0000000000..62808e685e --- /dev/null +++ b/src/apis/adsenseplatform/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# adsenseplatform + +> + +## Installation + +```sh +$ npm install @googleapis/adsenseplatform +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/adsenseplatform/classes/Adsenseplatform.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/adsenseplatform/index.ts b/src/apis/adsenseplatform/index.ts new file mode 100644 index 0000000000..8698a3cd5b --- /dev/null +++ b/src/apis/adsenseplatform/index.ts @@ -0,0 +1,65 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {adsenseplatform_v1} from './v1'; +import {adsenseplatform_v1alpha} from './v1alpha'; + +export const VERSIONS = { + v1: adsenseplatform_v1.Adsenseplatform, + v1alpha: adsenseplatform_v1alpha.Adsenseplatform, +}; + +export function adsenseplatform( + version: 'v1' +): adsenseplatform_v1.Adsenseplatform; +export function adsenseplatform( + options: adsenseplatform_v1.Options +): adsenseplatform_v1.Adsenseplatform; +export function adsenseplatform( + version: 'v1alpha' +): adsenseplatform_v1alpha.Adsenseplatform; +export function adsenseplatform( + options: adsenseplatform_v1alpha.Options +): adsenseplatform_v1alpha.Adsenseplatform; +export function adsenseplatform< + T = + | adsenseplatform_v1.Adsenseplatform + | adsenseplatform_v1alpha.Adsenseplatform, +>( + this: GoogleConfigurable, + versionOrOptions: + | 'v1' + | adsenseplatform_v1.Options + | 'v1alpha' + | adsenseplatform_v1alpha.Options +) { + return getAPI('adsenseplatform', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {adsenseplatform_v1}; +export {adsenseplatform_v1alpha}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/adsenseplatform/package.json b/src/apis/adsenseplatform/package.json new file mode 100644 index 0000000000..a7a05a26fd --- /dev/null +++ b/src/apis/adsenseplatform/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/adsenseplatform", + "version": "0.1.0", + "description": "adsenseplatform", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/adsenseplatform/tsconfig.json b/src/apis/adsenseplatform/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/adsenseplatform/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/adsenseplatform/v1.ts b/src/apis/adsenseplatform/v1.ts new file mode 100644 index 0000000000..b5d4d39f88 --- /dev/null +++ b/src/apis/adsenseplatform/v1.ts @@ -0,0 +1,1462 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace adsenseplatform_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * AdSense Platform API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const adsenseplatform = google.adsenseplatform('v1'); + * ``` + */ + export class Adsenseplatform { + context: APIRequestContext; + platforms: Resource$Platforms; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.platforms = new Resource$Platforms(this.context); + } + } + + /** + * Representation of an Account. + */ + export interface Schema$Account { + /** + * Output only. Creation time of the account. + */ + createTime?: string | null; + /** + * Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + */ + creationRequestId?: string | null; + /** + * Display name of this account. + */ + displayName?: string | null; + /** + * Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + */ + name?: string | null; + /** + * Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + */ + regionCode?: string | null; + /** + * Output only. Approval state of the account. + */ + state?: string | null; + /** + * Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + */ + timeZone?: Schema$TimeZone; + } + /** + * Address data. + */ + export interface Schema$Address { + /** + * First line of address. Max length 64 bytes or 30 characters. + */ + address1?: string | null; + /** + * Second line of address. Max length 64 bytes or 30 characters. + */ + address2?: string | null; + /** + * City. Max length 60 bytes or 30 characters. + */ + city?: string | null; + /** + * Name of the company. Max length 255 bytes or 34 characters. + */ + company?: string | null; + /** + * Contact name of the company. Max length 128 bytes or 34 characters. + */ + contact?: string | null; + /** + * Fax number with international code (i.e. +441234567890). + */ + fax?: string | null; + /** + * Phone number with international code (i.e. +441234567890). + */ + phone?: string | null; + /** + * Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + */ + regionCode?: string | null; + /** + * State. Max length 60 bytes or 30 characters. + */ + state?: string | null; + /** + * Zip/post code. Max length 10 bytes or 10 characters. + */ + zip?: string | null; + } + /** + * Request definition for the account close rpc. + */ + export interface Schema$CloseAccountRequest {} + /** + * Response definition for the account close rpc. + */ + export interface Schema$CloseAccountResponse {} + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * A platform sub-account event to record spam signals. + */ + export interface Schema$Event { + /** + * Required. Information associated with the event. + */ + eventInfo?: Schema$EventInfo; + /** + * Required. Event timestamp. + */ + eventTime?: string | null; + /** + * Required. Event type. + */ + eventType?: string | null; + } + /** + * Private information for partner recorded events (PII). + */ + export interface Schema$EventInfo { + /** + * The billing address of the publisher associated with this event, if available. + */ + billingAddress?: Schema$Address; + /** + * Required. The email address that is associated with the publisher when performing the event. + */ + email?: string | null; + } + /** + * Response definition for the list accounts rpc. + */ + export interface Schema$ListAccountsResponse { + /** + * The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`. + */ + accounts?: Schema$Account[]; + /** + * Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. + */ + nextPageToken?: string | null; + } + /** + * Response definition for the site list rpc. + */ + export interface Schema$ListSitesResponse { + /** + * Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this. + */ + nextPageToken?: string | null; + /** + * The sites returned in this list response. + */ + sites?: Schema$Site[]; + } + /** + * Response definition for the lookup account rpc. + */ + export interface Schema$LookupAccountResponse { + /** + * The name of the Account Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string | null; + } + /** + * Response definition for the site request review rpc. + */ + export interface Schema$RequestSiteReviewResponse {} + /** + * Representation of a Site. + */ + export interface Schema$Site { + /** + * Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + */ + domain?: string | null; + /** + * Output only. Resource name of a site. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string | null; + /** + * Output only. State of a site. + */ + state?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone, e.g. "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number, e.g. "2019a". + */ + version?: string | null; + } + + export class Resource$Platforms { + context: APIRequestContext; + accounts: Resource$Platforms$Accounts; + constructor(context: APIRequestContext) { + this.context = context; + this.accounts = new Resource$Platforms$Accounts(this.context); + } + } + + export class Resource$Platforms$Accounts { + context: APIRequestContext; + events: Resource$Platforms$Accounts$Events; + sites: Resource$Platforms$Accounts$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.events = new Resource$Platforms$Accounts$Events(this.context); + this.sites = new Resource$Platforms$Accounts$Sites(this.context); + } + + /** + * Closes a sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + close( + params: Params$Resource$Platforms$Accounts$Close, + options: StreamMethodOptions + ): GaxiosPromise; + close( + params?: Params$Resource$Platforms$Accounts$Close, + options?: MethodOptions + ): GaxiosPromise; + close( + params: Params$Resource$Platforms$Accounts$Close, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + close( + params: Params$Resource$Platforms$Accounts$Close, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + close( + params: Params$Resource$Platforms$Accounts$Close, + callback: BodyResponseCallback + ): void; + close(callback: BodyResponseCallback): void; + close( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Close + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Close; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Close; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:close').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about the selected sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Platforms$Accounts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Platforms$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platforms$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists a partial view of sub-accounts for a specific parent account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Platforms$Accounts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Platforms$Accounts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platforms$Accounts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Platforms$Accounts$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + callback: BodyResponseCallback + ): void; + lookup(callback: BodyResponseCallback): void; + lookup( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accounts:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Close + extends StandardParameters { + /** + * Required. Account to close. Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloseAccountRequest; + } + export interface Params$Resource$Platforms$Accounts$Create + extends StandardParameters { + /** + * Required. Platform to create an account for. Format: platforms/{platform\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + export interface Params$Resource$Platforms$Accounts$Get + extends StandardParameters { + /** + * Required. Account to get information about. Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$List + extends StandardParameters { + /** + * Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Platform who parents the accounts. Format: platforms/{platform\} + */ + parent?: string; + } + export interface Params$Resource$Platforms$Accounts$Lookup + extends StandardParameters { + /** + * Optional. The creation_request_id provided when calling createAccount. + */ + creationRequestId?: string; + /** + * Required. Platform who parents the account. Format: platforms/{platform\} + */ + parent?: string; + } + + export class Resource$Platforms$Accounts$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an account event. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Events$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Events$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Events$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Events$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Events$Create + extends StandardParameters { + /** + * Required. Account to log events about. Format: platforms/{platform\}/accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Event; + } + + export class Resource$Platforms$Accounts$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a site for a specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/sites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Platforms$Accounts$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a site from a specified sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Platforms$Accounts$Sites$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites for a specific account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Platforms$Accounts$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/sites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: StreamMethodOptions + ): GaxiosPromise; + requestReview( + params?: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options?: MethodOptions + ): GaxiosPromise; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + callback: BodyResponseCallback + ): void; + requestReview( + callback: BodyResponseCallback + ): void; + requestReview( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Requestreview + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Requestreview; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Requestreview; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:requestReview').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Sites$Create + extends StandardParameters { + /** + * Required. Account to create site. Format: platforms/{platform\}/accounts/{account_id\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Platforms$Accounts$Sites$Delete + extends StandardParameters { + /** + * Required. The name of the site to delete. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$Get + extends StandardParameters { + /** + * Required. The name of the site to retrieve. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$List + extends StandardParameters { + /** + * The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The account which owns the sites. Format: platforms/{platform\}/accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$Requestreview + extends StandardParameters { + /** + * Required. The name of the site to submit for review. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } +} diff --git a/src/apis/adsenseplatform/v1alpha.ts b/src/apis/adsenseplatform/v1alpha.ts new file mode 100644 index 0000000000..273ecdcdda --- /dev/null +++ b/src/apis/adsenseplatform/v1alpha.ts @@ -0,0 +1,1465 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace adsenseplatform_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * AdSense Platform API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const adsenseplatform = google.adsenseplatform('v1alpha'); + * ``` + */ + export class Adsenseplatform { + context: APIRequestContext; + platforms: Resource$Platforms; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.platforms = new Resource$Platforms(this.context); + } + } + + /** + * Representation of an Account. + */ + export interface Schema$Account { + /** + * Output only. Creation time of the account. + */ + createTime?: string | null; + /** + * Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error. + */ + creationRequestId?: string | null; + /** + * Display name of this account. + */ + displayName?: string | null; + /** + * Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+ + */ + name?: string | null; + /** + * Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code. + */ + regionCode?: string | null; + /** + * Output only. Approval state of the account. + */ + state?: string | null; + /** + * Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts. + */ + timeZone?: Schema$TimeZone; + } + /** + * Address data. + */ + export interface Schema$Address { + /** + * First line of address. Max length 64 bytes or 30 characters. + */ + address1?: string | null; + /** + * Second line of address. Max length 64 bytes or 30 characters. + */ + address2?: string | null; + /** + * City. Max length 60 bytes or 30 characters. + */ + city?: string | null; + /** + * Name of the company. Max length 255 bytes or 34 characters. + */ + company?: string | null; + /** + * Contact name of the company. Max length 128 bytes or 34 characters. + */ + contact?: string | null; + /** + * Fax number with international code (i.e. +441234567890). + */ + fax?: string | null; + /** + * Phone number with international code (i.e. +441234567890). + */ + phone?: string | null; + /** + * Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR"). + */ + regionCode?: string | null; + /** + * State. Max length 60 bytes or 30 characters. + */ + state?: string | null; + /** + * Zip/post code. Max length 10 bytes or 10 characters. + */ + zip?: string | null; + } + /** + * Request definition for the account close rpc. + */ + export interface Schema$CloseAccountRequest {} + /** + * Response definition for the account close rpc. + */ + export interface Schema$CloseAccountResponse {} + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * A platform sub-account event to record spam signals. + */ + export interface Schema$Event { + /** + * Required. Information associated with the event. + */ + eventInfo?: Schema$EventInfo; + /** + * Required. Event timestamp. + */ + eventTime?: string | null; + /** + * Required. Event type. + */ + eventType?: string | null; + } + /** + * Private information for partner recorded events (PII). + */ + export interface Schema$EventInfo { + /** + * The billing address of the publisher associated with this event, if available. + */ + billingAddress?: Schema$Address; + /** + * Required. The email address that is associated with the publisher when performing the event. + */ + email?: string | null; + } + /** + * Response definition for the list accounts rpc. + */ + export interface Schema$ListAccountsResponse { + /** + * The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`. + */ + accounts?: Schema$Account[]; + /** + * Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this. + */ + nextPageToken?: string | null; + } + /** + * Response definition for the site list rpc. + */ + export interface Schema$ListSitesResponse { + /** + * Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this. + */ + nextPageToken?: string | null; + /** + * The sites returned in this list response. + */ + sites?: Schema$Site[]; + } + /** + * Response definition for the lookup account rpc. + */ + export interface Schema$LookupAccountResponse { + /** + * The name of the Account Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string | null; + } + /** + * Response definition for the site request review rpc. + */ + export interface Schema$RequestSiteReviewResponse {} + /** + * Representation of a Site. + */ + export interface Schema$Site { + /** + * Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters. + */ + domain?: string | null; + /** + * Output only. Resource name of a site. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string | null; + /** + * Output only. State of a site. + */ + state?: string | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone, e.g. "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number, e.g. "2019a". + */ + version?: string | null; + } + + export class Resource$Platforms { + context: APIRequestContext; + accounts: Resource$Platforms$Accounts; + constructor(context: APIRequestContext) { + this.context = context; + this.accounts = new Resource$Platforms$Accounts(this.context); + } + } + + export class Resource$Platforms$Accounts { + context: APIRequestContext; + events: Resource$Platforms$Accounts$Events; + sites: Resource$Platforms$Accounts$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.events = new Resource$Platforms$Accounts$Events(this.context); + this.sites = new Resource$Platforms$Accounts$Sites(this.context); + } + + /** + * Closes a sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + close( + params: Params$Resource$Platforms$Accounts$Close, + options: StreamMethodOptions + ): GaxiosPromise; + close( + params?: Params$Resource$Platforms$Accounts$Close, + options?: MethodOptions + ): GaxiosPromise; + close( + params: Params$Resource$Platforms$Accounts$Close, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + close( + params: Params$Resource$Platforms$Accounts$Close, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + close( + params: Params$Resource$Platforms$Accounts$Close, + callback: BodyResponseCallback + ): void; + close(callback: BodyResponseCallback): void; + close( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Close + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Close; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Close; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:close').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/accounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets information about the selected sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Platforms$Accounts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Platforms$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platforms$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists a partial view of sub-accounts for a specific parent account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Platforms$Accounts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Platforms$Accounts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platforms$Accounts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/accounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: StreamMethodOptions + ): GaxiosPromise; + lookup( + params?: Params$Resource$Platforms$Accounts$Lookup, + options?: MethodOptions + ): GaxiosPromise; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookup( + params: Params$Resource$Platforms$Accounts$Lookup, + callback: BodyResponseCallback + ): void; + lookup(callback: BodyResponseCallback): void; + lookup( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Lookup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Lookup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Lookup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/accounts:lookup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Close + extends StandardParameters { + /** + * Required. Account to close. Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloseAccountRequest; + } + export interface Params$Resource$Platforms$Accounts$Create + extends StandardParameters { + /** + * Required. Platform to create an account for. Format: platforms/{platform\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } + export interface Params$Resource$Platforms$Accounts$Get + extends StandardParameters { + /** + * Required. Account to get information about. Format: platforms/{platform\}/accounts/{account_id\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$List + extends StandardParameters { + /** + * Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Platform who parents the accounts. Format: platforms/{platform\} + */ + parent?: string; + } + export interface Params$Resource$Platforms$Accounts$Lookup + extends StandardParameters { + /** + * Optional. The creation_request_id provided when calling createAccount. + */ + creationRequestId?: string; + /** + * Required. Platform who parents the account. Format: platforms/{platform\} + */ + parent?: string; + } + + export class Resource$Platforms$Accounts$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an account event. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Events$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Events$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Events$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Events$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Events$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Events$Create + extends StandardParameters { + /** + * Required. Account to log events about. Format: platforms/{platform\}/accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Event; + } + + export class Resource$Platforms$Accounts$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a site for a specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Platforms$Accounts$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Platforms$Accounts$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/sites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a specified account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Platforms$Accounts$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Platforms$Accounts$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a site from a specified sub-account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Platforms$Accounts$Sites$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Platforms$Accounts$Sites$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites for a specific account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Platforms$Accounts$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Platforms$Accounts$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/sites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: StreamMethodOptions + ): GaxiosPromise; + requestReview( + params?: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options?: MethodOptions + ): GaxiosPromise; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + requestReview( + params: Params$Resource$Platforms$Accounts$Sites$Requestreview, + callback: BodyResponseCallback + ): void; + requestReview( + callback: BodyResponseCallback + ): void; + requestReview( + paramsOrCallback?: + | Params$Resource$Platforms$Accounts$Sites$Requestreview + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Platforms$Accounts$Sites$Requestreview; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Platforms$Accounts$Sites$Requestreview; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://adsenseplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:requestReview').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Platforms$Accounts$Sites$Create + extends StandardParameters { + /** + * Required. Account to create site. Format: platforms/{platform\}/accounts/{account_id\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Platforms$Accounts$Sites$Delete + extends StandardParameters { + /** + * Required. The name of the site to delete. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$Get + extends StandardParameters { + /** + * Required. The name of the site to retrieve. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$List + extends StandardParameters { + /** + * The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The account which owns the sites. Format: platforms/{platform\}/accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Platforms$Accounts$Sites$Requestreview + extends StandardParameters { + /** + * Required. The name of the site to submit for review. Format: platforms/{platform\}/accounts/{account\}/sites/{site\} + */ + name?: string; + } +} diff --git a/src/apis/adsenseplatform/webpack.config.js b/src/apis/adsenseplatform/webpack.config.js new file mode 100644 index 0000000000..f643dae195 --- /dev/null +++ b/src/apis/adsenseplatform/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Adsenseplatform', + filename: 'adsenseplatform.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index a284d57744..2c2e46f266 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -142,10 +142,6 @@ export namespace aiplatform_v1 { * Returns rai failure reasons if any. */ raiMediaFilteredReasons?: string[] | null; - /** - * Billable prediction metrics. - */ - reportingMetrics?: Schema$IntelligenceCloudAutomlXpsReportingMetrics; } /** * Image. @@ -155,6 +151,10 @@ export namespace aiplatform_v1 { * Image encoding, encoded as "image/png" or "image/jpg". */ encoding?: string | null; + /** + * Generation seed for the sampled image. This parameter is exposed to the user only if one of the following is true: 1. The user specified per-example seeds in the request. 2. The user doesn't specify the generation seed in the request. + */ + generationSeed?: number | null; /** * Raw bytes. */ @@ -905,6 +905,14 @@ export namespace aiplatform_v1 { * Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models. */ resourcesConsumed?: Schema$GoogleCloudAiplatformV1ResourcesConsumed; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account. */ @@ -1140,7 +1148,12 @@ export namespace aiplatform_v1 { /** * Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. */ - export interface Schema$GoogleCloudAiplatformV1BleuSpec {} + export interface Schema$GoogleCloudAiplatformV1BleuSpec { + /** + * Optional. Whether to use_effective_order to compute bleu score. + */ + useEffectiveOrder?: boolean | null; + } /** * Content blob. It's preferred to send as text directly rather than raw bytes. */ @@ -1208,6 +1221,10 @@ export namespace aiplatform_v1 { * A response candidate generated from the model. */ export interface Schema$GoogleCloudAiplatformV1Candidate { + /** + * Output only. Average log probability score of the candidate. + */ + avgLogprobs?: number | null; /** * Output only. Source attribution of the generated content. */ @@ -1396,9 +1413,17 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1ComputeTokensRequest { /** - * Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + * Optional. Input content. + */ + contents?: Schema$GoogleCloudAiplatformV1Content[]; + /** + * Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. */ instances?: any[] | null; + /** + * Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project\}/locations/{location\}/publishers/x/models/x + */ + model?: string | null; } /** * Response message for ComputeTokens RPC call. @@ -1549,17 +1574,25 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1CountTokensRequest { /** - * Required. Input content. + * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1Content[]; /** - * Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ instances?: any[] | null; /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ model?: string | null; + /** + * Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + */ + systemInstruction?: Schema$GoogleCloudAiplatformV1Content; + /** + * Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + */ + tools?: Schema$GoogleCloudAiplatformV1Tool[]; } /** * Response message for PredictionService.CountTokens. @@ -1725,6 +1758,19 @@ export namespace aiplatform_v1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } + /** + * Metadata information for NotebookService.CreateNotebookExecutionJob. + */ + export interface Schema$GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata { + /** + * The operation generic information. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; + /** + * A human-readable message that shows the intermediate progress details of NotebookRuntime. + */ + progressMessage?: string | null; + } /** * Metadata information for NotebookService.CreateNotebookRuntimeTemplate. */ @@ -1879,6 +1925,14 @@ export namespace aiplatform_v1 { * Output only. Resource name of a CustomJob. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -1981,6 +2035,14 @@ export namespace aiplatform_v1 { * Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field. */ payload?: any | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this DataItem was last updated. */ @@ -2129,9 +2191,17 @@ export namespace aiplatform_v1 { */ modelReference?: string | null; /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. */ @@ -2170,9 +2240,17 @@ export namespace aiplatform_v1 { */ modelReference?: string | null; /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this DatasetVersion was last updated. */ @@ -2198,6 +2276,10 @@ export namespace aiplatform_v1 { * Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. */ minReplicaCount?: number | null; + /** + * Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). + */ + spot?: boolean | null; } /** * Details of operations that delete Feature values. @@ -2529,6 +2611,14 @@ export namespace aiplatform_v1 { * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. */ @@ -2662,6 +2752,14 @@ export namespace aiplatform_v1 { * Output only. Timestamp when this Endpoint was created. */ createTime?: string | null; + /** + * Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id\}.{region\}-{project_number\}.prediction.vertexai.goog`. + */ + dedicatedEndpointDns?: string | null; + /** + * If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region\}-aiplatform.googleapis.com. The limitation will be removed soon. + */ + dedicatedEndpointEnabled?: boolean | null; /** * Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. */ @@ -2710,6 +2808,14 @@ export namespace aiplatform_v1 { * Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. */ privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1PrivateServiceConnectConfig; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */ @@ -2764,6 +2870,14 @@ export namespace aiplatform_v1 { * Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. */ offlineStorageTtlDays?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this EntityType was most recently updated. */ @@ -2890,6 +3004,10 @@ export namespace aiplatform_v1 { * Input for groundedness metric. */ groundednessInput?: Schema$GoogleCloudAiplatformV1GroundednessInput; + /** + * Input for pairwise metric. + */ + pairwiseMetricInput?: Schema$GoogleCloudAiplatformV1PairwiseMetricInput; /** * Input for pairwise question answering quality metric. */ @@ -2898,6 +3016,10 @@ export namespace aiplatform_v1 { * Input for pairwise summarization quality metric. */ pairwiseSummarizationQualityInput?: Schema$GoogleCloudAiplatformV1PairwiseSummarizationQualityInput; + /** + * Input for pointwise metric. + */ + pointwiseMetricInput?: Schema$GoogleCloudAiplatformV1PointwiseMetricInput; /** * Input for question answering correctness metric. */ @@ -2979,6 +3101,10 @@ export namespace aiplatform_v1 { * Result for groundedness metric. */ groundednessResult?: Schema$GoogleCloudAiplatformV1GroundednessResult; + /** + * Result for pairwise metric. + */ + pairwiseMetricResult?: Schema$GoogleCloudAiplatformV1PairwiseMetricResult; /** * Result for pairwise question answering quality metric. */ @@ -2987,6 +3113,10 @@ export namespace aiplatform_v1 { * Result for pairwise summarization quality metric. */ pairwiseSummarizationQualityResult?: Schema$GoogleCloudAiplatformV1PairwiseSummarizationQualityResult; + /** + * Generic metrics. Result for pointwise metric. + */ + pointwiseMetricResult?: Schema$GoogleCloudAiplatformV1PointwiseMetricResult; /** * Result for question answering correctness metric. */ @@ -3869,6 +3999,16 @@ export namespace aiplatform_v1 { * Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */ entityIdColumns?: string[] | null; + /** + * Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + */ + timeSeries?: Schema$GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries; + } + export interface Schema$GoogleCloudAiplatformV1FeatureGroupBigQueryTimeSeries { + /** + * Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + */ + timestampColumn?: string | null; } /** * A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending. @@ -3941,6 +4081,14 @@ export namespace aiplatform_v1 { * Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. */ optimized?: Schema$GoogleCloudAiplatformV1FeatureOnlineStoreOptimized; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. State of the featureOnlineStore. */ @@ -3974,10 +4122,18 @@ export namespace aiplatform_v1 { * The dedicated serving endpoint for this FeatureOnlineStore. Only need to set when you choose Optimized storage type. Public endpoint is provisioned by default. */ export interface Schema$GoogleCloudAiplatformV1FeatureOnlineStoreDedicatedServingEndpoint { + /** + * Optional. Private service connect config. The private service connection is available only for Optimized storage type, not for embedding management now. If PrivateServiceConnectConfig.enable_private_service_connect set to true, customers will use private service connection to send request. Otherwise, the connection will set to public endpoint. + */ + privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1PrivateServiceConnectConfig; /** * Output only. This field will be populated with the domain name to use for this FeatureOnlineStore */ publicEndpointDomainName?: string | null; + /** + * Output only. The name of the service attachment resource. Populated if private service connect is enabled and after FeatureViewSync is created. + */ + serviceAttachment?: string | null; } /** * Optimized storage type @@ -4057,6 +4213,14 @@ export namespace aiplatform_v1 { * Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days */ onlineStorageTtlDays?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. State of the featurestore. */ @@ -4272,6 +4436,14 @@ export namespace aiplatform_v1 { * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. */ @@ -4405,6 +4577,14 @@ export namespace aiplatform_v1 { * Output only. Time when this FeatureViewSync is finished. */ runTime?: Schema$GoogleTypeInterval; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Summary of the sync job. */ @@ -4871,7 +5051,7 @@ export namespace aiplatform_v1 { */ candidatesTokenCount?: number | null; /** - * Number of tokens in the request. + * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */ promptTokenCount?: number | null; totalTokenCount?: number | null; @@ -4904,6 +5084,14 @@ export namespace aiplatform_v1 { * Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */ responseSchema?: Schema$GoogleCloudAiplatformV1Schema; + /** + * Optional. Routing configuration. + */ + routingConfig?: Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfig; + /** + * Optional. Seed. + */ + seed?: number | null; /** * Optional. Stop sequences. */ @@ -4921,6 +5109,37 @@ export namespace aiplatform_v1 { */ topP?: number | null; } + /** + * Routing config. + */ + export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfig { + /** + * Automated routing. + */ + autoMode?: Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode; + /** + * Manual routing. + */ + manualMode?: Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode; + } + /** + * When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. + */ + export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigAutoRoutingMode { + /** + * The model routing preference. + */ + modelRoutingPreference?: string | null; + } + /** + * When manual routing is set, the specified model will be used directly. + */ + export interface Schema$GoogleCloudAiplatformV1GenerationConfigRoutingConfigManualRoutingMode { + /** + * The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. + */ + modelName?: string | null; + } /** * Generic Metadata shared by all operations. */ @@ -5003,10 +5222,57 @@ export namespace aiplatform_v1 { */ version?: number | null; } + /** + * Grounding chunk. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingChunk { + /** + * Grounding chunk from context retrieved by the retrieval tools. + */ + retrievedContext?: Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext; + /** + * Grounding chunk from the web. + */ + web?: Schema$GoogleCloudAiplatformV1GroundingChunkWeb; + } + /** + * Chunk from context retrieved by the retrieval tools. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingChunkRetrievedContext { + /** + * Title of the attribution. + */ + title?: string | null; + /** + * URI reference of the attribution. + */ + uri?: string | null; + } + /** + * Chunk from the web. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingChunkWeb { + /** + * Title of the chunk. + */ + title?: string | null; + /** + * URI reference of the chunk. + */ + uri?: string | null; + } /** * Metadata returned to client when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1GroundingMetadata { + /** + * List of supporting references retrieved from specified grounding source. + */ + groundingChunks?: Schema$GoogleCloudAiplatformV1GroundingChunk[]; + /** + * Optional. List of grounding support. + */ + groundingSupports?: Schema$GoogleCloudAiplatformV1GroundingSupport[]; /** * Optional. Google search entry for the following-up web searches. */ @@ -5016,6 +5282,23 @@ export namespace aiplatform_v1 { */ webSearchQueries?: string[] | null; } + /** + * Grounding support. + */ + export interface Schema$GoogleCloudAiplatformV1GroundingSupport { + /** + * Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices. + */ + confidenceScores?: number[] | null; + /** + * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + */ + groundingChunkIndices?: number[] | null; + /** + * Segment of the content this support belongs to. + */ + segment?: Schema$GoogleCloudAiplatformV1Segment; + } /** * Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification. */ @@ -5060,6 +5343,14 @@ export namespace aiplatform_v1 { * Required. The desired number of Trials to run in parallel. */ parallelTrialCount?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -5301,6 +5592,14 @@ export namespace aiplatform_v1 { * Output only. The resource name of the Index. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. */ @@ -5455,6 +5754,14 @@ export namespace aiplatform_v1 { * Optional. If true, the deployed index will be accessible through public endpoint. */ publicEndpointEnabled?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. */ @@ -6002,6 +6309,19 @@ export namespace aiplatform_v1 { */ nextPageToken?: string | null; } + /** + * Response message for [NotebookService.CreateNotebookExecutionJob] + */ + export interface Schema$GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse { + /** + * A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page. + */ + nextPageToken?: string | null; + /** + * List of NotebookExecutionJobs in the requested page. + */ + notebookExecutionJobs?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob[]; + } /** * Response message for NotebookService.ListNotebookRuntimes. */ @@ -6232,6 +6552,10 @@ export namespace aiplatform_v1 { * Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */ machineType?: string | null; + /** + * Optional. Immutable. Configuration controlling how this resource pool consumes reservation. + */ + reservationAffinity?: Schema$GoogleCloudAiplatformV1ReservationAffinity; /** * Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). */ @@ -6654,6 +6978,14 @@ export namespace aiplatform_v1 { * The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain. */ predictSchemata?: Schema$GoogleCloudAiplatformV1PredictSchemata; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. */ @@ -6895,6 +7227,14 @@ export namespace aiplatform_v1 { * Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. */ samplePredictInstance?: any | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Schedule state when the monitoring job is in Running state. */ @@ -7452,6 +7792,14 @@ export namespace aiplatform_v1 { * Required. The specification of a NasJob. */ nasJobSpec?: Schema$GoogleCloudAiplatformV1NasJobSpec; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -7638,6 +7986,10 @@ export namespace aiplatform_v1 { * Optional. The number of similar entities to be retrieved from feature view for each query. */ neighborCount?: number | null; + /** + * Optional. The list of numeric filters. + */ + numericFilters?: Schema$GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter[]; /** * Optional. Parameters that can be set to tune query on the fly. */ @@ -7660,6 +8012,31 @@ export namespace aiplatform_v1 { */ value?: number[] | null; } + /** + * Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42\} {name: “b” value_float: 1.0\} Database Point 1: {name: “a” value_int: 10\} {name: “b” value_float: 2.0\} Database Point 2: {name: “a” value_int: -1\} {name: “b” value_float: 3.0\} Query: {name: “a” value_int: 12 operator: LESS\} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL\} // Matches Point 1 + */ + export interface Schema$GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter { + /** + * Required. Column name in BigQuery that used as filters. + */ + name?: string | null; + /** + * Optional. This MUST be specified for queries and must NOT be specified for database points. + */ + op?: string | null; + /** + * double value type. + */ + valueDouble?: number | null; + /** + * float value type. + */ + valueFloat?: number | null; + /** + * int value type. + */ + valueInt?: string | null; + } /** * Parameters that can be overrided in each query to tune query latency and recall. */ @@ -7837,6 +8214,114 @@ export namespace aiplatform_v1 { */ eucDisabled?: boolean | null; } + /** + * NotebookExecutionJob represents an instance of a notebook execution. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJob { + /** + * Output only. Timestamp when this NotebookExecutionJob was created. + */ + createTime?: string | null; + /** + * The Dataform Repository pointing to a single file notebook repository. + */ + dataformRepositorySource?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource; + /** + * The contents of an input notebook file. + */ + directNotebookSource?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource; + /** + * The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. + */ + displayName?: string | null; + /** + * Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1EncryptionSpec; + /** + * Max running time of the execution job in seconds (default 86400s / 24 hrs). + */ + executionTimeout?: string | null; + /** + * The user email to run the execution as. Only supported by Colab runtimes. + */ + executionUser?: string | null; + /** + * The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb` + */ + gcsNotebookSource?: Schema$GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource; + /** + * The Cloud Storage location to upload the result to. Format: `gs://bucket-name` + */ + gcsOutputUri?: string | null; + /** + * Output only. The state of the NotebookExecutionJob. + */ + jobState?: string | null; + /** + * The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id\}/locations/{location\}/notebookExecutionJobs/{job_id\}` + */ + name?: string | null; + /** + * The NotebookRuntimeTemplate to source compute configuration from. + */ + notebookRuntimeTemplateResourceName?: string | null; + /** + * Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id\}/locations/{location\}/schedules/{schedule_id\}` + */ + scheduleResourceName?: string | null; + /** + * The service account to run the execution as. + */ + serviceAccount?: string | null; + /** + * Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated. + */ + status?: Schema$GoogleRpcStatus; + /** + * Output only. Timestamp when this NotebookExecutionJob was most recently updated. + */ + updateTime?: string | null; + } + /** + * The Dataform Repository containing the input notebook. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource { + /** + * The commit SHA to read repository with. If unset, the file will be read at HEAD. + */ + commitSha?: string | null; + /** + * The resource name of the Dataform Repository. Format: `projects/{project_id\}/locations/{location\}/repositories/{repository_id\}` + */ + dataformRepositoryResourceName?: string | null; + } + /** + * The content of the input notebook in ipynb format. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource { + /** + * The base64-encoded contents of the input notebook file. + */ + content?: string | null; + } + /** + * The Cloud Storage uri for the input notebook. + */ + export interface Schema$GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource { + /** + * The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number. + */ + generation?: string | null; + /** + * The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb` + */ + uri?: string | null; + } /** * The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field. */ @@ -8025,6 +8510,50 @@ export namespace aiplatform_v1 { */ notebookRuntimeTemplate?: string | null; } + /** + * Input for pairwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1PairwiseMetricInput { + /** + * Required. Pairwise metric instance. + */ + instance?: Schema$GoogleCloudAiplatformV1PairwiseMetricInstance; + /** + * Required. Spec for pairwise metric. + */ + metricSpec?: Schema$GoogleCloudAiplatformV1PairwiseMetricSpec; + } + /** + * Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. + */ + export interface Schema$GoogleCloudAiplatformV1PairwiseMetricInstance { + /** + * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. + */ + jsonInstance?: string | null; + } + /** + * Spec for pairwise metric result. + */ + export interface Schema$GoogleCloudAiplatformV1PairwiseMetricResult { + /** + * Output only. Explanation for pairwise metric score. + */ + explanation?: string | null; + /** + * Output only. Pairwise metric choice. + */ + pairwiseChoice?: string | null; + } + /** + * Spec for pairwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1PairwiseMetricSpec { + /** + * Required. Metric prompt template for pairwise metric. + */ + metricPromptTemplate?: string | null; + } /** * Input for pairwise question answering quality metric. */ @@ -8559,6 +9088,50 @@ export namespace aiplatform_v1 { */ version?: string | null; } + /** + * Input for pointwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1PointwiseMetricInput { + /** + * Required. Pointwise metric instance. + */ + instance?: Schema$GoogleCloudAiplatformV1PointwiseMetricInstance; + /** + * Required. Spec for pointwise metric. + */ + metricSpec?: Schema$GoogleCloudAiplatformV1PointwiseMetricSpec; + } + /** + * Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. + */ + export interface Schema$GoogleCloudAiplatformV1PointwiseMetricInstance { + /** + * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. + */ + jsonInstance?: string | null; + } + /** + * Spec for pointwise metric result. + */ + export interface Schema$GoogleCloudAiplatformV1PointwiseMetricResult { + /** + * Output only. Explanation for pointwise metric score. + */ + explanation?: string | null; + /** + * Output only. Pointwise metric score. + */ + score?: number | null; + } + /** + * Spec for pointwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1PointwiseMetricSpec { + /** + * Required. Metric prompt template for pointwise metric. + */ + metricPromptTemplate?: string | null; + } /** * Represents a network port in a container. */ @@ -8699,6 +9272,10 @@ export namespace aiplatform_v1 { * A list of Projects from which the forwarding rule will target the service attachment. */ projectAllowlist?: string[] | null; + /** + * Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. + */ + serviceAttachment?: string | null; } /** * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. @@ -8861,6 +9438,10 @@ export namespace aiplatform_v1 { * A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. */ dedicatedResources?: Schema$GoogleCloudAiplatformV1DedicatedResources; + /** + * Optional. Metadata information about this deployment config. + */ + deployMetadata?: Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata; /** * Optional. The name of the deploy task (e.g., "text to image generation"). */ @@ -8886,6 +9467,19 @@ export namespace aiplatform_v1 { */ title?: string | null; } + /** + * Metadata information about the deployment for managing deployment config. + */ + export interface Schema$GoogleCloudAiplatformV1PublisherModelCallToActionDeployDeployMetadata { + /** + * Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. Sample request for deployed endpoint. + */ + sampleRequest?: string | null; + } /** * Configurations for PublisherModel GKE deployment */ @@ -9409,6 +10003,15 @@ export namespace aiplatform_v1 { */ httpBody?: Schema$GoogleApiHttpBody; } + /** + * Configuration for the Ray OSS Logs. + */ + export interface Schema$GoogleCloudAiplatformV1RayLogsSpec { + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + */ + disabled?: boolean | null; + } /** * Configuration for the Ray metrics. */ @@ -9430,6 +10033,10 @@ export namespace aiplatform_v1 { * Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images\} field. */ imageUri?: string | null; + /** + * Optional. OSS Ray logging configurations. + */ + rayLogsSpec?: Schema$GoogleCloudAiplatformV1RayLogsSpec; /** * Optional. Ray metrics configurations. */ @@ -9640,12 +10247,29 @@ export namespace aiplatform_v1 { * Response message for IndexService.RemoveDatapoints */ export interface Schema$GoogleCloudAiplatformV1RemoveDatapointsResponse {} + /** + * A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. + */ + export interface Schema$GoogleCloudAiplatformV1ReservationAffinity { + /** + * Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + */ + key?: string | null; + /** + * Required. Specifies the reservation affinity type. + */ + reservationAffinityType?: string | null; + /** + * Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation. + */ + values?: string[] | null; + } /** * Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource. */ export interface Schema$GoogleCloudAiplatformV1ResourcePool { /** - * Optional. Optional spec to configure GKE autoscaling + * Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling */ autoscalingSpec?: Schema$GoogleCloudAiplatformV1ResourcePoolAutoscalingSpec; /** @@ -9678,7 +10302,7 @@ export namespace aiplatform_v1 { */ maxReplicaCount?: string | null; /** - * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error + * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be \> 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java. */ minReplicaCount?: string | null; } @@ -9740,7 +10364,7 @@ export namespace aiplatform_v1 { */ export interface Schema$GoogleCloudAiplatformV1Retrieval { /** - * Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + * Optional. Deprecated. This option is no longer supported. */ disableAttribution?: boolean | null; /** @@ -10103,6 +10727,10 @@ export namespace aiplatform_v1 { * Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. */ restartJobOnWorkerRestart?: boolean | null; + /** + * Optional. This determines which type of scheduling strategy to use. + */ + strategy?: string | null; /** * The maximum job running time. The default is 7 days. */ @@ -12945,6 +13573,27 @@ export namespace aiplatform_v1 { */ nearestNeighbors?: Schema$GoogleCloudAiplatformV1NearestNeighbors; } + /** + * Segment of the content. + */ + export interface Schema$GoogleCloudAiplatformV1Segment { + /** + * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + */ + endIndex?: number | null; + /** + * Output only. The index of a Part object within its parent Content object. + */ + partIndex?: number | null; + /** + * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + */ + startIndex?: number | null; + /** + * Output only. The text corresponding to the segment from the response. + */ + text?: string | null; + } /** * Configuration for the use of custom service account to run the workloads. */ @@ -13732,6 +14381,10 @@ export namespace aiplatform_v1 { * Dataset distribution for Supervised Tuning. */ export interface Schema$GoogleCloudAiplatformV1SupervisedTuningDatasetDistribution { + /** + * Output only. Sum of a given population of values that are billable. + */ + billableSum?: string | null; /** * Output only. Defines the histogram bucket. */ @@ -13790,6 +14443,10 @@ export namespace aiplatform_v1 { * Output only. Number of billable characters in the tuning dataset. */ totalBillableCharacterCount?: string | null; + /** + * Output only. Number of billable tokens in the tuning dataset. + */ + totalBillableTokenCount?: string | null; /** * Output only. Number of tuning characters in the tuning dataset. */ @@ -13954,6 +14611,14 @@ export namespace aiplatform_v1 { * Output only. The number of Runs stored in this Tensorboard. */ runCount?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this Tensorboard was last updated. */ @@ -14211,6 +14876,10 @@ export namespace aiplatform_v1 { * Tokens info with a list of tokens and the corresponding list of token ids. */ export interface Schema$GoogleCloudAiplatformV1TokensInfo { + /** + * Optional. Optional fields for the role from the corresponding Content. + */ + role?: string | null; /** * A list of token ids from the input. */ @@ -14578,9 +15247,6 @@ export namespace aiplatform_v1 { */ webAccessUris?: {[key: string]: string} | null; } - /** - * Next ID: 3 - */ export interface Schema$GoogleCloudAiplatformV1TrialContext { /** * A human-readable field which can store a description of this context. This will become part of the resulting Trial's description field. @@ -15368,48 +16034,6 @@ export namespace aiplatform_v1 { */ units?: string | null; } - export interface Schema$IntelligenceCloudAutomlXpsMetricEntry { - /** - * For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise leave empty. - */ - argentumMetricId?: string | null; - /** - * A double value. - */ - doubleValue?: number | null; - /** - * A signed 64-bit integer value. - */ - int64Value?: string | null; - /** - * The metric name defined in the service configuration. - */ - metricName?: string | null; - /** - * Billing system labels for this (metric, value) pair. - */ - systemLabels?: Schema$IntelligenceCloudAutomlXpsMetricEntryLabel[]; - } - export interface Schema$IntelligenceCloudAutomlXpsMetricEntryLabel { - /** - * The name of the label. - */ - labelName?: string | null; - /** - * The value of the label. - */ - labelValue?: string | null; - } - export interface Schema$IntelligenceCloudAutomlXpsReportingMetrics { - /** - * The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set. - */ - effectiveTrainingDuration?: string | null; - /** - * One entry per metric name. The values must be aggregated per metric name. - */ - metricEntries?: Schema$IntelligenceCloudAutomlXpsMetricEntry[]; - } export class Resource$Projects { context: APIRequestContext; @@ -19387,7 +20011,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Datasets$Patch extends StandardParameters { /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. */ name?: string; /** @@ -22063,7 +22687,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch extends StandardParameters { /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. */ name?: string; /** @@ -23757,6 +24381,99 @@ export namespace aiplatform_v1 { } } + /** + * Update a DeploymentResourcePool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * List DeployedModels that have been deployed on this DeploymentResourcePool. * @@ -23896,6 +24613,22 @@ export namespace aiplatform_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DeploymentResourcePool; + } export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { /** @@ -27578,7 +28311,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` */ updateMask?: string; @@ -28143,7 +28876,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -29553,7 +30286,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config` + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` */ updateMask?: string; @@ -30425,7 +31158,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType` + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` */ updateMask?: string; @@ -34848,7 +35581,7 @@ export namespace aiplatform_v1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -51831,19 +52564,697 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists NasJobs in a Location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Nasjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/nasJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Nasjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1CancelNasJobRequest; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Create + extends StandardParameters { + /** + * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1NasJob; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Delete + extends StandardParameters { + /** + * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Get + extends StandardParameters { + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$List + extends StandardParameters { + /** + * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + */ + filter?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + + export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a NasTrialDetail. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * List top NasTrialDetails of a NasJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/nasTrialDetails').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get + extends StandardParameters { + /** + * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List + extends StandardParameters { + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + */ + pageToken?: string; + /** + * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Notebookexecutionjobs { + context: APIRequestContext; + operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Notebookexecutionjobs$Operations( + this.context + ); + } + + /** + * Creates a NotebookExecutionJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a NotebookExecutionJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a NotebookExecutionJob. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notebookexecutionjobs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists NasJobs in a Location. + * Lists NotebookExecutionJobs in a Location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -51851,56 +53262,57 @@ export namespace aiplatform_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Nasjobs$List, + params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Nasjobs$List, + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Nasjobs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Notebookexecutionjobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notebookexecutionjobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$List; + {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Nasjobs$List; + params = + {} as Params$Resource$Projects$Locations$Notebookexecutionjobs$List; options = {}; } @@ -51913,7 +53325,7 @@ export namespace aiplatform_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/nasJobs').replace( + url: (rootUrl + '/v1/{+parent}/notebookExecutionJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -51928,313 +53340,78 @@ export namespace aiplatform_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Nasjobs$Cancel + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Create extends StandardParameters { /** - * Required. The name of the NasJob to cancel. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` - */ - name?: string; - - /** - * Request body metadata + * Optional. User specified ID for the NotebookExecutionJob. */ - requestBody?: Schema$GoogleCloudAiplatformV1CancelNasJobRequest; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Create - extends StandardParameters { + notebookExecutionJobId?: string; /** - * Required. The resource name of the Location to create the NasJob in. Format: `projects/{project\}/locations/{location\}` + * Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project\}/locations/{location\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1NasJob; + requestBody?: Schema$GoogleCloudAiplatformV1NotebookExecutionJob; } - export interface Params$Resource$Projects$Locations$Nasjobs$Delete + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Delete extends StandardParameters { /** - * Required. The name of the NasJob resource to be deleted. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * Required. The name of the NotebookExecutionJob resource to be deleted. */ name?: string; } - export interface Params$Resource$Projects$Locations$Nasjobs$Get + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Get extends StandardParameters { /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * Required. The name of the NotebookExecutionJob resource. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Nasjobs$List - extends StandardParameters { /** - * The standard list filter. Supported fields: * `display_name` supports `=`, `!=` comparisons, and `:` wildcard. * `state` supports `=`, `!=` comparisons. * `create_time` supports `=`, `!=`,`<`, `<=`,`\>`, `\>=` comparisons. `create_time` must be in RFC 3339 format. * `labels` supports general map functions that is: `labels.key=value` - key:value equality `labels.key:* - key existence Some examples of using the filter are: * `state="JOB_STATE_SUCCEEDED" AND display_name:"my_job_*"` * `state!="JOB_STATE_FAILED" OR display_name="my_job"` * `NOT display_name="my_job"` * `create_time\>"2021-05-18T00:00:00Z"` * `labels.keyA=valueA` * `labels.keyB:*` + * Optional. The NotebookExecutionJob view. Defaults to BASIC. */ - filter?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. Typically obtained via ListNasJobsResponse.next_page_token of the previous JobService.ListNasJobs call. - */ - pageToken?: string; - /** - * Required. The resource name of the Location to list the NasJobs from. Format: `projects/{project\}/locations/{location\}` - */ - parent?: string; - /** - * Mask specifying which fields to read. - */ - readMask?: string; + view?: string; } - - export class Resource$Projects$Locations$Nasjobs$Nastrialdetails { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets a NasTrialDetail. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - + export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$List + extends StandardParameters { /** - * List top NasTrialDetails of a NasJob. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` */ - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/nasTrialDetails').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$Get - extends StandardParameters { + filter?: string; /** - * Required. The name of the NasTrialDetail resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}/nasTrialDetails/{nas_trial_detail\}` + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Nasjobs$Nastrialdetails$List - extends StandardParameters { + orderBy?: string; /** - * The standard list page size. + * Optional. The standard list page size. */ pageSize?: number; /** - * The standard list page token. Typically obtained via ListNasTrialDetailsResponse.next_page_token of the previous JobService.ListNasTrialDetails call. + * Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call. */ pageToken?: string; /** - * Required. The name of the NasJob resource. Format: `projects/{project\}/locations/{location\}/nasJobs/{nas_job\}` + * Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project\}/locations/{location\}` */ parent?: string; - } - - export class Resource$Projects$Locations$Notebookexecutionjobs { - context: APIRequestContext; - operations: Resource$Projects$Locations$Notebookexecutionjobs$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Notebookexecutionjobs$Operations( - this.context - ); - } + /** + * Optional. The NotebookExecutionJob view. Defaults to BASIC. + */ + view?: string; } export class Resource$Projects$Locations$Notebookexecutionjobs$Operations { @@ -71579,7 +72756,15 @@ export namespace aiplatform_v1 { export interface Params$Resource$Publishers$Models$Get extends StandardParameters { /** - * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47). + * Optional. Token used to access Hugging Face gated models. + */ + huggingFaceToken?: string; + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face model. + */ + isHuggingFaceModel?: boolean; + /** + * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. */ languageCode?: string; /** diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index 608ec0d889..ba94e9d495 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -144,10 +144,6 @@ export namespace aiplatform_v1beta1 { * Returns rai failure reasons if any. */ raiMediaFilteredReasons?: string[] | null; - /** - * Billable prediction metrics. - */ - reportingMetrics?: Schema$IntelligenceCloudAutomlXpsReportingMetrics; } /** * Image. @@ -157,6 +153,10 @@ export namespace aiplatform_v1beta1 { * Image encoding, encoded as "image/png" or "image/jpg". */ encoding?: string | null; + /** + * Generation seed for the sampled image. This parameter is exposed to the user only if one of the following is true: 1. The user specified per-example seeds in the request. 2. The user doesn't specify the generation seed in the request. + */ + generationSeed?: number | null; /** * Raw bytes. */ @@ -478,6 +478,15 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * The API secret. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig { + /** + * Required. The SecretManager secret version resource name storing API key. e.g. projects/{project\}/secrets/{secret\}/versions/{version\} + */ + apiKeySecretVersion?: string | null; + } /** * Instance of a general artifact. */ @@ -1027,6 +1036,14 @@ export namespace aiplatform_v1beta1 { * Output only. Information about resources that had been consumed by this job. Provided in real time at best effort basis, as well as a final value once the job completes. Note: This field currently may be not populated for batch predictions that use AutoML Models. */ resourcesConsumed?: Schema$GoogleCloudAiplatformV1beta1ResourcesConsumed; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * The service account that the DeployedModel's container runs as. If not specified, a system generated one will be used, which has minimal permissions and the custom container, if used, may not have enough permission to access other Google Cloud resources. Users deploying the Model must have the `iam.serviceAccounts.actAs` permission on this service account. */ @@ -1262,7 +1279,12 @@ export namespace aiplatform_v1beta1 { /** * Spec for bleu score metric - calculates the precision of n-grams in the prediction as compared to reference - returns a score ranging between 0 to 1. */ - export interface Schema$GoogleCloudAiplatformV1beta1BleuSpec {} + export interface Schema$GoogleCloudAiplatformV1beta1BleuSpec { + /** + * Optional. Whether to use_effective_order to compute bleu score. + */ + useEffectiveOrder?: boolean | null; + } /** * Content blob. It's preferred to send as text directly rather than raw bytes. */ @@ -1392,6 +1414,10 @@ export namespace aiplatform_v1beta1 { * A response candidate generated from the model. */ export interface Schema$GoogleCloudAiplatformV1beta1Candidate { + /** + * Output only. Average log probability score of the candidate. + */ + avgLogprobs?: number | null; /** * Output only. Source attribution of the generated content. */ @@ -1580,9 +1606,17 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1ComputeTokensRequest { /** - * Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + * Optional. Input content. + */ + contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. */ instances?: any[] | null; + /** + * Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project\}/locations/{location\}/publishers/x/models/x + */ + model?: string | null; } /** * Response message for ComputeTokens RPC call. @@ -1733,17 +1767,25 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1CountTokensRequest { /** - * Required. Input content. + * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; /** - * Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ instances?: any[] | null; /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ model?: string | null; + /** + * Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + */ + systemInstruction?: Schema$GoogleCloudAiplatformV1beta1Content; + /** + * Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + */ + tools?: Schema$GoogleCloudAiplatformV1beta1Tool[]; } /** * Response message for PredictionService.CountTokens. @@ -2137,6 +2179,14 @@ export namespace aiplatform_v1beta1 { * Output only. Resource name of a CustomJob. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -2239,6 +2289,14 @@ export namespace aiplatform_v1beta1 { * Required. The data that the DataItem represents (for example, an image or a text snippet). The schema of the payload is stored in the parent Dataset's metadata schema's dataItemSchemaUri field. */ payload?: any | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this DataItem was last updated. */ @@ -2387,9 +2445,17 @@ export namespace aiplatform_v1beta1 { */ modelReference?: string | null; /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. */ @@ -2399,6 +2465,97 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * Distribution computed over a tuning dataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DatasetDistribution { + /** + * Output only. Defines the histogram bucket. + */ + buckets?: Schema$GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket[]; + /** + * Output only. The maximum of the population values. + */ + max?: number | null; + /** + * Output only. The arithmetic mean of the values in the population. + */ + mean?: number | null; + /** + * Output only. The median of the values in the population. + */ + median?: number | null; + /** + * Output only. The minimum of the population values. + */ + min?: number | null; + /** + * Output only. The 5th percentile of the values in the population. + */ + p5?: number | null; + /** + * Output only. The 95th percentile of the values in the population. + */ + p95?: number | null; + /** + * Output only. Sum of a given population of values. + */ + sum?: number | null; + } + /** + * Dataset bucket used to create a histogram for the distribution given a population of values. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DatasetDistributionDistributionBucket { + /** + * Output only. Number of values in the bucket. + */ + count?: string | null; + /** + * Output only. Left bound of the bucket. + */ + left?: number | null; + /** + * Output only. Right bound of the bucket. + */ + right?: number | null; + } + /** + * Statistics computed over a tuning dataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DatasetStats { + /** + * Output only. Number of billable characters in the tuning dataset. + */ + totalBillableCharacterCount?: string | null; + /** + * Output only. Number of tuning characters in the tuning dataset. + */ + totalTuningCharacterCount?: string | null; + /** + * Output only. Number of examples in the tuning dataset. + */ + tuningDatasetExampleCount?: string | null; + /** + * Output only. Number of tuning steps for this Tuning Job. + */ + tuningStepCount?: string | null; + /** + * Output only. Sample user messages in the training dataset uri. + */ + userDatasetExamples?: Schema$GoogleCloudAiplatformV1beta1Content[]; + /** + * Output only. Dataset distributions for the user input tokens. + */ + userInputTokenDistribution?: Schema$GoogleCloudAiplatformV1beta1DatasetDistribution; + /** + * Output only. Dataset distributions for the messages per example. + */ + userMessagePerExampleDistribution?: Schema$GoogleCloudAiplatformV1beta1DatasetDistribution; + /** + * Output only. Dataset distributions for the user output tokens. + */ + userOutputTokenDistribution?: Schema$GoogleCloudAiplatformV1beta1DatasetDistribution; + } /** * Describes the dataset version. */ @@ -2428,9 +2585,17 @@ export namespace aiplatform_v1beta1 { */ modelReference?: string | null; /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this DatasetVersion was last updated. */ @@ -2456,6 +2621,10 @@ export namespace aiplatform_v1beta1 { * Required. Immutable. The minimum number of machine replicas this DeployedModel will be always deployed on. This value must be greater than or equal to 1. If traffic against the DeployedModel increases, it may dynamically be deployed onto more replicas, and as traffic decreases, some of these extra replicas may be freed. */ minReplicaCount?: number | null; + /** + * Optional. If true, schedule the deployment workload on [spot VMs](https://cloud.google.com/kubernetes-engine/docs/concepts/spot-vms). + */ + spot?: boolean | null; } /** * Details of operations that delete Feature values. @@ -2787,6 +2956,14 @@ export namespace aiplatform_v1beta1 { * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the `iam.serviceAccounts.actAs` permission on this service account. */ @@ -2907,6 +3084,65 @@ export namespace aiplatform_v1beta1 { */ bootDiskType?: string | null; } + /** + * Statistics computed for datasets used for distillation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DistillationDataStats { + /** + * Output only. Statistics computed for the training dataset. + */ + trainingDatasetStats?: Schema$GoogleCloudAiplatformV1beta1DatasetStats; + } + /** + * Hyperparameters for Distillation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DistillationHyperParameters { + /** + * Optional. Adapter size for distillation. + */ + adapterSize?: string | null; + /** + * Optional. Number of complete passes the model makes over the entire training dataset during training. + */ + epochCount?: string | null; + /** + * Optional. Multiplier for adjusting the default learning rate. + */ + learningRateMultiplier?: number | null; + } + /** + * Tuning Spec for Distillation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DistillationSpec { + /** + * The base teacher model that is being distilled, e.g., "gemini-1.0-pro-002". + */ + baseTeacherModel?: string | null; + /** + * Optional. Hyperparameters for Distillation. + */ + hyperParameters?: Schema$GoogleCloudAiplatformV1beta1DistillationHyperParameters; + /** + * Required. A path in a Cloud Storage bucket, which will be treated as the root output directory of the distillation pipeline. It is used by the system to generate the paths of output artifacts. + */ + pipelineRootDirectory?: string | null; + /** + * The student model that is being tuned, e.g., "google/gemma-2b-1.1-it". + */ + studentModel?: string | null; + /** + * Required. Cloud Storage path to file containing training dataset for tuning. The dataset must be formatted as a JSONL file. + */ + trainingDatasetUri?: string | null; + /** + * The resource name of the Tuned teacher model. Format: `projects/{project\}/locations/{location\}/models/{model\}`. + */ + tunedTeacherModelSource?: string | null; + /** + * Optional. Cloud Storage path to file containing validation dataset for tuning. The dataset must be formatted as a JSONL file. + */ + validationDatasetUri?: string | null; + } /** * A list of double values. */ @@ -2933,6 +3169,14 @@ export namespace aiplatform_v1beta1 { * Output only. Timestamp when this Endpoint was created. */ createTime?: string | null; + /** + * Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id\}.{region\}-{project_number\}.prediction.vertexai.goog`. + */ + dedicatedEndpointDns?: string | null; + /** + * If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region\}-aiplatform.googleapis.com. The limitation will be removed soon. + */ + dedicatedEndpointEnabled?: boolean | null; /** * Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. */ @@ -2981,6 +3225,14 @@ export namespace aiplatform_v1beta1 { * Optional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive. */ privateServiceConnectConfig?: Schema$GoogleCloudAiplatformV1beta1PrivateServiceConnectConfig; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * A map from a DeployedModel's ID to the percentage of this Endpoint's traffic that should be forwarded to that DeployedModel. If a DeployedModel's ID is not listed in this map, then it receives no traffic. The traffic percentage values must add up to 100, or map must be empty if the Endpoint is to not accept any traffic at a moment. */ @@ -3035,6 +3287,14 @@ export namespace aiplatform_v1beta1 { * Optional. Config for data retention policy in offline storage. TTL in days for feature values that will be stored in offline storage. The Feature Store offline storage periodically removes obsolete feature values older than `offline_storage_ttl_days` since the feature generation time. If unset (or explicitly set to 0), default to 4000 days TTL. */ offlineStorageTtlDays?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this EntityType was most recently updated. */ @@ -3161,6 +3421,10 @@ export namespace aiplatform_v1beta1 { * Input for groundedness metric. */ groundednessInput?: Schema$GoogleCloudAiplatformV1beta1GroundednessInput; + /** + * Input for pairwise metric. + */ + pairwiseMetricInput?: Schema$GoogleCloudAiplatformV1beta1PairwiseMetricInput; /** * Input for pairwise question answering quality metric. */ @@ -3169,6 +3433,10 @@ export namespace aiplatform_v1beta1 { * Input for pairwise summarization quality metric. */ pairwiseSummarizationQualityInput?: Schema$GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityInput; + /** + * Input for pointwise metric. + */ + pointwiseMetricInput?: Schema$GoogleCloudAiplatformV1beta1PointwiseMetricInput; /** * Input for question answering correctness metric. */ @@ -3250,6 +3518,10 @@ export namespace aiplatform_v1beta1 { * Result for groundedness metric. */ groundednessResult?: Schema$GoogleCloudAiplatformV1beta1GroundednessResult; + /** + * Result for pairwise metric. + */ + pairwiseMetricResult?: Schema$GoogleCloudAiplatformV1beta1PairwiseMetricResult; /** * Result for pairwise question answering quality metric. */ @@ -3258,6 +3530,10 @@ export namespace aiplatform_v1beta1 { * Result for pairwise summarization quality metric. */ pairwiseSummarizationQualityResult?: Schema$GoogleCloudAiplatformV1beta1PairwiseSummarizationQualityResult; + /** + * Generic metrics. Result for pointwise metric. + */ + pointwiseMetricResult?: Schema$GoogleCloudAiplatformV1beta1PointwiseMetricResult; /** * Result for question answering correctness metric. */ @@ -4269,6 +4545,16 @@ export namespace aiplatform_v1beta1 { * Optional. Columns to construct entity_id / row keys. If not provided defaults to `entity_id`. */ entityIdColumns?: string[] | null; + /** + * Optional. If the source is a time-series source, this can be set to control how downstream sources (ex: FeatureOnlineStore.FeatureView) will treat time series sources. If not set, will treat the source as a time-series source with feature_timestamp as timestamp column and no scan boundary. + */ + timeSeries?: Schema$GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries; + } + export interface Schema$GoogleCloudAiplatformV1beta1FeatureGroupBigQueryTimeSeries { + /** + * Optional. Column hosting timestamp values for a time-series source. Will be used to determine the latest featureValues for each entity. Optional. If not provided, a feature_timestamp column of type TIMESTAMP will be used. + */ + timestampColumn?: string | null; } /** * A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending. @@ -4345,6 +4631,14 @@ export namespace aiplatform_v1beta1 { * Contains settings for the Optimized store that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. When choose Optimized storage type, need to set PrivateServiceConnectConfig.enable_private_service_connect to use private endpoint. Otherwise will use public endpoint by default. */ optimized?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreOptimized; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. State of the featureOnlineStore. */ @@ -4478,6 +4772,14 @@ export namespace aiplatform_v1beta1 { * Optional. TTL in days for feature values that will be stored in online serving storage. The Feature Store online storage periodically removes obsolete feature values older than `online_storage_ttl_days` since the feature generation time. Note that `online_storage_ttl_days` should be less than or equal to `offline_storage_ttl_days` for each EntityType under a featurestore. If not set, default to 4000 days */ onlineStorageTtlDays?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. State of the featurestore. */ @@ -4697,6 +4999,14 @@ export namespace aiplatform_v1beta1 { * Identifier. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store. */ @@ -4842,6 +5152,14 @@ export namespace aiplatform_v1beta1 { * Output only. Time when this FeatureViewSync is finished. */ runTime?: Schema$GoogleTypeInterval; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Summary of the sync job. */ @@ -5394,11 +5712,28 @@ export namespace aiplatform_v1beta1 { */ candidatesTokenCount?: number | null; /** - * Number of tokens in the request. + * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */ promptTokenCount?: number | null; totalTokenCount?: number | null; } + /** + * Generate video response. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerateVideoResponse { + /** + * The cloud storage uris of the generated videos. + */ + generatedSamples?: string[] | null; + /** + * Returns if any videos were filtered due to RAI policies. + */ + raiMediaFilteredCount?: number | null; + /** + * Returns rai failure reasons if any. + */ + raiMediaFilteredReasons?: string[] | null; + } /** * Generation config. */ @@ -5427,6 +5762,14 @@ export namespace aiplatform_v1beta1 { * Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */ responseSchema?: Schema$GoogleCloudAiplatformV1beta1Schema; + /** + * Optional. Routing configuration. + */ + routingConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig; + /** + * Optional. Seed. + */ + seed?: number | null; /** * Optional. Stop sequences. */ @@ -5444,6 +5787,37 @@ export namespace aiplatform_v1beta1 { */ topP?: number | null; } + /** + * Routing config. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig { + /** + * Automated routing. + */ + autoMode?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode; + /** + * Manual routing. + */ + manualMode?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode; + } + /** + * When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode { + /** + * The model routing preference. + */ + modelRoutingPreference?: string | null; + } + /** + * When manual routing is set, the specified model will be used directly. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode { + /** + * The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. + */ + modelName?: string | null; + } /** * Generic Metadata shared by all operations. */ @@ -5548,10 +5922,57 @@ export namespace aiplatform_v1beta1 { */ version?: number | null; } + /** + * Grounding chunk. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunk { + /** + * Grounding chunk from context retrieved by the retrieval tools. + */ + retrievedContext?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext; + /** + * Grounding chunk from the web. + */ + web?: Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb; + } + /** + * Chunk from context retrieved by the retrieval tools. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext { + /** + * Title of the attribution. + */ + title?: string | null; + /** + * URI reference of the attribution. + */ + uri?: string | null; + } + /** + * Chunk from the web. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingChunkWeb { + /** + * Title of the chunk. + */ + title?: string | null; + /** + * URI reference of the chunk. + */ + uri?: string | null; + } /** * Metadata returned to client when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadata { + /** + * List of supporting references retrieved from specified grounding source. + */ + groundingChunks?: Schema$GoogleCloudAiplatformV1beta1GroundingChunk[]; + /** + * Optional. List of grounding support. + */ + groundingSupports?: Schema$GoogleCloudAiplatformV1beta1GroundingSupport[]; /** * Optional. Queries executed by the retrieval tools. */ @@ -5565,6 +5986,23 @@ export namespace aiplatform_v1beta1 { */ webSearchQueries?: string[] | null; } + /** + * Grounding support. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GroundingSupport { + /** + * Confidence score of the support references. Ranges from 0 to 1. 1 is the most confident. This list must have the same size as the grounding_chunk_indices. + */ + confidenceScores?: number[] | null; + /** + * A list of indices (into 'grounding_chunk') specifying the citations associated with the claim. For instance [1,3,4] means that grounding_chunk[1], grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to the claim. + */ + groundingChunkIndices?: number[] | null; + /** + * Segment of the content this support belongs to. + */ + segment?: Schema$GoogleCloudAiplatformV1beta1Segment; + } /** * Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification. */ @@ -5609,6 +6047,14 @@ export namespace aiplatform_v1beta1 { * Required. The desired number of Trials to run in parallel. */ parallelTrialCount?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -5819,6 +6265,10 @@ export namespace aiplatform_v1beta1 { * Google Drive location. Supports importing individual files as well as Google Drive folders. */ googleDriveSource?: Schema$GoogleCloudAiplatformV1beta1GoogleDriveSource; + /** + * Jira queries with their corresponding authentication. + */ + jiraSource?: Schema$GoogleCloudAiplatformV1beta1JiraSource; /** * Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used. */ @@ -5827,6 +6277,14 @@ export namespace aiplatform_v1beta1 { * Specifies the size and overlap of chunks after importing RagFiles. */ ragFileChunkingConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileChunkingConfig; + /** + * Specifies the parsing config for RagFiles. + */ + ragFileParsingConfig?: Schema$GoogleCloudAiplatformV1beta1RagFileParsingConfig; + /** + * Slack channels with their corresponding access tokens. + */ + slackSource?: Schema$GoogleCloudAiplatformV1beta1SlackSource; } /** * Request message for VertexRagDataService.ImportRagFiles. @@ -5889,6 +6347,14 @@ export namespace aiplatform_v1beta1 { * Output only. The resource name of the Index. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their Operations.metadata.generic_metadata.update_time a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it. */ @@ -6043,6 +6509,14 @@ export namespace aiplatform_v1beta1 { * Optional. If true, the deployed index will be accessible through public endpoint. */ publicEndpointEnabled?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of. */ @@ -6174,6 +6648,40 @@ export namespace aiplatform_v1beta1 { */ serviceState?: string | null; } + /** + * The Jira source for the ImportRagFilesRequest. + */ + export interface Schema$GoogleCloudAiplatformV1beta1JiraSource { + /** + * Required. The Jira queries. + */ + jiraQueries?: Schema$GoogleCloudAiplatformV1beta1JiraSourceJiraQueries[]; + } + /** + * JiraQueries contains the Jira queries and corresponding authentication. + */ + export interface Schema$GoogleCloudAiplatformV1beta1JiraSourceJiraQueries { + /** + * Required. The SecretManager secret version resource name (e.g. projects/{project\}/secrets/{secret\}/versions/{version\}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + */ + apiKeyConfig?: Schema$GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig; + /** + * A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + */ + customQueries?: string[] | null; + /** + * Required. The Jira email address. + */ + email?: string | null; + /** + * A list of Jira projects to import in their entirety. + */ + projects?: string[] | null; + /** + * Required. The Jira server URI. + */ + serverUri?: string | null; + } /** * Contains information about the Large Model. */ @@ -6950,6 +7458,10 @@ export namespace aiplatform_v1beta1 { * Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */ machineType?: string | null; + /** + * Optional. Immutable. Configuration controlling how this resource pool consumes reservation. + */ + reservationAffinity?: Schema$GoogleCloudAiplatformV1beta1ReservationAffinity; /** * Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). */ @@ -7364,6 +7876,14 @@ export namespace aiplatform_v1beta1 { * The schemata that describe formats of the Model's predictions and explanations as given and returned via PredictionService.Predict and PredictionService.Explain. */ predictSchemata?: Schema$GoogleCloudAiplatformV1beta1PredictSchemata; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. When this Model is deployed, its prediction resources are described by the `prediction_resources` field of the Endpoint.deployed_models object. Because not all Models support all resource configuration types, the configuration types this Model supports are listed here. If no configuration types are listed, the Model cannot be deployed to an Endpoint and does not support online predictions (PredictionService.Predict or PredictionService.Explain). Such a Model can serve predictions by using a BatchPredictionJob, if it has at least one entry each in supported_input_storage_formats and supported_output_storage_formats. */ @@ -7576,6 +8096,14 @@ export namespace aiplatform_v1beta1 { * Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests. */ samplePredictInstance?: any | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Schedule state when the monitoring job is in Running state. */ @@ -7869,6 +8397,14 @@ export namespace aiplatform_v1beta1 { * Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project. */ outputSpec?: Schema$GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Optional default tabular model monitoring objective. */ @@ -8764,6 +9300,14 @@ export namespace aiplatform_v1beta1 { * Required. The specification of a NasJob. */ nasJobSpec?: Schema$GoogleCloudAiplatformV1beta1NasJobSpec; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -8950,6 +9494,10 @@ export namespace aiplatform_v1beta1 { * Optional. The number of similar entities to be retrieved from feature view for each query. */ neighborCount?: number | null; + /** + * Optional. The list of numeric filters. + */ + numericFilters?: Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter[]; /** * Optional. Parameters that can be set to tune query on the fly. */ @@ -8972,6 +9520,31 @@ export namespace aiplatform_v1beta1 { */ value?: number[] | null; } + /** + * Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42\} {name: “b” value_float: 1.0\} Database Point 1: {name: “a” value_int: 10\} {name: “b” value_float: 2.0\} Database Point 2: {name: “a” value_int: -1\} {name: “b” value_float: 3.0\} Query: {name: “a” value_int: 12 operator: LESS\} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL\} // Matches Point 1 + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter { + /** + * Required. Column name in BigQuery that used as filters. + */ + name?: string | null; + /** + * Optional. This MUST be specified for queries and must NOT be specified for database points. + */ + op?: string | null; + /** + * double value type. + */ + valueDouble?: number | null; + /** + * float value type. + */ + valueFloat?: number | null; + /** + * int value type. + */ + valueInt?: string | null; + } /** * Parameters that can be overrided in each query to tune query latency and recall. */ @@ -9169,6 +9742,10 @@ export namespace aiplatform_v1beta1 { * The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. */ displayName?: string | null; + /** + * Customer-managed encryption key spec for the notebook execution job. This field is auto-populated if the NotebookRuntimeTemplate has an encryption spec. + */ + encryptionSpec?: Schema$GoogleCloudAiplatformV1beta1EncryptionSpec; /** * Max running time of the execution job in seconds (default 86400s / 24 hrs). */ @@ -9441,6 +10018,50 @@ export namespace aiplatform_v1beta1 { */ notebookRuntimeTemplate?: string | null; } + /** + * Input for pairwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricInput { + /** + * Required. Pairwise metric instance. + */ + instance?: Schema$GoogleCloudAiplatformV1beta1PairwiseMetricInstance; + /** + * Required. Spec for pairwise metric. + */ + metricSpec?: Schema$GoogleCloudAiplatformV1beta1PairwiseMetricSpec; + } + /** + * Pairwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricInstance { + /** + * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PairwiseMetricSpec.instance_prompt_template. + */ + jsonInstance?: string | null; + } + /** + * Spec for pairwise metric result. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricResult { + /** + * Output only. Explanation for pairwise metric score. + */ + explanation?: string | null; + /** + * Output only. Pairwise metric choice. + */ + pairwiseChoice?: string | null; + } + /** + * Spec for pairwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PairwiseMetricSpec { + /** + * Required. Metric prompt template for pairwise metric. + */ + metricPromptTemplate?: string | null; + } /** * Input for pairwise question answering quality metric. */ @@ -9659,6 +10280,10 @@ export namespace aiplatform_v1beta1 { * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in `12345`, and {network\} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. */ network?: string | null; + /** + * Optional. Configuration for PSC-I for PersistentResource. + */ + pscInterfaceConfig?: Schema$GoogleCloudAiplatformV1beta1PscInterfaceConfig; /** * Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */ @@ -9744,6 +10369,14 @@ export namespace aiplatform_v1beta1 { * Runtime config of the pipeline. */ runtimeConfig?: Schema$GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. */ @@ -9977,6 +10610,50 @@ export namespace aiplatform_v1beta1 { */ version?: string | null; } + /** + * Input for pointwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricInput { + /** + * Required. Pointwise metric instance. + */ + instance?: Schema$GoogleCloudAiplatformV1beta1PointwiseMetricInstance; + /** + * Required. Spec for pointwise metric. + */ + metricSpec?: Schema$GoogleCloudAiplatformV1beta1PointwiseMetricSpec; + } + /** + * Pointwise metric instance. Usually one instance corresponds to one row in an evaluation dataset. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricInstance { + /** + * Instance specified as a json string. String key-value pairs are expected in the json_instance to render PointwiseMetricSpec.instance_prompt_template. + */ + jsonInstance?: string | null; + } + /** + * Spec for pointwise metric result. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricResult { + /** + * Output only. Explanation for pointwise metric score. + */ + explanation?: string | null; + /** + * Output only. Pointwise metric score. + */ + score?: number | null; + } + /** + * Spec for pointwise metric. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PointwiseMetricSpec { + /** + * Required. Metric prompt template for pointwise metric. + */ + metricPromptTemplate?: string | null; + } /** * Represents a network port in a container. */ @@ -9995,6 +10672,19 @@ export namespace aiplatform_v1beta1 { */ key?: string | null; } + /** + * Metadata for PredictLongRunning long running operations. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PredictLongRunningMetadata {} + /** + * Response message for [PredictionService.PredictLongRunning] + */ + export interface Schema$GoogleCloudAiplatformV1beta1PredictLongRunningResponse { + /** + * The response of the video generation prediction. + */ + generateVideoResponse?: Schema$GoogleCloudAiplatformV1beta1GenerateVideoResponse; + } /** * Request message for PredictionService.Predict. */ @@ -10117,6 +10807,10 @@ export namespace aiplatform_v1beta1 { * A list of Projects from which the forwarding rule will target the service attachment. */ projectAllowlist?: string[] | null; + /** + * Output only. The name of the generated service attachment resource. This is only populated if the endpoint is deployed with PrivateServiceConnect. + */ + serviceAttachment?: string | null; } /** * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. @@ -10161,6 +10855,15 @@ export namespace aiplatform_v1beta1 { */ projectId?: string | null; } + /** + * Configuration for PSC-I. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PscInterfaceConfig { + /** + * Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project\}/regions/{region\}/networkAttachments/{networkAttachment\}`. Where {project\} is a project number, as in `12345`, and {networkAttachment\} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + */ + networkAttachment?: string | null; + } /** * A Model Garden Publisher Model. */ @@ -10283,6 +10986,10 @@ export namespace aiplatform_v1beta1 { * A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration. */ dedicatedResources?: Schema$GoogleCloudAiplatformV1beta1DedicatedResources; + /** + * Optional. Metadata information about this deployment config. + */ + deployMetadata?: Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata; /** * Optional. The name of the deploy task (e.g., "text to image generation"). */ @@ -10308,6 +11015,19 @@ export namespace aiplatform_v1beta1 { */ title?: string | null; } + /** + * Metadata information about the deployment for managing deployment config. + */ + export interface Schema$GoogleCloudAiplatformV1beta1PublisherModelCallToActionDeployDeployMetadata { + /** + * Optional. Labels for the deployment. For managing deployment config like verifying, source of deployment config, etc. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. Sample request for deployed endpoint. + */ + sampleRequest?: string | null; + } /** * Configurations for PublisherModel GKE deployment */ @@ -10889,13 +11609,17 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1RagContextsContext { /** - * The distance between the query vector and the context text vector. + * The distance between the query dense embedding vector and the context text vector. */ distance?: number | null; /** * For vertex RagStore, if the file is imported from Cloud Storage or Google Drive, source_uri will be original file URI in Cloud Storage or Google Drive; if file is uploaded, source_uri will be file display name. */ sourceUri?: string | null; + /** + * The distance between the query sparse embedding vector and the context text vector. + */ + sparseDistance?: number | null; /** * The text chunk. */ @@ -10935,10 +11659,53 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfig { /** - * The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. + * Configuration for hybrid search. + */ + hybridSearchConfig?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig; + /** + * The Vertex AI Prediction Endpoint that either refers to a publisher model or an endpoint that is hosting a 1P fine-tuned text embedding model. Endpoints hosting non-1P fine-tuned text embedding models are currently not supported. This is used for dense vector search. */ vertexPredictionEndpoint?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint; } + /** + * Config for hybrid search. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigHybridSearchConfig { + /** + * Required. The Vertex AI Prediction Endpoint that hosts the embedding model for dense embedding generations. + */ + denseEmbeddingModelPredictionEndpoint?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigVertexPredictionEndpoint; + /** + * Optional. The configuration for sparse embedding generation. This field is optional the default behavior depends on the vector database choice on the RagCorpus. + */ + sparseEmbeddingConfig?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig; + } + /** + * Configuration for sparse emebdding generation. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfig { + /** + * Use BM25 scoring algorithm. + */ + bm25?: Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25; + } + /** + * Message for BM25 parameters. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagEmbeddingModelConfigSparseEmbeddingConfigBm25 { + /** + * Optional. The parameter to control document length normalization. It determines how much the document length affects the final score. b is in the range of [0, 1]. The default value is 0.75. + */ + b?: number | null; + /** + * Optional. The parameter to control term frequency saturation. It determines the scaling between the matching term frequency and final score. k1 is in the range of [1.2, 3]. The default value is 1.2. + */ + k1?: number | null; + /** + * Optional. Use multilingual tokenizer if set to true. + */ + multilingual?: boolean | null; + } /** * Config representing a model hosted on Vertex Prediction Endpoint. */ @@ -10984,6 +11751,10 @@ export namespace aiplatform_v1beta1 { * Output only. Google Drive location. Supports importing individual files as well as Google Drive folders. */ googleDriveSource?: Schema$GoogleCloudAiplatformV1beta1GoogleDriveSource; + /** + * The RagFile is imported from a Jira query. + */ + jiraSource?: Schema$GoogleCloudAiplatformV1beta1JiraSource; /** * Output only. The resource name of the RagFile. */ @@ -10996,6 +11767,10 @@ export namespace aiplatform_v1beta1 { * Output only. The size of the RagFile in bytes. */ sizeBytes?: string | null; + /** + * The RagFile is imported from a Slack channel. + */ + slackSource?: Schema$GoogleCloudAiplatformV1beta1SlackSource; /** * Output only. Timestamp when this RagFile was last updated. */ @@ -11014,6 +11789,19 @@ export namespace aiplatform_v1beta1 { */ chunkSize?: number | null; } + /** + * Specifies the parsing config for RagFiles. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RagFileParsingConfig { + /** + * Whether to use OCR for PDFs. + */ + parsePdfsUsingOcr?: boolean | null; + /** + * Whether to use advanced PDF parsing. + */ + useAdvancedPdfParsing?: boolean | null; + } /** * A query to retrieve relevant contexts. */ @@ -11026,10 +11814,6 @@ export namespace aiplatform_v1beta1 { * Optional. The query in text format to get relevant contexts. */ text?: string | null; - /** - * Optional. Only return contexts with vector distance smaller than the threshold. - */ - vectorDistanceThreshold?: number | null; } /** * Request message for PredictionService.RawPredict. @@ -11040,6 +11824,15 @@ export namespace aiplatform_v1beta1 { */ httpBody?: Schema$GoogleApiHttpBody; } + /** + * Configuration for the Ray OSS Logs. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RayLogsSpec { + /** + * Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + */ + disabled?: boolean | null; + } /** * Configuration for the Ray metrics. */ @@ -11061,6 +11854,10 @@ export namespace aiplatform_v1beta1 { * Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images\} field. */ imageUri?: string | null; + /** + * Optional. OSS Ray logging configurations. + */ + rayLogsSpec?: Schema$GoogleCloudAiplatformV1beta1RayLogsSpec; /** * Optional. Ray metrics configurations. */ @@ -11393,12 +12190,29 @@ export namespace aiplatform_v1beta1 { */ idleShutdownMessage?: string | null; } + /** + * A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ReservationAffinity { + /** + * Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use `compute.googleapis.com/reservation-name` as the key and specify the name of your reservation as its value. + */ + key?: string | null; + /** + * Required. Specifies the reservation affinity type. + */ + reservationAffinityType?: string | null; + /** + * Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation. + */ + values?: string[] | null; + } /** * Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource. */ export interface Schema$GoogleCloudAiplatformV1beta1ResourcePool { /** - * Optional. Optional spec to configure GKE autoscaling + * Optional. Optional spec to configure GKE or Ray-on-Vertex autoscaling */ autoscalingSpec?: Schema$GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpec; /** @@ -11431,7 +12245,7 @@ export namespace aiplatform_v1beta1 { */ maxReplicaCount?: string | null; /** - * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error + * Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error. For autoscaling enabled Ray-on-Vertex, we allow min_replica_count of a resource_pool to be 0 to match the OSS Ray behavior(https://docs.ray.io/en/latest/cluster/vms/user-guides/configuring-autoscaling.html#cluster-config-parameters). As for Persistent Resource, the min_replica_count must be \> 0, we added a corresponding validation inside CreatePersistentResourceRequestValidator.java. */ minReplicaCount?: string | null; } @@ -11497,7 +12311,7 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1Retrieval { /** - * Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + * Optional. Deprecated. This option is no longer supported. */ disableAttribution?: boolean | null; /** @@ -11534,6 +12348,10 @@ export namespace aiplatform_v1beta1 { * Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. */ ragResources?: Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRagResource[]; + /** + * Optional. Configurations for hybrid search results ranking. + */ + ranking?: Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking; /** * Optional. Only return contexts with vector distance smaller than the threshold. */ @@ -11552,6 +12370,15 @@ export namespace aiplatform_v1beta1 { */ ragFileIds?: string[] | null; } + /** + * Configurations for hybrid search results ranking. + */ + export interface Schema$GoogleCloudAiplatformV1beta1RetrieveContextsRequestVertexRagStoreRanking { + /** + * Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally. + */ + alpha?: number | null; + } /** * Response message for VertexRagService.RetrieveContexts. */ @@ -11635,7 +12462,7 @@ export namespace aiplatform_v1beta1 { */ defaultParams?: {[key: string]: any} | null; /** - * Runtime configuration for Vertext AI Search extension. + * Runtime configuration for Vertex AI Search extension. */ vertexAiSearchRuntimeConfig?: Schema$GoogleCloudAiplatformV1beta1RuntimeConfigVertexAISearchRuntimeConfig; } @@ -11961,6 +12788,10 @@ export namespace aiplatform_v1beta1 { * Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. */ restartJobOnWorkerRestart?: boolean | null; + /** + * Optional. This determines which type of scheduling strategy to use. + */ + strategy?: string | null; /** * The maximum job running time. The default is 7 days. */ @@ -14824,6 +15655,27 @@ export namespace aiplatform_v1beta1 { */ nearestNeighbors?: Schema$GoogleCloudAiplatformV1beta1NearestNeighbors; } + /** + * Segment of the content. + */ + export interface Schema$GoogleCloudAiplatformV1beta1Segment { + /** + * Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + */ + endIndex?: number | null; + /** + * Output only. The index of a Part object within its parent Content object. + */ + partIndex?: number | null; + /** + * Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + */ + startIndex?: number | null; + /** + * Output only. The text corresponding to the segment from the response. + */ + text?: string | null; + } /** * Configuration for the use of custom service account to run the workloads. */ @@ -14846,6 +15698,45 @@ export namespace aiplatform_v1beta1 { */ enableSecureBoot?: boolean | null; } + /** + * The Slack source for the ImportRagFilesRequest. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SlackSource { + /** + * Required. The Slack channels. + */ + channels?: Schema$GoogleCloudAiplatformV1beta1SlackSourceSlackChannels[]; + } + /** + * SlackChannels contains the Slack channels and corresponding access token. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SlackSourceSlackChannels { + /** + * Required. The SecretManager secret version resource name (e.g. projects/{project\}/secrets/{secret\}/versions/{version\}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + */ + apiKeyConfig?: Schema$GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig; + /** + * Required. The Slack channel IDs. + */ + channels?: Schema$GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel[]; + } + /** + * SlackChannel contains the Slack channel ID and the time range to import. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel { + /** + * Required. The Slack channel ID. + */ + channelId?: string | null; + /** + * Optional. The ending timestamp for messages to import. + */ + endTime?: string | null; + /** + * Optional. The starting timestamp for messages to import. + */ + startTime?: string | null; + } /** * Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf */ @@ -15678,6 +16569,10 @@ export namespace aiplatform_v1beta1 { * Dataset distribution for Supervised Tuning. */ export interface Schema$GoogleCloudAiplatformV1beta1SupervisedTuningDatasetDistribution { + /** + * Output only. Sum of a given population of values that are billable. + */ + billableSum?: string | null; /** * Output only. Defines the histogram bucket. */ @@ -15736,6 +16631,10 @@ export namespace aiplatform_v1beta1 { * Output only. Number of billable characters in the tuning dataset. */ totalBillableCharacterCount?: string | null; + /** + * Output only. Number of billable tokens in the tuning dataset. + */ + totalBillableTokenCount?: string | null; /** * Output only. Number of tuning characters in the tuning dataset. */ @@ -15902,6 +16801,14 @@ export namespace aiplatform_v1beta1 { * Output only. The number of Runs stored in this Tensorboard. */ runCount?: number | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. Timestamp when this Tensorboard was last updated. */ @@ -16159,6 +17066,10 @@ export namespace aiplatform_v1beta1 { * Tokens info with a list of tokens and the corresponding list of token ids. */ export interface Schema$GoogleCloudAiplatformV1beta1TokensInfo { + /** + * Optional. Optional fields for the role from the corresponding Content. + */ + role?: string | null; /** * A list of token ids from the input. */ @@ -16572,9 +17483,6 @@ export namespace aiplatform_v1beta1 { */ webAccessUris?: {[key: string]: string} | null; } - /** - * Next ID: 3 - */ export interface Schema$GoogleCloudAiplatformV1beta1TrialContext { /** * A human-readable field which can store a description of this context. This will become part of the resulting Trial's description field. @@ -16615,6 +17523,10 @@ export namespace aiplatform_v1beta1 { * The tuning data statistic values for TuningJob. */ export interface Schema$GoogleCloudAiplatformV1beta1TuningDataStats { + /** + * Output only. Statistics for distillation. + */ + distillationDataStats?: Schema$GoogleCloudAiplatformV1beta1DistillationDataStats; /** * The SFT Tuning data stats. */ @@ -16636,6 +17548,10 @@ export namespace aiplatform_v1beta1 { * Optional. The description of the TuningJob. */ description?: string | null; + /** + * Tuning Spec for Distillation. + */ + distillationSpec?: Schema$GoogleCloudAiplatformV1beta1DistillationSpec; /** * Customer-managed encryption key options for a TuningJob. If this is set, then all resources created by the TuningJob will be encrypted with the provided encryption key. */ @@ -16660,6 +17576,10 @@ export namespace aiplatform_v1beta1 { * Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project\}/locations/{location\}/tuningJobs/{tuning_job\}` */ name?: string | null; + /** + * Output only. The resource name of the PipelineJob associated with the TuningJob. Format: `projects/{project\}/locations/{location\}/pipelineJobs/{pipeline_job\}`. + */ + pipelineJob?: string | null; /** * Output only. Time when the TuningJob for the first time entered the `JOB_STATE_RUNNING` state. */ @@ -17476,48 +18396,6 @@ export namespace aiplatform_v1beta1 { */ units?: string | null; } - export interface Schema$IntelligenceCloudAutomlXpsMetricEntry { - /** - * For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the "cloudbilling.googleapis.com/argentum_metric_id" label. Otherwise leave empty. - */ - argentumMetricId?: string | null; - /** - * A double value. - */ - doubleValue?: number | null; - /** - * A signed 64-bit integer value. - */ - int64Value?: string | null; - /** - * The metric name defined in the service configuration. - */ - metricName?: string | null; - /** - * Billing system labels for this (metric, value) pair. - */ - systemLabels?: Schema$IntelligenceCloudAutomlXpsMetricEntryLabel[]; - } - export interface Schema$IntelligenceCloudAutomlXpsMetricEntryLabel { - /** - * The name of the label. - */ - labelName?: string | null; - /** - * The value of the label. - */ - labelValue?: string | null; - } - export interface Schema$IntelligenceCloudAutomlXpsReportingMetrics { - /** - * The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set. - */ - effectiveTrainingDuration?: string | null; - /** - * One entry per metric name. The values must be aggregated per metric name. - */ - metricEntries?: Schema$IntelligenceCloudAutomlXpsMetricEntry[]; - } export class Resource$Media { context: APIRequestContext; @@ -23618,7 +24496,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Patch extends StandardParameters { /** - * Output only. The resource name of the Dataset. + * Output only. Identifier. The resource name of the Dataset. */ name?: string; /** @@ -26312,7 +27190,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Patch extends StandardParameters { /** - * Output only. The resource name of the DatasetVersion. + * Output only. Identifier. The resource name of the DatasetVersion. */ name?: string; /** @@ -28016,6 +28894,99 @@ export namespace aiplatform_v1beta1 { } } + /** + * Update a DeploymentResourcePool. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Deploymentresourcepools$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Deploymentresourcepools$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * List DeployedModels that have been deployed on this DeploymentResourcePool. * @@ -28155,6 +29126,22 @@ export namespace aiplatform_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Patch + extends StandardParameters { + /** + * Immutable. The resource name of the DeploymentResourcePool. Format: `projects/{project\}/locations/{location\}/deploymentResourcePools/{deployment_resource_pool\}` + */ + name?: string; + /** + * Required. The list of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DeploymentResourcePool; + } export interface Params$Resource$Projects$Locations$Deploymentresourcepools$Querydeployedmodels extends StandardParameters { /** @@ -35626,7 +36613,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `big_query` * `big_query.entity_id_columns` */ updateMask?: string; @@ -36191,7 +37178,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -37910,7 +38897,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `bigtable` * `labels` * `sync_config` + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `description` * `bigtable` * `bigtable.auto_scaling` * `bigtable.enable_multi_region_replica` */ updateMask?: string; @@ -39197,7 +40184,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `serviceAgentType` + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` * `service_agent_type` * `big_query_source` * `big_query_source.uri` * `big_query_source.entity_id_columns` * `feature_registry_source` * `feature_registry_source.feature_groups` * `sync_config` * `sync_config.cron` */ updateMask?: string; @@ -43665,7 +44652,7 @@ export namespace aiplatform_v1beta1 { */ name?: string; /** - * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistry Feature) + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` (Not supported for FeatureRegistryService Feature) * `point_of_contact` (Not supported for FeaturestoreService FeatureStore) */ updateMask?: string; @@ -86549,7 +87536,15 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Publishers$Models$Get extends StandardParameters { /** - * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47). + * Optional. Token used to access Hugging Face gated models. + */ + huggingFaceToken?: string; + /** + * Optional. Boolean indicates whether the requested model is a Hugging Face model. + */ + isHuggingFaceModel?: boolean; + /** + * Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in. */ languageCode?: string; /** @@ -86568,7 +87563,7 @@ export namespace aiplatform_v1beta1 { */ filter?: string; /** - * Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en). + * Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en). */ languageCode?: string; /** diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index eedfb7d373..1a1f66e76b 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -419,6 +419,14 @@ export namespace alloydb_v1 { * Output only. The current serving state of the cluster. */ state?: string | null; + /** + * Optional. Subscription type of the cluster. + */ + subscriptionType?: string | null; + /** + * Output only. Metadata for free trial clusters + */ + trialMetadata?: Schema$TrialMetadata; /** * Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. */ @@ -1658,6 +1666,23 @@ export namespace alloydb_v1 { */ retentionPeriod?: string | null; } + /** + * Contains information and all metadata related to TRIAL clusters. + */ + export interface Schema$TrialMetadata { + /** + * End time of the trial cluster. + */ + endTime?: string | null; + /** + * start time of the trial cluster. + */ + startTime?: string | null; + /** + * Upgrade time of trial cluster to Standard cluster. + */ + upgradeTime?: string | null; + } /** * Message describing User object. */ diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index fea36f940e..adb33fb010 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -310,6 +310,23 @@ export namespace alloydb_v1alpha { */ exclusiveAction?: string | null; } + /** + * The source CloudSQL backup resource. + */ + export interface Schema$CloudSQLBackupRunSource { + /** + * Required. The CloudSQL backup run ID. + */ + backupRunId?: string | null; + /** + * Required. The CloudSQL instance ID. + */ + instanceId?: string | null; + /** + * The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project. + */ + project?: string | null; + } /** * A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. */ @@ -326,6 +343,10 @@ export namespace alloydb_v1alpha { * Output only. Cluster created from backup. */ backupSource?: Schema$BackupSource; + /** + * Output only. Cluster created from CloudSQL snapshot. + */ + cloudsqlBackupRunSource?: Schema$CloudSQLBackupRunSource; /** * Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster` */ @@ -448,6 +469,35 @@ export namespace alloydb_v1alpha { */ updateTime?: string | null; } + /** + * Upgrade details of a cluster. This cluster can be primary or secondary. + */ + export interface Schema$ClusterUpgradeDetails { + /** + * Cluster type which can either be primary or secondary. + */ + clusterType?: string | null; + /** + * Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation. + */ + databaseVersion?: string | null; + /** + * Upgrade details of the instances directly associated with this cluster. + */ + instanceUpgradeDetails?: Schema$InstanceUpgradeDetails[]; + /** + * Normalized name of the cluster + */ + name?: string | null; + /** + * Array containing stage info associated with this cluster. + */ + stageInfo?: Schema$StageInfo[]; + /** + * Upgrade status of the cluster. + */ + upgradeStatus?: string | null; + } /** * ConnectionInfo singleton resource. https://google.aip.dev/156 */ @@ -807,6 +857,23 @@ export namespace alloydb_v1alpha { */ enablePublicIp?: boolean | null; } + /** + * Details regarding the upgrade of instaces associated with a cluster. + */ + export interface Schema$InstanceUpgradeDetails { + /** + * Instance type. + */ + instanceType?: string | null; + /** + * Normalized name of the instance. + */ + name?: string | null; + /** + * Upgrade status of the instance. + */ + upgradeStatus?: string | null; + } /** * Restrictions on INTEGER type values. */ @@ -1010,7 +1077,7 @@ export namespace alloydb_v1alpha { */ export interface Schema$ObservabilityInstanceConfig { /** - * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default. + * Observability feature status for an instance. This flag is turned "off" by default. */ enabled?: boolean | null; /** @@ -1022,7 +1089,7 @@ export namespace alloydb_v1alpha { */ preserveComments?: boolean | null; /** - * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid. + * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. */ queryPlansPerMinute?: number | null; /** @@ -1033,6 +1100,10 @@ export namespace alloydb_v1alpha { * Track actively running queries on the instance. If not set, this flag is "off" by default. */ trackActiveQueries?: boolean | null; + /** + * Track client address for an instance. If not set, default value is "off". + */ + trackClientAddress?: boolean | null; /** * Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. */ @@ -1205,6 +1276,10 @@ export namespace alloydb_v1alpha { nodeCount?: number | null; } export interface Schema$RestartInstanceRequest { + /** + * Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances. + */ + nodeIds?: string[] | null; /** * 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). */ @@ -1265,6 +1340,23 @@ export namespace alloydb_v1alpha { */ sslMode?: string | null; } + /** + * Stage information for different stages in the upgrade process. + */ + export interface Schema$StageInfo { + /** + * logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE. + */ + logsUrl?: string | null; + /** + * The stage. + */ + stage?: string | null; + /** + * Status of the stage. + */ + status?: string | null; + } /** * 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). */ @@ -1349,29 +1441,13 @@ export namespace alloydb_v1alpha { version?: string | null; } /** - * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data + * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data */ export interface Schema$StorageDatabasecenterPartnerapiV1mainCustomMetadataData { - databaseMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata[]; - } - /** - * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings. - */ - export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseMetadata { /** - * Backup configuration for this database - */ - backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration; - /** - * Information about the last backup attempt for this database + * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration. */ - backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun; - product?: Schema$StorageDatabasecenterProtoCommonProduct; - resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; - /** - * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel - */ - resourceName?: string | null; + internalResourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata[]; } /** * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. @@ -1385,9 +1461,6 @@ export namespace alloydb_v1alpha { * Required. Type feed to be ingested into condor */ feedType?: string | null; - /** - * More feed data would be added in subsequent CLs - */ observabilityMetricData?: Schema$StorageDatabasecenterPartnerapiV1mainObservabilityMetricData; recommendationSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData; resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData; @@ -1445,6 +1518,10 @@ export namespace alloydb_v1alpha { * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. */ signalId?: string | null; + /** + * The severity of the signal, such as if it's a HIGH or LOW severity. + */ + signalSeverity?: string | null; /** * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc. */ @@ -1464,7 +1541,7 @@ export namespace alloydb_v1alpha { */ providerDescription?: string | null; /** - * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel + * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel */ resourceType?: string | null; /** @@ -1599,6 +1676,25 @@ export namespace alloydb_v1alpha { */ type?: string | null; } + /** + * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata { + /** + * Backup configuration for this database + */ + backupConfiguration?: Schema$StorageDatabasecenterPartnerapiV1mainBackupConfiguration; + /** + * Information about the last backup attempt for this database + */ + backupRun?: Schema$StorageDatabasecenterPartnerapiV1mainBackupRun; + product?: Schema$StorageDatabasecenterProtoCommonProduct; + resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + /** + * Required. internal resource name for spanner this will be database name e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1" + */ + resourceName?: string | null; + } /** * MachineConfiguration describes the configuration of a machine specific to Database Resource. */ @@ -1773,6 +1869,10 @@ export namespace alloydb_v1alpha { * End time of the trial cluster. */ endTime?: string | null; + /** + * grace end time of the cluster. + */ + graceEndTime?: string | null; /** * start time of the trial cluster. */ @@ -1791,6 +1891,44 @@ export namespace alloydb_v1alpha { */ mode?: string | null; } + /** + * Upgrades a cluster. + */ + export interface Schema$UpgradeClusterRequest { + /** + * Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned. + */ + etag?: string | null; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade. + */ + validateOnly?: boolean | null; + /** + * Required. The version the cluster is going to be upgraded to. + */ + version?: string | null; + } + /** + * UpgradeClusterResponse contains the response for upgrade cluster operation. + */ + export interface Schema$UpgradeClusterResponse { + /** + * Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster. + */ + clusterUpgradeDetails?: Schema$ClusterUpgradeDetails[]; + /** + * A user friendly message summarising the upgrade operation details and the next steps for the user if there is any. + */ + message?: string | null; + /** + * Status of upgrade operation. + */ + status?: string | null; + } /** * Message describing User object. */ @@ -3424,6 +3562,94 @@ export namespace alloydb_v1alpha { return createAPIRequest(parameters); } } + + /** + * Upgrades a single Cluster. Imperative only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: StreamMethodOptions + ): GaxiosPromise; + upgrade( + params?: Params$Resource$Projects$Locations$Clusters$Upgrade, + options?: MethodOptions + ): GaxiosPromise; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Clusters$Upgrade, + callback: BodyResponseCallback + ): void; + upgrade(callback: BodyResponseCallback): void; + upgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Upgrade + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Upgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Upgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:upgrade').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Clusters$Create @@ -3595,6 +3821,18 @@ export namespace alloydb_v1alpha { */ requestBody?: Schema$SwitchoverClusterRequest; } + export interface Params$Resource$Projects$Locations$Clusters$Upgrade + extends StandardParameters { + /** + * Required. The resource name of the cluster. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpgradeClusterRequest; + } export class Resource$Projects$Locations$Clusters$Instances { context: APIRequestContext; diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 27a9738cbb..4a9f595cb4 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -994,7 +994,7 @@ export namespace alloydb_v1beta { */ export interface Schema$ObservabilityInstanceConfig { /** - * Observability feature status for an instance. This is a read-only flag and modifiable only by producer API. This flag is turned "off" by default. + * Observability feature status for an instance. This flag is turned "off" by default. */ enabled?: boolean | null; /** @@ -1006,7 +1006,7 @@ export namespace alloydb_v1beta { */ preserveComments?: boolean | null; /** - * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 5. Any integer between 0 to 20 is considered valid. + * Number of query execution plans captured by Insights per minute for all queries combined. The default value is 200. Any integer between 0 to 200 is considered valid. */ queryPlansPerMinute?: number | null; /** diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index 216ba8c0f3..cb1b483d82 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -880,6 +880,10 @@ export namespace analyticsadmin_v1alpha { * If set true, enables daily data export to the linked Google Cloud project. */ dailyExportEnabled?: boolean | null; + /** + * Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. + */ + datasetLocation?: string | null; /** * The list of event names that will be excluded from exports. */ @@ -1343,32 +1347,6 @@ export namespace analyticsadmin_v1alpha { */ rollupPropertySourceLinks?: Schema$GoogleAnalyticsAdminV1alphaRollupPropertySourceLink[]; } - /** - * Request message for CreateSubproperty RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest { - /** - * Required. The subproperty to create. - */ - subproperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; - /** - * Optional. The subproperty event filter to create on an ordinary property. - */ - subpropertyEventFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; - } - /** - * Response message for CreateSubproperty RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse { - /** - * The created subproperty. - */ - subproperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; - /** - * The created subproperty event filter. - */ - subpropertyEventFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; - } /** * A definition for a CustomDimension. */ @@ -1740,6 +1718,31 @@ export namespace analyticsadmin_v1alpha { */ sourceCopyParameters?: boolean | null; } + /** + * An Event Edit Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Create rules, Event Edit Rules are applied in their defined order. Event Edit rules can't be used to modify an event created from an Event Create rule. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaEventEditRule { + /** + * Required. The display name of this event edit rule. Maximum of 255 characters. + */ + displayName?: string | null; + /** + * Required. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max. + */ + eventConditions?: Schema$GoogleAnalyticsAdminV1alphaMatchingCondition[]; + /** + * Identifier. Resource name for this EventEditRule resource. Format: properties/{property\}/dataStreams/{data_stream\}/eventEditRules/{event_edit_rule\} + */ + name?: string | null; + /** + * Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. + */ + parameterMutations?: Schema$GoogleAnalyticsAdminV1alphaParameterMutation[]; + /** + * Output only. The order for which this rule will be processed. Rules with an order value lower than this will be processed before this rule, rules with an order value higher than this will be processed after this rule. New event edit rules will be assigned an order value at the end of the order. This value does not apply to event create rules. + */ + processingOrder?: string | null; + } /** * Event setting conditions to match an event. */ @@ -2267,6 +2270,19 @@ export namespace analyticsadmin_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for ListEventEditRules RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaListEventEditRulesResponse { + /** + * List of EventEditRules. These will be ordered stably, but in an arbitrary order. + */ + eventEditRules?: Schema$GoogleAnalyticsAdminV1alphaEventEditRule[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response message for ListExpandedDataSets RPC. */ @@ -2574,6 +2590,32 @@ export namespace analyticsadmin_v1alpha { */ accountTicketId?: string | null; } + /** + * Request message for CreateSubproperty RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest { + /** + * Required. The subproperty to create. + */ + subproperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; + /** + * Optional. The subproperty event filter to create on an ordinary property. + */ + subpropertyEventFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; + } + /** + * Response message for ProvisionSubproperty RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse { + /** + * The created subproperty. + */ + subproperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; + /** + * The created subproperty event filter. + */ + subpropertyEventFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; + } /** * Request message for ReorderEventEditRules RPC. */ @@ -2736,7 +2778,7 @@ export namespace analyticsadmin_v1alpha { */ pageToken?: string | null; /** - * Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId\} Example: "properties/100" + * Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId\} Example: `properties/100` */ property?: string | null; /** @@ -3685,7 +3727,7 @@ export namespace analyticsadmin_v1alpha { export interface Params$Resource$Accounts$Getdatasharingsettings extends StandardParameters { /** - * Required. The name of the settings to lookup. Format: accounts/{account\}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" + * Required. The name of the settings to lookup. Format: accounts/{account\}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` */ name?: string; } @@ -3740,7 +3782,7 @@ export namespace analyticsadmin_v1alpha { export interface Params$Resource$Accounts$Searchchangehistoryevents extends StandardParameters { /** - * Required. The account resource for which to return change history resources. Format: accounts/{account\} Example: "accounts/100" + * Required. The account resource for which to return change history resources. Format: accounts/{account\} Example: `accounts/100` */ account?: string; @@ -5288,104 +5330,6 @@ export namespace analyticsadmin_v1alpha { } } - /** - * Create a subproperty and a subproperty event filter that applies to the created subproperty. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - createSubproperty( - params: Params$Resource$Properties$Createsubproperty, - options: StreamMethodOptions - ): GaxiosPromise; - createSubproperty( - params?: Params$Resource$Properties$Createsubproperty, - options?: MethodOptions - ): GaxiosPromise; - createSubproperty( - params: Params$Resource$Properties$Createsubproperty, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createSubproperty( - params: Params$Resource$Properties$Createsubproperty, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - createSubproperty( - params: Params$Resource$Properties$Createsubproperty, - callback: BodyResponseCallback - ): void; - createSubproperty( - callback: BodyResponseCallback - ): void; - createSubproperty( - paramsOrCallback?: - | Params$Resource$Properties$Createsubproperty - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Createsubproperty; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Createsubproperty; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/properties:createSubproperty').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - /** * Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property. * @@ -6437,6 +6381,104 @@ export namespace analyticsadmin_v1alpha { } } + /** + * Create a subproperty and a subproperty event filter that applies to the created subproperty. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + provisionSubproperty( + params: Params$Resource$Properties$Provisionsubproperty, + options: StreamMethodOptions + ): GaxiosPromise; + provisionSubproperty( + params?: Params$Resource$Properties$Provisionsubproperty, + options?: MethodOptions + ): GaxiosPromise; + provisionSubproperty( + params: Params$Resource$Properties$Provisionsubproperty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provisionSubproperty( + params: Params$Resource$Properties$Provisionsubproperty, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provisionSubproperty( + params: Params$Resource$Properties$Provisionsubproperty, + callback: BodyResponseCallback + ): void; + provisionSubproperty( + callback: BodyResponseCallback + ): void; + provisionSubproperty( + paramsOrCallback?: + | Params$Resource$Properties$Provisionsubproperty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Provisionsubproperty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Provisionsubproperty; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/properties:provisionSubproperty').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA4 UI Reporting, GA4 UI Explorations, GA4 Data API, and other products like Firebase & Admob that can retrieve data from Google Analytics through a linkage. These records don't include property configuration changes like adding a stream or changing a property's time zone. For configuration change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). * @@ -6952,13 +6994,6 @@ export namespace analyticsadmin_v1alpha { */ requestBody?: Schema$GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest; } - export interface Params$Resource$Properties$Createsubproperty - extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest; - } export interface Params$Resource$Properties$Delete extends StandardParameters { /** @@ -7054,6 +7089,13 @@ export namespace analyticsadmin_v1alpha { */ requestBody?: Schema$GoogleAnalyticsAdminV1alphaProperty; } + export interface Params$Resource$Properties$Provisionsubproperty + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest; + } export interface Params$Resource$Properties$Runaccessreport extends StandardParameters { /** @@ -9073,43 +9115,43 @@ export namespace analyticsadmin_v1alpha { } /** - * Lookup for a single BigQuery Link. + * Creates a BigQueryLink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Properties$Bigquerylinks$Get, + create( + params: Params$Resource$Properties$Bigquerylinks$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Properties$Bigquerylinks$Get, + create( + params?: Params$Resource$Properties$Bigquerylinks$Create, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Properties$Bigquerylinks$Get, + create( + params: Params$Resource$Properties$Bigquerylinks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Bigquerylinks$Get, + create( + params: Params$Resource$Properties$Bigquerylinks$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Bigquerylinks$Get, + create( + params: Params$Resource$Properties$Bigquerylinks$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Properties$Bigquerylinks$Get + | Params$Resource$Properties$Bigquerylinks$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9125,12 +9167,12 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Bigquerylinks$Get; + {}) as Params$Resource$Properties$Bigquerylinks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Bigquerylinks$Get; + params = {} as Params$Resource$Properties$Bigquerylinks$Create; options = {}; } @@ -9144,15 +9186,18 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/bigQueryLinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -9168,64 +9213,60 @@ export namespace analyticsadmin_v1alpha { } /** - * Lists BigQuery Links on a property. + * Deletes a BigQueryLink on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Properties$Bigquerylinks$List, + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Properties$Bigquerylinks$List, + delete( + params?: Params$Resource$Properties$Bigquerylinks$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Properties$Bigquerylinks$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Properties$Bigquerylinks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Properties$Bigquerylinks$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Bigquerylinks$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Properties$Bigquerylinks$List - | BodyResponseCallback + | Params$Resource$Properties$Bigquerylinks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Bigquerylinks$List; + {}) as Params$Resource$Properties$Bigquerylinks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Bigquerylinks$List; + params = {} as Params$Resource$Properties$Bigquerylinks$Delete; options = {}; } @@ -9239,121 +9280,86 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/bigQueryLinks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Properties$Bigquerylinks$Get - extends StandardParameters { - /** - * Required. The name of the BigQuery link to lookup. Format: properties/{property_id\}/bigQueryLinks/{bigquery_link_id\} Example: properties/123/bigQueryLinks/456 - */ - name?: string; - } - export interface Params$Resource$Properties$Bigquerylinks$List - extends StandardParameters { - /** - * The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - */ - pageSize?: number; - /** - * A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The name of the property to list BigQuery links under. Format: properties/{property_id\} Example: properties/1234 - */ - parent?: string; - } - - export class Resource$Properties$Calculatedmetrics { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a CalculatedMetric. + * Lookup for a single BigQuery Link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Properties$Calculatedmetrics$Create, + get( + params: Params$Resource$Properties$Bigquerylinks$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Properties$Calculatedmetrics$Create, + get( + params?: Params$Resource$Properties$Bigquerylinks$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Properties$Calculatedmetrics$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Bigquerylinks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Properties$Calculatedmetrics$Create, + get( + params: Params$Resource$Properties$Bigquerylinks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Properties$Calculatedmetrics$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Properties$Bigquerylinks$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Properties$Calculatedmetrics$Create - | BodyResponseCallback + | Params$Resource$Properties$Bigquerylinks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Calculatedmetrics$Create; + {}) as Params$Resource$Properties$Bigquerylinks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Calculatedmetrics$Create; + params = {} as Params$Resource$Properties$Bigquerylinks$Get; options = {}; } @@ -9367,87 +9373,88 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/calculatedMetrics').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a CalculatedMetric on a property. + * Lists BigQuery Links on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Properties$Calculatedmetrics$Delete, + list( + params: Params$Resource$Properties$Bigquerylinks$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Properties$Calculatedmetrics$Delete, + list( + params?: Params$Resource$Properties$Bigquerylinks$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Properties$Calculatedmetrics$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Bigquerylinks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Properties$Calculatedmetrics$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Bigquerylinks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Properties$Calculatedmetrics$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Bigquerylinks$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Properties$Calculatedmetrics$Delete - | BodyResponseCallback + | Params$Resource$Properties$Bigquerylinks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Calculatedmetrics$Delete; + {}) as Params$Resource$Properties$Bigquerylinks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Calculatedmetrics$Delete; + params = {} as Params$Resource$Properties$Bigquerylinks$List; options = {}; } @@ -9461,86 +9468,982 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/bigQueryLinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lookup for a single CalculatedMetric. + * Updates a BigQueryLink. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Properties$Calculatedmetrics$Get, + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Properties$Calculatedmetrics$Get, + patch( + params?: Params$Resource$Properties$Bigquerylinks$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Properties$Calculatedmetrics$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Calculatedmetrics$Get, + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Calculatedmetrics$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Properties$Bigquerylinks$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Properties$Bigquerylinks$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Bigquerylinks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Bigquerylinks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Properties$Bigquerylinks$Create + extends StandardParameters { + /** + * Required. Example format: properties/1234 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaBigQueryLink; + } + export interface Params$Resource$Properties$Bigquerylinks$Delete + extends StandardParameters { + /** + * Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678 + */ + name?: string; + } + export interface Params$Resource$Properties$Bigquerylinks$Get + extends StandardParameters { + /** + * Required. The name of the BigQuery link to lookup. Format: properties/{property_id\}/bigQueryLinks/{bigquery_link_id\} Example: properties/123/bigQueryLinks/456 + */ + name?: string; + } + export interface Params$Resource$Properties$Bigquerylinks$List + extends StandardParameters { + /** + * The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + */ + pageSize?: number; + /** + * A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The name of the property to list BigQuery links under. Format: properties/{property_id\} Example: properties/1234 + */ + parent?: string; + } + export interface Params$Resource$Properties$Bigquerylinks$Patch + extends StandardParameters { + /** + * Output only. Resource name of this BigQuery link. Format: 'properties/{property_id\}/bigQueryLinks/{bigquery_link_id\}' Format: 'properties/1234/bigQueryLinks/abc567' + */ + name?: string; + /** + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaBigQueryLink; + } + + export class Resource$Properties$Calculatedmetrics { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a CalculatedMetric. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Properties$Calculatedmetrics$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Properties$Calculatedmetrics$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Calculatedmetrics$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Calculatedmetrics$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Calculatedmetrics$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Properties$Calculatedmetrics$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Calculatedmetrics$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Calculatedmetrics$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/calculatedMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a CalculatedMetric on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Properties$Calculatedmetrics$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Properties$Calculatedmetrics$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Calculatedmetrics$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Calculatedmetrics$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Calculatedmetrics$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Properties$Calculatedmetrics$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Calculatedmetrics$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Calculatedmetrics$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lookup for a single CalculatedMetric. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Properties$Calculatedmetrics$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Properties$Calculatedmetrics$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Calculatedmetrics$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Calculatedmetrics$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Calculatedmetrics$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Properties$Calculatedmetrics$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Calculatedmetrics$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Calculatedmetrics$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists CalculatedMetrics on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Properties$Calculatedmetrics$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Properties$Calculatedmetrics$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Calculatedmetrics$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Properties$Calculatedmetrics$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Properties$Calculatedmetrics$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Properties$Calculatedmetrics$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Calculatedmetrics$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Calculatedmetrics$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/calculatedMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a CalculatedMetric on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Properties$Calculatedmetrics$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Properties$Calculatedmetrics$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Properties$Calculatedmetrics$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Properties$Calculatedmetrics$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Properties$Calculatedmetrics$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Properties$Calculatedmetrics$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Calculatedmetrics$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Calculatedmetrics$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Properties$Calculatedmetrics$Create + extends StandardParameters { + /** + * Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id\}". + */ + calculatedMetricId?: string; + /** + * Required. Format: properties/{property_id\} Example: properties/1234 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCalculatedMetric; + } + export interface Params$Resource$Properties$Calculatedmetrics$Delete + extends StandardParameters { + /** + * Required. The name of the CalculatedMetric to delete. Format: properties/{property_id\}/calculatedMetrics/{calculated_metric_id\} Example: properties/1234/calculatedMetrics/Metric01 + */ + name?: string; + } + export interface Params$Resource$Properties$Calculatedmetrics$Get + extends StandardParameters { + /** + * Required. The name of the CalculatedMetric to get. Format: properties/{property_id\}/calculatedMetrics/{calculated_metric_id\} Example: properties/1234/calculatedMetrics/Metric01 + */ + name?: string; + } + export interface Params$Resource$Properties$Calculatedmetrics$List + extends StandardParameters { + /** + * Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListCalculatedMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedMetrics` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Example format: properties/1234 + */ + parent?: string; + } + export interface Params$Resource$Properties$Calculatedmetrics$Patch + extends StandardParameters { + /** + * Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id\}/calculatedMetrics/{calculated_metric_id\}' + */ + name?: string; + /** + * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCalculatedMetric; + } + + export class Resource$Properties$Channelgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a ChannelGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Properties$Channelgroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Properties$Channelgroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Channelgroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Channelgroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Properties$Channelgroups$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Properties$Channelgroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Channelgroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Channelgroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/channelGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a ChannelGroup on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Properties$Channelgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Properties$Channelgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Channelgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Channelgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Properties$Channelgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Properties$Channelgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Channelgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Channelgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lookup for a single ChannelGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Properties$Channelgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Properties$Channelgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Channelgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Channelgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Channelgroups$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Properties$Calculatedmetrics$Get - | BodyResponseCallback + | Params$Resource$Properties$Channelgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Calculatedmetrics$Get; + {}) as Params$Resource$Properties$Channelgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Calculatedmetrics$Get; + params = {} as Params$Resource$Properties$Channelgroups$Get; options = {}; } @@ -9566,19 +10469,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists CalculatedMetrics on a property. + * Lists ChannelGroups on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9586,56 +10489,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Properties$Calculatedmetrics$List, + params: Params$Resource$Properties$Channelgroups$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Properties$Calculatedmetrics$List, + params?: Params$Resource$Properties$Channelgroups$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Properties$Calculatedmetrics$List, + params: Params$Resource$Properties$Channelgroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Calculatedmetrics$List, + params: Params$Resource$Properties$Channelgroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Calculatedmetrics$List, - callback: BodyResponseCallback + params: Params$Resource$Properties$Channelgroups$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Properties$Calculatedmetrics$List - | BodyResponseCallback + | Params$Resource$Properties$Channelgroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Calculatedmetrics$List; + {}) as Params$Resource$Properties$Channelgroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Calculatedmetrics$List; + params = {} as Params$Resource$Properties$Channelgroups$List; options = {}; } @@ -9649,7 +10552,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/calculatedMetrics').replace( + url: (rootUrl + '/v1alpha/{+parent}/channelGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -9664,19 +10567,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a CalculatedMetric on a property. + * Updates a ChannelGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9684,56 +10587,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Properties$Calculatedmetrics$Patch, + params: Params$Resource$Properties$Channelgroups$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Properties$Calculatedmetrics$Patch, + params?: Params$Resource$Properties$Channelgroups$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Properties$Calculatedmetrics$Patch, + params: Params$Resource$Properties$Channelgroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Calculatedmetrics$Patch, + params: Params$Resource$Properties$Channelgroups$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Calculatedmetrics$Patch, - callback: BodyResponseCallback + params: Params$Resource$Properties$Channelgroups$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Properties$Calculatedmetrics$Patch - | BodyResponseCallback + | Params$Resource$Properties$Channelgroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Calculatedmetrics$Patch; + {}) as Params$Resource$Properties$Channelgroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Calculatedmetrics$Patch; + params = {} as Params$Resource$Properties$Channelgroups$Patch; options = {}; } @@ -9759,88 +10662,84 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Calculatedmetrics$Create + export interface Params$Resource$Properties$Channelgroups$Create extends StandardParameters { /** - * Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id\}". - */ - calculatedMetricId?: string; - /** - * Required. Format: properties/{property_id\} Example: properties/1234 + * Required. The property for which to create a ChannelGroup. Example format: properties/1234 */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCalculatedMetric; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaChannelGroup; } - export interface Params$Resource$Properties$Calculatedmetrics$Delete + export interface Params$Resource$Properties$Channelgroups$Delete extends StandardParameters { /** - * Required. The name of the CalculatedMetric to delete. Format: properties/{property_id\}/calculatedMetrics/{calculated_metric_id\} Example: properties/1234/calculatedMetrics/Metric01 + * Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678 */ name?: string; } - export interface Params$Resource$Properties$Calculatedmetrics$Get + export interface Params$Resource$Properties$Channelgroups$Get extends StandardParameters { /** - * Required. The name of the CalculatedMetric to get. Format: properties/{property_id\}/calculatedMetrics/{calculated_metric_id\} Example: properties/1234/calculatedMetrics/Metric01 + * Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678 */ name?: string; } - export interface Params$Resource$Properties$Calculatedmetrics$List + export interface Params$Resource$Properties$Channelgroups$List extends StandardParameters { /** - * Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListCalculatedMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedMetrics` must match the call that provided the page token. + * A page token, received from a previous `ListChannelGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannelGroups` must match the call that provided the page token. */ pageToken?: string; /** - * Required. Example format: properties/1234 + * Required. The property for which to list ChannelGroups. Example format: properties/1234 */ parent?: string; } - export interface Params$Resource$Properties$Calculatedmetrics$Patch + export interface Params$Resource$Properties$Channelgroups$Patch extends StandardParameters { /** - * Output only. Resource name for this CalculatedMetric. Format: 'properties/{property_id\}/calculatedMetrics/{calculated_metric_id\}' + * Output only. The resource name for this Channel Group resource. Format: properties/{property\}/channelGroups/{channel_group\} */ name?: string; /** - * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCalculatedMetric; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaChannelGroup; } - export class Resource$Properties$Channelgroups { + export class Resource$Properties$Conversionevents { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a ChannelGroup. + * Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9848,56 +10747,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Properties$Channelgroups$Create, + params: Params$Resource$Properties$Conversionevents$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Properties$Channelgroups$Create, + params?: Params$Resource$Properties$Conversionevents$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Properties$Channelgroups$Create, + params: Params$Resource$Properties$Conversionevents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Channelgroups$Create, + params: Params$Resource$Properties$Conversionevents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Channelgroups$Create, - callback: BodyResponseCallback + params: Params$Resource$Properties$Conversionevents$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Properties$Channelgroups$Create - | BodyResponseCallback + | Params$Resource$Properties$Conversionevents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Channelgroups$Create; + {}) as Params$Resource$Properties$Conversionevents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Channelgroups$Create; + params = {} as Params$Resource$Properties$Conversionevents$Create; options = {}; } @@ -9911,7 +10810,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/channelGroups').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversionEvents').replace( /([^:]\/)\/+/g, '$1' ), @@ -9926,19 +10825,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a ChannelGroup on a property. + * Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9946,31 +10845,31 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Properties$Channelgroups$Delete, + params: Params$Resource$Properties$Conversionevents$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Properties$Channelgroups$Delete, + params?: Params$Resource$Properties$Conversionevents$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Properties$Channelgroups$Delete, + params: Params$Resource$Properties$Conversionevents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Properties$Channelgroups$Delete, + params: Params$Resource$Properties$Conversionevents$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Properties$Channelgroups$Delete, + params: Params$Resource$Properties$Conversionevents$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Properties$Channelgroups$Delete + | Params$Resource$Properties$Conversionevents$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9986,12 +10885,12 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Channelgroups$Delete; + {}) as Params$Resource$Properties$Conversionevents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Channelgroups$Delete; + params = {} as Params$Resource$Properties$Conversionevents$Delete; options = {}; } @@ -10027,7 +10926,7 @@ export namespace analyticsadmin_v1alpha { } /** - * Lookup for a single ChannelGroup. + * Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10035,56 +10934,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Properties$Channelgroups$Get, + params: Params$Resource$Properties$Conversionevents$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Properties$Channelgroups$Get, + params?: Params$Resource$Properties$Conversionevents$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Properties$Channelgroups$Get, + params: Params$Resource$Properties$Conversionevents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Channelgroups$Get, + params: Params$Resource$Properties$Conversionevents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Channelgroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Properties$Conversionevents$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Properties$Channelgroups$Get - | BodyResponseCallback + | Params$Resource$Properties$Conversionevents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Channelgroups$Get; + {}) as Params$Resource$Properties$Conversionevents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Channelgroups$Get; + params = {} as Params$Resource$Properties$Conversionevents$Get; options = {}; } @@ -10110,19 +11009,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists ChannelGroups on a property. + * Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10130,56 +11029,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Properties$Channelgroups$List, + params: Params$Resource$Properties$Conversionevents$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Properties$Channelgroups$List, + params?: Params$Resource$Properties$Conversionevents$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Properties$Channelgroups$List, + params: Params$Resource$Properties$Conversionevents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Channelgroups$List, + params: Params$Resource$Properties$Conversionevents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Channelgroups$List, - callback: BodyResponseCallback + params: Params$Resource$Properties$Conversionevents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Properties$Channelgroups$List - | BodyResponseCallback + | Params$Resource$Properties$Conversionevents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Channelgroups$List; + {}) as Params$Resource$Properties$Conversionevents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Channelgroups$List; + params = {} as Params$Resource$Properties$Conversionevents$List; options = {}; } @@ -10193,7 +11092,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/channelGroups').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversionEvents').replace( /([^:]\/)\/+/g, '$1' ), @@ -10208,19 +11107,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ChannelGroup. + * Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10228,56 +11127,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Properties$Channelgroups$Patch, + params: Params$Resource$Properties$Conversionevents$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Properties$Channelgroups$Patch, + params?: Params$Resource$Properties$Conversionevents$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Properties$Channelgroups$Patch, + params: Params$Resource$Properties$Conversionevents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Channelgroups$Patch, + params: Params$Resource$Properties$Conversionevents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Channelgroups$Patch, - callback: BodyResponseCallback + params: Params$Resource$Properties$Conversionevents$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Properties$Channelgroups$Patch - | BodyResponseCallback + | Params$Resource$Properties$Conversionevents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Channelgroups$Patch; + {}) as Params$Resource$Properties$Conversionevents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Channelgroups$Patch; + params = {} as Params$Resource$Properties$Conversionevents$Patch; options = {}; } @@ -10303,63 +11202,63 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Channelgroups$Create + export interface Params$Resource$Properties$Conversionevents$Create extends StandardParameters { /** - * Required. The property for which to create a ChannelGroup. Example format: properties/1234 + * Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaChannelGroup; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaConversionEvent; } - export interface Params$Resource$Properties$Channelgroups$Delete + export interface Params$Resource$Properties$Conversionevents$Delete extends StandardParameters { /** - * Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678 + * Required. The resource name of the conversion event to delete. Format: properties/{property\}/conversionEvents/{conversion_event\} Example: "properties/123/conversionEvents/456" */ name?: string; } - export interface Params$Resource$Properties$Channelgroups$Get + export interface Params$Resource$Properties$Conversionevents$Get extends StandardParameters { /** - * Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678 + * Required. The resource name of the conversion event to retrieve. Format: properties/{property\}/conversionEvents/{conversion_event\} Example: "properties/123/conversionEvents/456" */ name?: string; } - export interface Params$Resource$Properties$Channelgroups$List + export interface Params$Resource$Properties$Conversionevents$List extends StandardParameters { /** - * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */ pageSize?: number; /** - * A page token, received from a previous `ListChannelGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannelGroups` must match the call that provided the page token. + * A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. */ pageToken?: string; /** - * Required. The property for which to list ChannelGroups. Example format: properties/1234 + * Required. The resource name of the parent property. Example: 'properties/123' */ parent?: string; } - export interface Params$Resource$Properties$Channelgroups$Patch + export interface Params$Resource$Properties$Conversionevents$Patch extends StandardParameters { /** - * Output only. The resource name for this Channel Group resource. Format: properties/{property\}/channelGroups/{channel_group\} + * Output only. Resource name of this conversion event. Format: properties/{property\}/conversionEvents/{conversion_event\} */ name?: string; /** @@ -10370,74 +11269,70 @@ export namespace analyticsadmin_v1alpha { /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaChannelGroup; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaConversionEvent; } - export class Resource$Properties$Conversionevents { + export class Resource$Properties$Customdimensions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a conversion event with the specified attributes. + * Archives a CustomDimension on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Properties$Conversionevents$Create, + archive( + params: Params$Resource$Properties$Customdimensions$Archive, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Properties$Conversionevents$Create, + archive( + params?: Params$Resource$Properties$Customdimensions$Archive, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Properties$Conversionevents$Create, + ): GaxiosPromise; + archive( + params: Params$Resource$Properties$Customdimensions$Archive, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Properties$Conversionevents$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Properties$Conversionevents$Create, - callback: BodyResponseCallback + archive( + params: Params$Resource$Properties$Customdimensions$Archive, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + archive( + params: Params$Resource$Properties$Customdimensions$Archive, + callback: BodyResponseCallback ): void; - create( + archive(callback: BodyResponseCallback): void; + archive( paramsOrCallback?: - | Params$Resource$Properties$Conversionevents$Create - | BodyResponseCallback + | Params$Resource$Properties$Customdimensions$Archive + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Conversionevents$Create; + {}) as Params$Resource$Properties$Customdimensions$Archive; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Conversionevents$Create; + params = {} as Params$Resource$Properties$Customdimensions$Archive; options = {}; } @@ -10451,7 +11346,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversionEvents').replace( + url: (rootUrl + '/v1alpha/{+name}:archive').replace( /([^:]\/)\/+/g, '$1' ), @@ -10461,77 +11356,79 @@ export namespace analyticsadmin_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a conversion event in a property. + * Creates a CustomDimension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Properties$Conversionevents$Delete, + create( + params: Params$Resource$Properties$Customdimensions$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Properties$Conversionevents$Delete, + create( + params?: Params$Resource$Properties$Customdimensions$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Properties$Conversionevents$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Customdimensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Properties$Conversionevents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Properties$Customdimensions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Properties$Conversionevents$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Properties$Customdimensions$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Properties$Conversionevents$Delete - | BodyResponseCallback + | Params$Resource$Properties$Customdimensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Conversionevents$Delete; + {}) as Params$Resource$Properties$Customdimensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Conversionevents$Delete; + params = {} as Params$Resource$Properties$Customdimensions$Create; options = {}; } @@ -10545,29 +11442,34 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/customDimensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieve a single conversion event. + * Lookup for a single CustomDimension. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10575,56 +11477,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Properties$Conversionevents$Get, + params: Params$Resource$Properties$Customdimensions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Properties$Conversionevents$Get, + params?: Params$Resource$Properties$Customdimensions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Properties$Conversionevents$Get, + params: Params$Resource$Properties$Customdimensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Conversionevents$Get, + params: Params$Resource$Properties$Customdimensions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Conversionevents$Get, - callback: BodyResponseCallback + params: Params$Resource$Properties$Customdimensions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Properties$Conversionevents$Get - | BodyResponseCallback + | Params$Resource$Properties$Customdimensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Conversionevents$Get; + {}) as Params$Resource$Properties$Customdimensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Conversionevents$Get; + params = {} as Params$Resource$Properties$Customdimensions$Get; options = {}; } @@ -10650,19 +11552,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. + * Lists CustomDimensions on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10670,56 +11572,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Properties$Conversionevents$List, + params: Params$Resource$Properties$Customdimensions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Properties$Conversionevents$List, + params?: Params$Resource$Properties$Customdimensions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Properties$Conversionevents$List, + params: Params$Resource$Properties$Customdimensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Conversionevents$List, + params: Params$Resource$Properties$Customdimensions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Conversionevents$List, - callback: BodyResponseCallback + params: Params$Resource$Properties$Customdimensions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Properties$Conversionevents$List - | BodyResponseCallback + | Params$Resource$Properties$Customdimensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Conversionevents$List; + {}) as Params$Resource$Properties$Customdimensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Conversionevents$List; + params = {} as Params$Resource$Properties$Customdimensions$List; options = {}; } @@ -10733,7 +11635,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversionEvents').replace( + url: (rootUrl + '/v1alpha/{+parent}/customDimensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -10748,19 +11650,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a conversion event with the specified attributes. + * Updates a CustomDimension on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10768,56 +11670,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Properties$Conversionevents$Patch, + params: Params$Resource$Properties$Customdimensions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Properties$Conversionevents$Patch, + params?: Params$Resource$Properties$Customdimensions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Properties$Conversionevents$Patch, + params: Params$Resource$Properties$Customdimensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Conversionevents$Patch, + params: Params$Resource$Properties$Customdimensions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Conversionevents$Patch, - callback: BodyResponseCallback + params: Params$Resource$Properties$Customdimensions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Properties$Conversionevents$Patch - | BodyResponseCallback + | Params$Resource$Properties$Customdimensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Conversionevents$Patch; + {}) as Params$Resource$Properties$Customdimensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Conversionevents$Patch; + params = {} as Params$Resource$Properties$Customdimensions$Patch; options = {}; } @@ -10843,84 +11745,89 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Conversionevents$Create + export interface Params$Resource$Properties$Customdimensions$Archive extends StandardParameters { /** - * Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 + * Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaConversionEvent; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest; } - export interface Params$Resource$Properties$Conversionevents$Delete + export interface Params$Resource$Properties$Customdimensions$Create extends StandardParameters { /** - * Required. The resource name of the conversion event to delete. Format: properties/{property\}/conversionEvents/{conversion_event\} Example: "properties/123/conversionEvents/456" + * Required. Example format: properties/1234 */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomDimension; } - export interface Params$Resource$Properties$Conversionevents$Get + export interface Params$Resource$Properties$Customdimensions$Get extends StandardParameters { /** - * Required. The resource name of the conversion event to retrieve. Format: properties/{property\}/conversionEvents/{conversion_event\} Example: "properties/123/conversionEvents/456" + * Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 */ name?: string; } - export interface Params$Resource$Properties$Conversionevents$List + export interface Params$Resource$Properties$Customdimensions$List extends StandardParameters { /** - * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) + * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */ pageSize?: number; /** - * A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. + * A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the parent property. Example: 'properties/123' + * Required. Example format: properties/1234 */ parent?: string; } - export interface Params$Resource$Properties$Conversionevents$Patch + export interface Params$Resource$Properties$Customdimensions$Patch extends StandardParameters { /** - * Output only. Resource name of this conversion event. Format: properties/{property\}/conversionEvents/{conversion_event\} + * Output only. Resource name for this CustomDimension resource. Format: properties/{property\}/customDimensions/{customDimension\} */ name?: string; /** - * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaConversionEvent; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomDimension; } - export class Resource$Properties$Customdimensions { + export class Resource$Properties$Custommetrics { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Archives a CustomDimension on a property. + * Archives a CustomMetric on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10928,31 +11835,31 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ archive( - params: Params$Resource$Properties$Customdimensions$Archive, + params: Params$Resource$Properties$Custommetrics$Archive, options: StreamMethodOptions ): GaxiosPromise; archive( - params?: Params$Resource$Properties$Customdimensions$Archive, + params?: Params$Resource$Properties$Custommetrics$Archive, options?: MethodOptions ): GaxiosPromise; archive( - params: Params$Resource$Properties$Customdimensions$Archive, + params: Params$Resource$Properties$Custommetrics$Archive, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; archive( - params: Params$Resource$Properties$Customdimensions$Archive, + params: Params$Resource$Properties$Custommetrics$Archive, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; archive( - params: Params$Resource$Properties$Customdimensions$Archive, + params: Params$Resource$Properties$Custommetrics$Archive, callback: BodyResponseCallback ): void; archive(callback: BodyResponseCallback): void; archive( paramsOrCallback?: - | Params$Resource$Properties$Customdimensions$Archive + | Params$Resource$Properties$Custommetrics$Archive | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10968,12 +11875,12 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Customdimensions$Archive; + {}) as Params$Resource$Properties$Custommetrics$Archive; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Customdimensions$Archive; + params = {} as Params$Resource$Properties$Custommetrics$Archive; options = {}; } @@ -11012,7 +11919,7 @@ export namespace analyticsadmin_v1alpha { } /** - * Creates a CustomDimension. + * Creates a CustomMetric. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11020,56 +11927,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Properties$Customdimensions$Create, + params: Params$Resource$Properties$Custommetrics$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Properties$Customdimensions$Create, + params?: Params$Resource$Properties$Custommetrics$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Properties$Customdimensions$Create, + params: Params$Resource$Properties$Custommetrics$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Customdimensions$Create, + params: Params$Resource$Properties$Custommetrics$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Customdimensions$Create, - callback: BodyResponseCallback + params: Params$Resource$Properties$Custommetrics$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Properties$Customdimensions$Create - | BodyResponseCallback + | Params$Resource$Properties$Custommetrics$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Customdimensions$Create; + {}) as Params$Resource$Properties$Custommetrics$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Customdimensions$Create; + params = {} as Params$Resource$Properties$Custommetrics$Create; options = {}; } @@ -11083,7 +11990,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/customDimensions').replace( + url: (rootUrl + '/v1alpha/{+parent}/customMetrics').replace( /([^:]\/)\/+/g, '$1' ), @@ -11098,19 +12005,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lookup for a single CustomDimension. + * Lookup for a single CustomMetric. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11118,56 +12025,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Properties$Customdimensions$Get, + params: Params$Resource$Properties$Custommetrics$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Properties$Customdimensions$Get, + params?: Params$Resource$Properties$Custommetrics$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Properties$Customdimensions$Get, + params: Params$Resource$Properties$Custommetrics$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Customdimensions$Get, + params: Params$Resource$Properties$Custommetrics$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Customdimensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Properties$Custommetrics$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Properties$Customdimensions$Get - | BodyResponseCallback + | Params$Resource$Properties$Custommetrics$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Customdimensions$Get; + {}) as Params$Resource$Properties$Custommetrics$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Customdimensions$Get; + params = {} as Params$Resource$Properties$Custommetrics$Get; options = {}; } @@ -11193,19 +12100,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists CustomDimensions on a property. + * Lists CustomMetrics on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11213,56 +12120,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Properties$Customdimensions$List, + params: Params$Resource$Properties$Custommetrics$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Properties$Customdimensions$List, + params?: Params$Resource$Properties$Custommetrics$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Properties$Customdimensions$List, + params: Params$Resource$Properties$Custommetrics$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Customdimensions$List, + params: Params$Resource$Properties$Custommetrics$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Customdimensions$List, - callback: BodyResponseCallback + params: Params$Resource$Properties$Custommetrics$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Properties$Customdimensions$List - | BodyResponseCallback + | Params$Resource$Properties$Custommetrics$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Customdimensions$List; + {}) as Params$Resource$Properties$Custommetrics$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Customdimensions$List; + params = {} as Params$Resource$Properties$Custommetrics$List; options = {}; } @@ -11276,7 +12183,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/customDimensions').replace( + url: (rootUrl + '/v1alpha/{+parent}/customMetrics').replace( /([^:]\/)\/+/g, '$1' ), @@ -11291,19 +12198,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a CustomDimension on a property. + * Updates a CustomMetric on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11311,56 +12218,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Properties$Customdimensions$Patch, + params: Params$Resource$Properties$Custommetrics$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Properties$Customdimensions$Patch, + params?: Params$Resource$Properties$Custommetrics$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Properties$Customdimensions$Patch, + params: Params$Resource$Properties$Custommetrics$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Customdimensions$Patch, + params: Params$Resource$Properties$Custommetrics$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Customdimensions$Patch, - callback: BodyResponseCallback + params: Params$Resource$Properties$Custommetrics$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Properties$Customdimensions$Patch - | BodyResponseCallback + | Params$Resource$Properties$Custommetrics$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Customdimensions$Patch; + {}) as Params$Resource$Properties$Custommetrics$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Customdimensions$Patch; + params = {} as Params$Resource$Properties$Custommetrics$Patch; options = {}; } @@ -11386,31 +12293,31 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Customdimensions$Archive + export interface Params$Resource$Properties$Custommetrics$Archive extends StandardParameters { /** - * Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678 + * Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest; } - export interface Params$Resource$Properties$Customdimensions$Create + export interface Params$Resource$Properties$Custommetrics$Create extends StandardParameters { /** * Required. Example format: properties/1234 @@ -11420,23 +12327,23 @@ export namespace analyticsadmin_v1alpha { /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomDimension; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomMetric; } - export interface Params$Resource$Properties$Customdimensions$Get + export interface Params$Resource$Properties$Custommetrics$Get extends StandardParameters { /** - * Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678 + * Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678 */ name?: string; } - export interface Params$Resource$Properties$Customdimensions$List + export interface Params$Resource$Properties$Custommetrics$List extends StandardParameters { /** * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */ pageSize?: number; /** - * A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. + * A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token. */ pageToken?: string; /** @@ -11444,10 +12351,10 @@ export namespace analyticsadmin_v1alpha { */ parent?: string; } - export interface Params$Resource$Properties$Customdimensions$Patch + export interface Params$Resource$Properties$Custommetrics$Patch extends StandardParameters { /** - * Output only. Resource name for this CustomDimension resource. Format: properties/{property\}/customDimensions/{customDimension\} + * Output only. Resource name for this CustomMetric resource. Format: properties/{property\}/customMetrics/{customMetric\} */ name?: string; /** @@ -11458,109 +12365,34 @@ export namespace analyticsadmin_v1alpha { /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomDimension; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomMetric; } - export class Resource$Properties$Custommetrics { + export class Resource$Properties$Datastreams { context: APIRequestContext; + eventCreateRules: Resource$Properties$Datastreams$Eventcreaterules; + eventEditRules: Resource$Properties$Datastreams$Eventeditrules; + measurementProtocolSecrets: Resource$Properties$Datastreams$Measurementprotocolsecrets; + sKAdNetworkConversionValueSchema: Resource$Properties$Datastreams$Skadnetworkconversionvalueschema; constructor(context: APIRequestContext) { this.context = context; - } - - /** - * Archives a CustomMetric on a property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - archive( - params: Params$Resource$Properties$Custommetrics$Archive, - options: StreamMethodOptions - ): GaxiosPromise; - archive( - params?: Params$Resource$Properties$Custommetrics$Archive, - options?: MethodOptions - ): GaxiosPromise; - archive( - params: Params$Resource$Properties$Custommetrics$Archive, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - archive( - params: Params$Resource$Properties$Custommetrics$Archive, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - archive( - params: Params$Resource$Properties$Custommetrics$Archive, - callback: BodyResponseCallback - ): void; - archive(callback: BodyResponseCallback): void; - archive( - paramsOrCallback?: - | Params$Resource$Properties$Custommetrics$Archive - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Custommetrics$Archive; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Custommetrics$Archive; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}:archive').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + this.eventCreateRules = + new Resource$Properties$Datastreams$Eventcreaterules(this.context); + this.eventEditRules = new Resource$Properties$Datastreams$Eventeditrules( + this.context + ); + this.measurementProtocolSecrets = + new Resource$Properties$Datastreams$Measurementprotocolsecrets( + this.context + ); + this.sKAdNetworkConversionValueSchema = + new Resource$Properties$Datastreams$Skadnetworkconversionvalueschema( + this.context ); - } else { - return createAPIRequest(parameters); - } } /** - * Creates a CustomMetric. + * Creates a DataStream. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11568,56 +12400,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Properties$Custommetrics$Create, + params: Params$Resource$Properties$Datastreams$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Properties$Custommetrics$Create, + params?: Params$Resource$Properties$Datastreams$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Properties$Custommetrics$Create, + params: Params$Resource$Properties$Datastreams$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Custommetrics$Create, + params: Params$Resource$Properties$Datastreams$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Custommetrics$Create, - callback: BodyResponseCallback + params: Params$Resource$Properties$Datastreams$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Properties$Custommetrics$Create - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Custommetrics$Create; + {}) as Params$Resource$Properties$Datastreams$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Custommetrics$Create; + params = {} as Params$Resource$Properties$Datastreams$Create; options = {}; } @@ -11631,7 +12463,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/customMetrics').replace( + url: (rootUrl + '/v1alpha/{+parent}/dataStreams').replace( /([^:]\/)\/+/g, '$1' ), @@ -11646,76 +12478,72 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lookup for a single CustomMetric. + * Deletes a DataStream on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Properties$Custommetrics$Get, + delete( + params: Params$Resource$Properties$Datastreams$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Properties$Custommetrics$Get, + delete( + params?: Params$Resource$Properties$Datastreams$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Properties$Custommetrics$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Properties$Custommetrics$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Datastreams$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Custommetrics$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Datastreams$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Datastreams$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Properties$Custommetrics$Get - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Custommetrics$Get; + {}) as Params$Resource$Properties$Datastreams$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Custommetrics$Get; + params = {} as Params$Resource$Properties$Datastreams$Delete; options = {}; } @@ -11730,7 +12558,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -11741,76 +12569,74 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists CustomMetrics on a property. + * Lookup for a single DataStream. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Properties$Custommetrics$List, + get( + params: Params$Resource$Properties$Datastreams$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Properties$Custommetrics$List, + get( + params?: Params$Resource$Properties$Datastreams$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Properties$Custommetrics$List, + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Datastreams$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Properties$Custommetrics$List, + get( + params: Params$Resource$Properties$Datastreams$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Properties$Custommetrics$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Properties$Datastreams$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Properties$Custommetrics$List - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Custommetrics$List; + {}) as Params$Resource$Properties$Datastreams$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Custommetrics$List; + params = {} as Params$Resource$Properties$Datastreams$Get; options = {}; } @@ -11824,91 +12650,89 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/customMetrics').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a CustomMetric on a property. + * Lookup for a single DataRedactionSettings. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Properties$Custommetrics$Patch, + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Properties$Custommetrics$Patch, + getDataRedactionSettings( + params?: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Properties$Custommetrics$Patch, + ): GaxiosPromise; + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Properties$Custommetrics$Patch, + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Properties$Custommetrics$Patch, - callback: BodyResponseCallback + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getDataRedactionSettings( + callback: BodyResponseCallback ): void; - patch( + getDataRedactionSettings( paramsOrCallback?: - | Params$Resource$Properties$Custommetrics$Patch - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Getdataredactionsettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Custommetrics$Patch; + {}) as Params$Resource$Properties$Datastreams$Getdataredactionsettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Custommetrics$Patch; + params = + {} as Params$Resource$Properties$Datastreams$Getdataredactionsettings; options = {}; } @@ -11923,7 +12747,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -11934,163 +12758,172 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Properties$Custommetrics$Archive - extends StandardParameters { - /** - * Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678 - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest; - } - export interface Params$Resource$Properties$Custommetrics$Create - extends StandardParameters { - /** - * Required. Example format: properties/1234 - */ - parent?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomMetric; - } - export interface Params$Resource$Properties$Custommetrics$Get - extends StandardParameters { - /** - * Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678 - */ - name?: string; - } - export interface Params$Resource$Properties$Custommetrics$List - extends StandardParameters { - /** - * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - */ - pageSize?: number; - /** - * A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. Example format: properties/1234 - */ - parent?: string; - } - export interface Params$Resource$Properties$Custommetrics$Patch - extends StandardParameters { - /** - * Output only. Resource name for this CustomMetric resource. Format: properties/{property\}/customMetrics/{customMetric\} - */ - name?: string; - /** - * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + * Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - updateMask?: string; + getEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + options: StreamMethodOptions + ): GaxiosPromise; + getEnhancedMeasurementSettings( + params?: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + options?: MethodOptions + ): GaxiosPromise; + getEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + callback: BodyResponseCallback + ): void; + getEnhancedMeasurementSettings( + callback: BodyResponseCallback + ): void; + getEnhancedMeasurementSettings( + paramsOrCallback?: + | Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaCustomMetric; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings; + options = {}; + } - export class Resource$Properties$Datastreams { - context: APIRequestContext; - eventCreateRules: Resource$Properties$Datastreams$Eventcreaterules; - eventEditRules: Resource$Properties$Datastreams$Eventeditrules; - measurementProtocolSecrets: Resource$Properties$Datastreams$Measurementprotocolsecrets; - sKAdNetworkConversionValueSchema: Resource$Properties$Datastreams$Skadnetworkconversionvalueschema; - constructor(context: APIRequestContext) { - this.context = context; - this.eventCreateRules = - new Resource$Properties$Datastreams$Eventcreaterules(this.context); - this.eventEditRules = new Resource$Properties$Datastreams$Eventeditrules( - this.context - ); - this.measurementProtocolSecrets = - new Resource$Properties$Datastreams$Measurementprotocolsecrets( - this.context + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.sKAdNetworkConversionValueSchema = - new Resource$Properties$Datastreams$Skadnetworkconversionvalueschema( - this.context + } else { + return createAPIRequest( + parameters ); + } } /** - * Creates a DataStream. + * Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Properties$Datastreams$Create, + getGlobalSiteTag( + params: Params$Resource$Properties$Datastreams$Getglobalsitetag, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Properties$Datastreams$Create, + getGlobalSiteTag( + params?: Params$Resource$Properties$Datastreams$Getglobalsitetag, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Properties$Datastreams$Create, + ): GaxiosPromise; + getGlobalSiteTag( + params: Params$Resource$Properties$Datastreams$Getglobalsitetag, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Properties$Datastreams$Create, + getGlobalSiteTag( + params: Params$Resource$Properties$Datastreams$Getglobalsitetag, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Properties$Datastreams$Create, - callback: BodyResponseCallback + getGlobalSiteTag( + params: Params$Resource$Properties$Datastreams$Getglobalsitetag, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + getGlobalSiteTag( + callback: BodyResponseCallback ): void; - create( + getGlobalSiteTag( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Create - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Getglobalsitetag + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Create; + {}) as Params$Resource$Properties$Datastreams$Getglobalsitetag; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Create; + params = {} as Params$Resource$Properties$Datastreams$Getglobalsitetag; options = {}; } @@ -12104,87 +12937,88 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStreams').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a DataStream on a property. + * Lists DataStreams on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Properties$Datastreams$Delete, + list( + params: Params$Resource$Properties$Datastreams$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Properties$Datastreams$Delete, + list( + params?: Params$Resource$Properties$Datastreams$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Properties$Datastreams$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Datastreams$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Properties$Datastreams$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Datastreams$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Properties$Datastreams$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Datastreams$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Delete - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Delete; + {}) as Params$Resource$Properties$Datastreams$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Delete; + params = {} as Params$Resource$Properties$Datastreams$List; options = {}; } @@ -12198,65 +13032,70 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/dataStreams').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lookup for a single DataStream. + * Updates a DataStream on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Properties$Datastreams$Get, + patch( + params: Params$Resource$Properties$Datastreams$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Properties$Datastreams$Get, + patch( + params?: Params$Resource$Properties$Datastreams$Patch, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Properties$Datastreams$Get, + patch( + params: Params$Resource$Properties$Datastreams$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Datastreams$Get, + patch( + params: Params$Resource$Properties$Datastreams$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Datastreams$Get, + patch( + params: Params$Resource$Properties$Datastreams$Patch, callback: BodyResponseCallback ): void; - get( + patch( callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Get + | Params$Resource$Properties$Datastreams$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12272,12 +13111,12 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Get; + {}) as Params$Resource$Properties$Datastreams$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Get; + params = {} as Params$Resource$Properties$Datastreams$Patch; options = {}; } @@ -12292,7 +13131,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -12315,43 +13154,43 @@ export namespace analyticsadmin_v1alpha { } /** - * Lookup for a single DataRedactionSettings. + * Updates a DataRedactionSettings on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, options: StreamMethodOptions ): GaxiosPromise; - getDataRedactionSettings( - params?: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + updateDataRedactionSettings( + params?: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, options?: MethodOptions ): GaxiosPromise; - getDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, callback: BodyResponseCallback ): void; - getDataRedactionSettings( + updateDataRedactionSettings( callback: BodyResponseCallback ): void; - getDataRedactionSettings( + updateDataRedactionSettings( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Getdataredactionsettings + | Params$Resource$Properties$Datastreams$Updatedataredactionsettings | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12367,13 +13206,13 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Getdataredactionsettings; + {}) as Params$Resource$Properties$Datastreams$Updatedataredactionsettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Getdataredactionsettings; + {} as Params$Resource$Properties$Datastreams$Updatedataredactionsettings; options = {}; } @@ -12388,7 +13227,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -12411,43 +13250,43 @@ export namespace analyticsadmin_v1alpha { } /** - * Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. + * Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + updateEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, options: StreamMethodOptions ): GaxiosPromise; - getEnhancedMeasurementSettings( - params?: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + updateEnhancedMeasurementSettings( + params?: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, options?: MethodOptions ): GaxiosPromise; - getEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + updateEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + updateEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings, + updateEnhancedMeasurementSettings( + params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, callback: BodyResponseCallback ): void; - getEnhancedMeasurementSettings( + updateEnhancedMeasurementSettings( callback: BodyResponseCallback ): void; - getEnhancedMeasurementSettings( + updateEnhancedMeasurementSettings( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings + | Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12463,13 +13302,13 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings; + {}) as Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings; + {} as Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings; options = {}; } @@ -12484,7 +13323,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -12505,66 +13344,185 @@ export namespace analyticsadmin_v1alpha { ); } } + } + export interface Params$Resource$Properties$Datastreams$Create + extends StandardParameters { /** - * Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. + * Required. Example format: properties/1234 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataStream; + } + export interface Params$Resource$Properties$Datastreams$Delete + extends StandardParameters { + /** + * Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$Get + extends StandardParameters { + /** + * Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$Getdataredactionsettings + extends StandardParameters { + /** + * Required. The name of the settings to lookup. Format: properties/{property\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings + extends StandardParameters { + /** + * Required. The name of the settings to lookup. Format: properties/{property\}/dataStreams/{data_stream\}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$Getglobalsitetag + extends StandardParameters { + /** + * Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id\}/dataStreams/{stream_id\}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag` + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$List + extends StandardParameters { + /** + * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + */ + pageSize?: number; + /** + * A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Example format: properties/1234 + */ + parent?: string; + } + export interface Params$Resource$Properties$Datastreams$Patch + extends StandardParameters { + /** + * Output only. Resource name of this Data Stream. Format: properties/{property_id\}/dataStreams/{stream_id\} Example: "properties/1000/dataStreams/2000" + */ + name?: string; + /** + * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataStream; + } + export interface Params$Resource$Properties$Datastreams$Updatedataredactionsettings + extends StandardParameters { + /** + * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" + */ + name?: string; + /** + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataRedactionSettings; + } + export interface Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings + extends StandardParameters { + /** + * Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id\}/dataStreams/{data_stream\}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" + */ + name?: string; + /** + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings; + } + + export class Resource$Properties$Datastreams$Eventcreaterules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an EventCreateRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getGlobalSiteTag( - params: Params$Resource$Properties$Datastreams$Getglobalsitetag, + create( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, options: StreamMethodOptions ): GaxiosPromise; - getGlobalSiteTag( - params?: Params$Resource$Properties$Datastreams$Getglobalsitetag, + create( + params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, options?: MethodOptions - ): GaxiosPromise; - getGlobalSiteTag( - params: Params$Resource$Properties$Datastreams$Getglobalsitetag, + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getGlobalSiteTag( - params: Params$Resource$Properties$Datastreams$Getglobalsitetag, + create( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getGlobalSiteTag( - params: Params$Resource$Properties$Datastreams$Getglobalsitetag, - callback: BodyResponseCallback + create( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, + callback: BodyResponseCallback ): void; - getGlobalSiteTag( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getGlobalSiteTag( + create( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Getglobalsitetag - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventcreaterules$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Getglobalsitetag; + {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Getglobalsitetag; + params = + {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Create; options = {}; } @@ -12578,88 +13536,88 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/eventCreateRules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists DataStreams on a property. + * Deletes an EventCreateRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Properties$Datastreams$List, + delete( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Properties$Datastreams$List, + delete( + params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Properties$Datastreams$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Properties$Datastreams$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Properties$Datastreams$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$List - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventcreaterules$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$List; + {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$List; + params = + {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Delete; options = {}; } @@ -12673,91 +13631,87 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStreams').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataStream on a property. + * Lookup for a single EventCreateRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Properties$Datastreams$Patch, + get( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Properties$Datastreams$Patch, + get( + params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Properties$Datastreams$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Properties$Datastreams$Patch, + get( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Properties$Datastreams$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Patch - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventcreaterules$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Patch; + {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Patch; + params = + {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Get; options = {}; } @@ -12772,7 +13726,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -12783,77 +13737,77 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataRedactionSettings on a property. + * Lists EventCreateRules on a web data stream. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + list( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, options: StreamMethodOptions ): GaxiosPromise; - updateDataRedactionSettings( - params?: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + list( + params?: Params$Resource$Properties$Datastreams$Eventcreaterules$List, options?: MethodOptions - ): GaxiosPromise; - updateDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + list( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDataRedactionSettings( - params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, + callback: BodyResponseCallback ): void; - updateDataRedactionSettings( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - updateDataRedactionSettings( + list( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Updatedataredactionsettings - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventcreaterules$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Updatedataredactionsettings; + {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Updatedataredactionsettings; + {} as Params$Resource$Properties$Datastreams$Eventcreaterules$List; options = {}; } @@ -12867,89 +13821,92 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/eventCreateRules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. + * Updates an EventCreateRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, + patch( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, options: StreamMethodOptions ): GaxiosPromise; - updateEnhancedMeasurementSettings( - params?: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, + patch( + params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, options?: MethodOptions - ): GaxiosPromise; - updateEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, + ): GaxiosPromise; + patch( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, + patch( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateEnhancedMeasurementSettings( - params: Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings, - callback: BodyResponseCallback + patch( + params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, + callback: BodyResponseCallback ): void; - updateEnhancedMeasurementSettings( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - updateEnhancedMeasurementSettings( + patch( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventcreaterules$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings; + {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings; + {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Patch; options = {}; } @@ -12975,116 +13932,63 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Datastreams$Create + export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Create extends StandardParameters { /** - * Required. Example format: properties/1234 + * Required. Example format: properties/123/dataStreams/456 */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataStream; - } - export interface Params$Resource$Properties$Datastreams$Delete - extends StandardParameters { - /** - * Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678 - */ - name?: string; - } - export interface Params$Resource$Properties$Datastreams$Get - extends StandardParameters { - /** - * Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678 - */ - name?: string; - } - export interface Params$Resource$Properties$Datastreams$Getdataredactionsettings - extends StandardParameters { - /** - * Required. The name of the settings to lookup. Format: properties/{property\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" - */ - name?: string; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventCreateRule; } - export interface Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings + export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Delete extends StandardParameters { /** - * Required. The name of the settings to lookup. Format: properties/{property\}/dataStreams/{data_stream\}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" + * Required. Example format: properties/123/dataStreams/456/eventCreateRules/789 */ name?: string; } - export interface Params$Resource$Properties$Datastreams$Getglobalsitetag + export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Get extends StandardParameters { /** - * Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id\}/dataStreams/{stream_id\}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" + * Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789 */ name?: string; } - export interface Params$Resource$Properties$Datastreams$List + export interface Params$Resource$Properties$Datastreams$Eventcreaterules$List extends StandardParameters { /** * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */ pageSize?: number; /** - * A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token. + * A page token, received from a previous `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventCreateRules` must match the call that provided the page token. */ pageToken?: string; /** - * Required. Example format: properties/1234 + * Required. Example format: properties/123/dataStreams/456 */ parent?: string; } - export interface Params$Resource$Properties$Datastreams$Patch - extends StandardParameters { - /** - * Output only. Resource name of this Data Stream. Format: properties/{property_id\}/dataStreams/{stream_id\} Example: "properties/1000/dataStreams/2000" - */ - name?: string; - /** - * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataStream; - } - export interface Params$Resource$Properties$Datastreams$Updatedataredactionsettings - extends StandardParameters { - /** - * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" - */ - name?: string; - /** - * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataRedactionSettings; - } - export interface Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings + export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Patch extends StandardParameters { /** - * Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id\}/dataStreams/{data_stream\}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings" + * Output only. Resource name for this EventCreateRule resource. Format: properties/{property\}/dataStreams/{data_stream\}/eventCreateRules/{event_create_rule\} */ name?: string; /** @@ -13095,17 +13999,17 @@ export namespace analyticsadmin_v1alpha { /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventCreateRule; } - export class Resource$Properties$Datastreams$Eventcreaterules { + export class Resource$Properties$Datastreams$Eventeditrules { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates an EventCreateRule. + * Creates an EventEditRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13113,57 +14017,57 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, + params?: Params$Resource$Properties$Datastreams$Eventeditrules$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Create, - callback: BodyResponseCallback + params: Params$Resource$Properties$Datastreams$Eventeditrules$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventcreaterules$Create - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventeditrules$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Create; + {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Create; + {} as Params$Resource$Properties$Datastreams$Eventeditrules$Create; options = {}; } @@ -13177,7 +14081,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/eventCreateRules').replace( + url: (rootUrl + '/v1alpha/{+parent}/eventEditRules').replace( /([^:]\/)\/+/g, '$1' ), @@ -13192,19 +14096,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes an EventCreateRule. + * Deletes an EventEditRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13212,31 +14116,31 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + params?: Params$Resource$Properties$Datastreams$Eventeditrules$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Delete, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventcreaterules$Delete + | Params$Resource$Properties$Datastreams$Eventeditrules$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13252,13 +14156,13 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Delete; + {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Delete; + {} as Params$Resource$Properties$Datastreams$Eventeditrules$Delete; options = {}; } @@ -13294,7 +14198,7 @@ export namespace analyticsadmin_v1alpha { } /** - * Lookup for a single EventCreateRule. + * Lookup for a single EventEditRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13302,57 +14206,57 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, + params?: Params$Resource$Properties$Datastreams$Eventeditrules$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Get, - callback: BodyResponseCallback + params: Params$Resource$Properties$Datastreams$Eventeditrules$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventcreaterules$Get - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventeditrules$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Get; + {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Get; + {} as Params$Resource$Properties$Datastreams$Eventeditrules$Get; options = {}; } @@ -13378,19 +14282,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists EventCreateRules on a web data stream. + * Lists EventEditRules on a web data stream. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13398,57 +14302,57 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, + params: Params$Resource$Properties$Datastreams$Eventeditrules$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Properties$Datastreams$Eventcreaterules$List, + params?: Params$Resource$Properties$Datastreams$Eventeditrules$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, + params: Params$Resource$Properties$Datastreams$Eventeditrules$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, + params: Params$Resource$Properties$Datastreams$Eventeditrules$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$List, - callback: BodyResponseCallback + params: Params$Resource$Properties$Datastreams$Eventeditrules$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventcreaterules$List - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventeditrules$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$List; + {}) as Params$Resource$Properties$Datastreams$Eventeditrules$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Eventcreaterules$List; + {} as Params$Resource$Properties$Datastreams$Eventeditrules$List; options = {}; } @@ -13462,7 +14366,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/eventCreateRules').replace( + url: (rootUrl + '/v1alpha/{+parent}/eventEditRules').replace( /([^:]\/)\/+/g, '$1' ), @@ -13477,19 +14381,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an EventCreateRule. + * Updates an EventEditRule. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -13497,57 +14401,57 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, + params?: Params$Resource$Properties$Datastreams$Eventeditrules$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, + params: Params$Resource$Properties$Datastreams$Eventeditrules$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Datastreams$Eventcreaterules$Patch, - callback: BodyResponseCallback + params: Params$Resource$Properties$Datastreams$Eventeditrules$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventcreaterules$Patch - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Eventeditrules$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventcreaterules$Patch; + {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Properties$Datastreams$Eventcreaterules$Patch; + {} as Params$Resource$Properties$Datastreams$Eventeditrules$Patch; options = {}; } @@ -13573,81 +14477,16 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Create - extends StandardParameters { - /** - * Required. Example format: properties/123/dataStreams/456 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventCreateRule; - } - export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Delete - extends StandardParameters { - /** - * Required. Example format: properties/123/dataStreams/456/eventCreateRules/789 - */ - name?: string; - } - export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Get - extends StandardParameters { - /** - * Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789 - */ - name?: string; - } - export interface Params$Resource$Properties$Datastreams$Eventcreaterules$List - extends StandardParameters { - /** - * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - */ - pageSize?: number; - /** - * A page token, received from a previous `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventCreateRules` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. Example format: properties/123/dataStreams/456 - */ - parent?: string; - } - export interface Params$Resource$Properties$Datastreams$Eventcreaterules$Patch - extends StandardParameters { - /** - * Output only. Resource name for this EventCreateRule resource. Format: properties/{property\}/dataStreams/{data_stream\}/eventCreateRules/{event_create_rule\} - */ - name?: string; - /** - * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventCreateRule; - } - - export class Resource$Properties$Datastreams$Eventeditrules { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** * Changes the processing order of event edit rules on the specified stream. @@ -13742,6 +14581,63 @@ export namespace analyticsadmin_v1alpha { } } + export interface Params$Resource$Properties$Datastreams$Eventeditrules$Create + extends StandardParameters { + /** + * Required. Example format: properties/123/dataStreams/456 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventEditRule; + } + export interface Params$Resource$Properties$Datastreams$Eventeditrules$Delete + extends StandardParameters { + /** + * Required. Example format: properties/123/dataStreams/456/eventEditRules/789 + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$Eventeditrules$Get + extends StandardParameters { + /** + * Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789 + */ + name?: string; + } + export interface Params$Resource$Properties$Datastreams$Eventeditrules$List + extends StandardParameters { + /** + * Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListEventEditRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventEditRules` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Example format: properties/123/dataStreams/456 + */ + parent?: string; + } + export interface Params$Resource$Properties$Datastreams$Eventeditrules$Patch + extends StandardParameters { + /** + * Identifier. Resource name for this EventEditRule resource. Format: properties/{property\}/dataStreams/{data_stream\}/eventEditRules/{event_edit_rule\} + */ + name?: string; + /** + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaEventEditRule; + } export interface Params$Resource$Properties$Datastreams$Eventeditrules$Reorder extends StandardParameters { /** @@ -16874,7 +17770,7 @@ export namespace analyticsadmin_v1alpha { export interface Params$Resource$Properties$Firebaselinks$Create extends StandardParameters { /** - * Required. Format: properties/{property_id\} Example: properties/1234 + * Required. Format: properties/{property_id\} Example: `properties/1234` */ parent?: string; @@ -16886,7 +17782,7 @@ export namespace analyticsadmin_v1alpha { export interface Params$Resource$Properties$Firebaselinks$Delete extends StandardParameters { /** - * Required. Format: properties/{property_id\}/firebaseLinks/{firebase_link_id\} Example: properties/1234/firebaseLinks/5678 + * Required. Format: properties/{property_id\}/firebaseLinks/{firebase_link_id\} Example: `properties/1234/firebaseLinks/5678` */ name?: string; } @@ -16901,7 +17797,7 @@ export namespace analyticsadmin_v1alpha { */ pageToken?: string; /** - * Required. Format: properties/{property_id\} Example: properties/1234 + * Required. Format: properties/{property_id\} Example: `properties/1234` */ parent?: string; } diff --git a/src/apis/analyticsadmin/v1beta.ts b/src/apis/analyticsadmin/v1beta.ts index 7169dde47b..fb4c113283 100644 --- a/src/apis/analyticsadmin/v1beta.ts +++ b/src/apis/analyticsadmin/v1beta.ts @@ -1161,15 +1161,6 @@ export namespace analyticsadmin_v1beta { */ accountTicketId?: string | null; } - /** - * Request message for ReorderEventEditRules RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest { - /** - * Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list. - */ - eventEditRules?: string[] | null; - } /** * The request for a Data Access Record Report. */ @@ -1277,7 +1268,7 @@ export namespace analyticsadmin_v1beta { */ pageToken?: string | null; /** - * Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId\} Example: "properties/100" + * Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId\} Example: `properties/100` */ property?: string | null; /** @@ -2083,7 +2074,7 @@ export namespace analyticsadmin_v1beta { export interface Params$Resource$Accounts$Getdatasharingsettings extends StandardParameters { /** - * Required. The name of the settings to lookup. Format: accounts/{account\}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" + * Required. The name of the settings to lookup. Format: accounts/{account\}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` */ name?: string; } @@ -2138,7 +2129,7 @@ export namespace analyticsadmin_v1beta { export interface Params$Resource$Accounts$Searchchangehistoryevents extends StandardParameters { /** - * Required. The account resource for which to return change history resources. Format: accounts/{account\} Example: "accounts/100" + * Required. The account resource for which to return change history resources. Format: accounts/{account\} Example: `accounts/100` */ account?: string; @@ -3257,7 +3248,7 @@ export namespace analyticsadmin_v1beta { } /** - * Creates a conversion event with the specified attributes. + * Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3355,7 +3346,7 @@ export namespace analyticsadmin_v1beta { } /** - * Deletes a conversion event in a property. + * Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3444,7 +3435,7 @@ export namespace analyticsadmin_v1beta { } /** - * Retrieve a single conversion event. + * Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3539,7 +3530,7 @@ export namespace analyticsadmin_v1beta { } /** - * Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. + * Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3637,7 +3628,7 @@ export namespace analyticsadmin_v1beta { } /** - * Updates a conversion event with the specified attributes. + * Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4888,13 +4879,9 @@ export namespace analyticsadmin_v1beta { export class Resource$Properties$Datastreams { context: APIRequestContext; - eventEditRules: Resource$Properties$Datastreams$Eventeditrules; measurementProtocolSecrets: Resource$Properties$Datastreams$Measurementprotocolsecrets; constructor(context: APIRequestContext) { this.context = context; - this.eventEditRules = new Resource$Properties$Datastreams$Eventeditrules( - this.context - ); this.measurementProtocolSecrets = new Resource$Properties$Datastreams$Measurementprotocolsecrets( this.context @@ -5435,119 +5422,6 @@ export namespace analyticsadmin_v1beta { requestBody?: Schema$GoogleAnalyticsAdminV1betaDataStream; } - export class Resource$Properties$Datastreams$Eventeditrules { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Changes the processing order of event edit rules on the specified stream. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: StreamMethodOptions - ): GaxiosPromise; - reorder( - params?: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options?: MethodOptions - ): GaxiosPromise; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - reorder( - params: Params$Resource$Properties$Datastreams$Eventeditrules$Reorder, - callback: BodyResponseCallback - ): void; - reorder(callback: BodyResponseCallback): void; - reorder( - paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Eventeditrules$Reorder - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Eventeditrules$Reorder; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Properties$Datastreams$Eventeditrules$Reorder; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+parent}/eventEditRules:reorder').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Properties$Datastreams$Eventeditrules$Reorder - extends StandardParameters { - /** - * Required. Example format: properties/123/dataStreams/456 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest; - } - export class Resource$Properties$Datastreams$Measurementprotocolsecrets { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -6386,7 +6260,7 @@ export namespace analyticsadmin_v1beta { export interface Params$Resource$Properties$Firebaselinks$Create extends StandardParameters { /** - * Required. Format: properties/{property_id\} Example: properties/1234 + * Required. Format: properties/{property_id\} Example: `properties/1234` */ parent?: string; @@ -6398,7 +6272,7 @@ export namespace analyticsadmin_v1beta { export interface Params$Resource$Properties$Firebaselinks$Delete extends StandardParameters { /** - * Required. Format: properties/{property_id\}/firebaseLinks/{firebase_link_id\} Example: properties/1234/firebaseLinks/5678 + * Required. Format: properties/{property_id\}/firebaseLinks/{firebase_link_id\} Example: `properties/1234/firebaseLinks/5678` */ name?: string; } @@ -6413,7 +6287,7 @@ export namespace analyticsadmin_v1beta { */ pageToken?: string; /** - * Required. Format: properties/{property_id\} Example: properties/1234 + * Required. Format: properties/{property_id\} Example: `properties/1234` */ parent?: string; } diff --git a/src/apis/analyticsdata/v1beta.ts b/src/apis/analyticsdata/v1beta.ts index 37d2e6b55c..49766dbfed 100644 --- a/src/apis/analyticsdata/v1beta.ts +++ b/src/apis/analyticsdata/v1beta.ts @@ -1210,7 +1210,7 @@ export namespace analyticsdata_v1beta { */ limit?: string | null; /** - * Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". + * Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges. */ metricAggregations?: string[] | null; /** @@ -1226,7 +1226,7 @@ export namespace analyticsdata_v1beta { */ offset?: string | null; /** - * Specifies how rows are ordered in the response. + * Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons. */ orderBys?: Schema$OrderBy[]; /** diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index 427ba15534..da6863b9ae 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -1995,7 +1995,7 @@ export namespace analyticshub_v1 { } /** - * Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets. + * Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index eaeee5b572..b9cb7a314e 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -3609,6 +3609,10 @@ export namespace androidenterprise_v1 { } export interface Params$Resource$Enterprises$Generatesignupurl extends StandardParameters { + /** + * Optional. Email address used to prefill the admin field of the enterprise signup form. This value is a hint only and can be altered by the user. + */ + adminEmail?: string; /** * The callback URL to which the Admin will be redirected after successfully creating an enterprise. Before redirecting there the system will add a single query parameter to this URL named "enterpriseToken" which will contain an opaque token to be used for the CompleteSignup request. Beware that this means that the URL will be parsed, the parameter added and then a new URL formatted, i.e. there may be some minor formatting changes and, more importantly, the URL must be well-formed so that it can be parsed. */ diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index aa07a81438..9095720ce1 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -146,7 +146,7 @@ export namespace androidmanagement_v1 { */ export interface Schema$AdvancedSecurityOverrides { /** - * Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. + * Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, including AES-GCM encryption of Bluetooth Long Term Keys, and Wi-Fi configuration stores.Common Criteria Mode is only supported on company-owned devices running Android 11 or above.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. */ commonCriteriaMode?: string | null; /** @@ -884,7 +884,7 @@ export namespace androidmanagement_v1 { */ appliedState?: string | null; /** - * Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy. + * Information about Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC).This information is only available if statusReportingSettings.commonCriteriaModeEnabled is true in the device's policy the device is company-owned. */ commonCriteriaModeInfo?: Schema$CommonCriteriaModeInfo; /** @@ -2777,6 +2777,10 @@ export namespace androidmanagement_v1 { * Controls whether personal usage is allowed on a device provisioned with this enrollment token.For company-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage requires the user provision the device as a fully managed device.For personally-owned devices: Enabling personal usage allows the user to set up a work profile on the device. Disabling personal usage will prevent the device from provisioning. Personal usage cannot be disabled on personally-owned device. */ allowPersonalUsage?: string | null; + /** + * Optional. Whether the sign-in URL should be used by default for the enterprise. The SigninDetail with defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT is used for Google account enrollment method. Only one of an enterprise's signinDetails can have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT. If an Enterprise has at least one signinDetails and none of them have defaultStatus set to SIGNIN_DETAIL_IS_DEFAULT then the first one from the list is selected and has set defaultStatus to SIGNIN_DETAIL_IS_DEFAULT. If no signinDetails specified for the Enterprise then the Google Account device enrollment will fail. + */ + defaultStatus?: string | null; /** * A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized java.util.Properties representation of the properties in the JSON. This is a read-only field generated by the server. */ @@ -2933,7 +2937,7 @@ export namespace androidmanagement_v1 { */ applicationReportsEnabled?: boolean | null; /** - * Whether Common Criteria Mode reporting is enabled. + * Whether Common Criteria Mode reporting is enabled. This is supported only on company-owned devices. */ commonCriteriaModeEnabled?: boolean | null; /** @@ -4792,7 +4796,7 @@ export namespace androidmanagement_v1 { } /** - * Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused. + * Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index e702e47b80..9a443a03d8 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -1327,7 +1327,7 @@ export namespace androidpublisher_v3 { */ testPurchase?: Schema$ExternalTransactionTestPurchase; /** - * Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. + * Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. */ transactionProgramCode?: number | null; /** @@ -2083,7 +2083,7 @@ export namespace androidpublisher_v3 { units?: string | null; } /** - * Represents a list of apis. + * Represents a list of ABIs. */ export interface Schema$MultiAbi { /** @@ -2419,15 +2419,15 @@ export namespace androidpublisher_v3 { regionCode?: string | null; } /** - * Configuration for a price migration. + * Configuration for migration of a legacy price cohort. */ export interface Schema$RegionalPriceMigrationConfig { /** - * Required. The cutoff time for historical prices that subscribers can remain paying. Subscribers on prices which were available at this cutoff time or later will stay on their existing price. Subscribers on older prices will be migrated to the currently-offered price. The migrated subscribers will receive a notification that they will be paying a different price. Subscribers who do not agree to the new price will have their subscription ended at the next renewal. + * Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type. */ oldestAllowedPriceVersionTime?: string | null; /** - * Optional. The behavior the caller wants users to see when there is a price increase during migration. If left unset, the behavior defaults to PRICE_INCREASE_TYPE_OPT_IN. Note that the first opt-out price increase migration for each app must be initiated in Play Console. + * Optional. The requested type of price increase */ priceIncreaseType?: string | null; /** @@ -2629,11 +2629,19 @@ export namespace androidpublisher_v3 { * Revocation context of the purchases.subscriptionsv2.revoke API. */ export interface Schema$RevocationContext { + /** + * Optional. Used when users should be refunded the full amount of the latest order of the subscription. + */ + fullRefund?: Schema$RevocationContextFullRefund; /** * Optional. Used when users should be refunded a prorated amount they paid for their subscription based on the amount of time remaining in a subscription. */ proratedRefund?: Schema$RevocationContextProratedRefund; } + /** + * Used to determine if the refund type in the RevocationContext is a full refund. + */ + export interface Schema$RevocationContextFullRefund {} /** * Used to determine if the refund type in the RevocationContext is a prorated refund. */ @@ -4378,102 +4386,6 @@ export namespace androidpublisher_v3 { } } - /** - * List all app recovery action resources associated with a particular package name and app version. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - options: StreamMethodOptions - ): GaxiosPromise; - appRecoveries( - params?: Params$Resource$Apprecovery$Apprecoveries, - options?: MethodOptions - ): GaxiosPromise; - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - appRecoveries( - params: Params$Resource$Apprecovery$Apprecoveries, - callback: BodyResponseCallback - ): void; - appRecoveries( - callback: BodyResponseCallback - ): void; - appRecoveries( - paramsOrCallback?: - | Params$Resource$Apprecovery$Apprecoveries - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Apprecovery$Apprecoveries; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Apprecovery$Apprecoveries; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://androidpublisher.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidpublisher/v3/applications/{packageName}/appRecoveries' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['packageName'], - pathParams: ['packageName'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED. * @@ -4757,6 +4669,101 @@ export namespace androidpublisher_v3 { return createAPIRequest(parameters); } } + + /** + * List all app recovery action resources associated with a particular package name and app version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Apprecovery$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Apprecovery$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Apprecovery$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Apprecovery$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Apprecovery$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Apprecovery$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Apprecovery$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Apprecovery$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://androidpublisher.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/androidpublisher/v3/applications/{packageName}/appRecoveries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Apprecovery$Addtargeting @@ -4775,17 +4782,6 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$AddTargetingRequest; } - export interface Params$Resource$Apprecovery$Apprecoveries - extends StandardParameters { - /** - * Required. Package name of the app for which list of recovery actions is requested. - */ - packageName?: string; - /** - * Required. Version code targeted by the list of recovery actions. - */ - versionCode?: string; - } export interface Params$Resource$Apprecovery$Cancel extends StandardParameters { /** @@ -4830,6 +4826,16 @@ export namespace androidpublisher_v3 { */ requestBody?: Schema$DeployAppRecoveryRequest; } + export interface Params$Resource$Apprecovery$List extends StandardParameters { + /** + * Required. Package name of the app for which list of recovery actions is requested. + */ + packageName?: string; + /** + * Required. Version code targeted by the list of recovery actions. + */ + versionCode?: string; + } export class Resource$Edits { context: APIRequestContext; @@ -12615,7 +12621,7 @@ export namespace androidpublisher_v3 { } /** - * Migrates subscribers who are receiving an historical subscription price to the currently-offered price for the specified region. Requests will cause price change notifications to be sent to users who are currently receiving an historical price older than the supplied timestamp. Subscribers who do not agree to the new price will have their subscription ended at the next renewal. + * Migrates subscribers from one or more legacy price cohorts to the current price. Requests result in Google Play notifying affected subscribers. Only up to 250 simultaneous legacy price cohorts are supported. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/apikeys/v2.ts b/src/apis/apikeys/v2.ts index 87337bc957..bcf803a10f 100644 --- a/src/apis/apikeys/v2.ts +++ b/src/apis/apikeys/v2.ts @@ -201,7 +201,7 @@ export namespace apikeys_v2 { */ methods?: string[] | null; /** - * The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. + * The service for this restriction. It should be the canonical service name, for example: `translate.googleapis.com`. You can use [`gcloud services list`](https://cloud.google.com/sdk/gcloud/reference/services/list) to get a list of services that are enabled in the project. */ service?: string | null; } diff --git a/src/apis/apim/v1alpha.ts b/src/apis/apim/v1alpha.ts index 408355ea72..e5ba00e1e7 100644 --- a/src/apis/apim/v1alpha.ts +++ b/src/apis/apim/v1alpha.ts @@ -194,6 +194,24 @@ export namespace apim_v1alpha { */ name?: string | null; } + /** + * Message for requesting batch edit tags for ApiObservations + */ + export interface Schema$BatchEditTagsApiObservationsRequest { + /** + * Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch. + */ + requests?: Schema$EditTagsApiObservationsRequest[]; + } + /** + * Message for response to edit Tags for ApiObservations + */ + export interface Schema$BatchEditTagsApiObservationsResponse { + /** + * ApiObservations that were changed + */ + apiObservations?: Schema$ApiObservation[]; + } /** * The request message for Operations.CancelOperation. */ @@ -202,6 +220,19 @@ export namespace apim_v1alpha { * Message for disabling an ObservationJob */ export interface Schema$DisableObservationJobRequest {} + /** + * Message for requesting edit tags for ApiObservation + */ + export interface Schema$EditTagsApiObservationsRequest { + /** + * Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443" + */ + apiObservationId?: string | null; + /** + * Required. Tag actions to be applied + */ + tagActions?: Schema$TagAction[]; + } /** * 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); \} */ @@ -343,6 +374,19 @@ export namespace apim_v1alpha { */ nextPageToken?: string | null; } + /** + * Message for response to listing tags + */ + export interface Schema$ListApiObservationTagsResponse { + /** + * The tags from the specified project + */ + apiObservationTags?: string[] | null; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Message for response to listing ApiOperations */ @@ -566,6 +610,19 @@ export namespace apim_v1alpha { */ message?: string | null; } + /** + * Message for edit tag action + */ + export interface Schema$TagAction { + /** + * Required. Action to be applied + */ + action?: string | null; + /** + * Required. Tag to be added or removed + */ + tag?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -770,6 +827,103 @@ export namespace apim_v1alpha { return createAPIRequest(parameters); } } + + /** + * ListApiObservationTags lists all extant tags on any observation in the given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listApiObservationTags( + params: Params$Resource$Projects$Locations$Listapiobservationtags, + options: StreamMethodOptions + ): GaxiosPromise; + listApiObservationTags( + params?: Params$Resource$Projects$Locations$Listapiobservationtags, + options?: MethodOptions + ): GaxiosPromise; + listApiObservationTags( + params: Params$Resource$Projects$Locations$Listapiobservationtags, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listApiObservationTags( + params: Params$Resource$Projects$Locations$Listapiobservationtags, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listApiObservationTags( + params: Params$Resource$Projects$Locations$Listapiobservationtags, + callback: BodyResponseCallback + ): void; + listApiObservationTags( + callback: BodyResponseCallback + ): void; + listApiObservationTags( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Listapiobservationtags + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Listapiobservationtags; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Listapiobservationtags; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apim.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}:listApiObservationTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Locations$Get @@ -798,6 +952,21 @@ export namespace apim_v1alpha { */ pageToken?: string; } + export interface Params$Resource$Projects$Locations$Listapiobservationtags + extends StandardParameters { + /** + * Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent, which owns this collection of tags. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + } export class Resource$Projects$Locations$Observationjobs { context: APIRequestContext; @@ -1249,7 +1418,7 @@ export namespace apim_v1alpha { } /** - * ListObservationJobs gets all ObservationJobs for a given project and location + * ListObservationJobs gets all ObservationJobs for a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1429,6 +1598,103 @@ export namespace apim_v1alpha { ); } + /** + * BatchEditTagsApiObservations adds or removes Tags for ApiObservations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchEditTags( + params: Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags, + options: StreamMethodOptions + ): GaxiosPromise; + batchEditTags( + params?: Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags, + options?: MethodOptions + ): GaxiosPromise; + batchEditTags( + params: Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchEditTags( + params: Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchEditTags( + params: Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags, + callback: BodyResponseCallback + ): void; + batchEditTags( + callback: BodyResponseCallback + ): void; + batchEditTags( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://apim.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/apiObservations:batchEditTags' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * GetApiObservation retrieves a single ApiObservation by name. * @@ -1516,7 +1782,7 @@ export namespace apim_v1alpha { } /** - * ListApiObservations gets all ApiObservations for a given project and location and ObservationJob + * ListApiObservations gets all ApiObservations for a given project and location and ObservationJob. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1612,6 +1878,18 @@ export namespace apim_v1alpha { } } + export interface Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Batchedittags + extends StandardParameters { + /** + * Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project\}/locations/{location\}/observationJobs/{observation_job\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchEditTagsApiObservationsRequest; + } export interface Params$Resource$Projects$Locations$Observationjobs$Apiobservations$Get extends StandardParameters { /** @@ -1728,7 +2006,7 @@ export namespace apim_v1alpha { } /** - * ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation + * ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2118,7 +2396,7 @@ export namespace apim_v1alpha { } /** - * ListObservationSources gets all ObservationSources for a given project and location + * ListObservationSources gets all ObservationSources for a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/appengine/v1.ts b/src/apis/appengine/v1.ts index 39211ed319..6f4d784056 100644 --- a/src/apis/appengine/v1.ts +++ b/src/apis/appengine/v1.ts @@ -1453,7 +1453,7 @@ export namespace appengine_v1 { */ generatedCustomerMetadata?: {[key: string]: any} | null; /** - * Relative name of the service within the application. Example: default.@OutputOnly + * Output only. Relative name of the service within the application. Example: default.@OutputOnly */ id?: string | null; /** @@ -1461,7 +1461,7 @@ export namespace appengine_v1 { */ labels?: {[key: string]: string} | null; /** - * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + * Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly */ name?: string | null; /** @@ -1657,7 +1657,7 @@ export namespace appengine_v1 { */ buildEnvVariables?: {[key: string]: string} | null; /** - * Email address of the user who created this version.@OutputOnly + * Output only. Email address of the user who created this version.@OutputOnly */ createdBy?: string | null; /** @@ -1673,7 +1673,7 @@ export namespace appengine_v1 { */ deployment?: Schema$Deployment; /** - * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + * Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly */ diskUsageBytes?: string | null; /** @@ -1737,7 +1737,7 @@ export namespace appengine_v1 { */ manualScaling?: Schema$ManualScaling; /** - * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + * Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly */ name?: string | null; /** @@ -1785,7 +1785,7 @@ export namespace appengine_v1 { */ threadsafe?: boolean | null; /** - * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + * Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly */ versionUrl?: string | null; /** diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 42d6028327..96da6cd4e1 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -1495,7 +1495,7 @@ export namespace appengine_v1beta { */ generatedCustomerMetadata?: {[key: string]: any} | null; /** - * Relative name of the service within the application. Example: default.@OutputOnly + * Output only. Relative name of the service within the application. Example: default.@OutputOnly */ id?: string | null; /** @@ -1503,7 +1503,7 @@ export namespace appengine_v1beta { */ labels?: {[key: string]: string} | null; /** - * Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + * Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly */ name?: string | null; /** @@ -1699,7 +1699,7 @@ export namespace appengine_v1beta { */ buildEnvVariables?: {[key: string]: string} | null; /** - * Email address of the user who created this version.@OutputOnly + * Output only. Email address of the user who created this version.@OutputOnly */ createdBy?: string | null; /** @@ -1715,7 +1715,7 @@ export namespace appengine_v1beta { */ deployment?: Schema$Deployment; /** - * Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + * Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly */ diskUsageBytes?: string | null; /** @@ -1779,7 +1779,7 @@ export namespace appengine_v1beta { */ manualScaling?: Schema$ManualScaling; /** - * Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + * Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly */ name?: string | null; /** @@ -1827,7 +1827,7 @@ export namespace appengine_v1beta { */ threadsafe?: boolean | null; /** - * Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + * Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly */ versionUrl?: string | null; /** diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index 5dffe53a72..072ab70369 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -1049,7 +1049,15 @@ export namespace artifactregistry_v1 { * The name of the project's settings. Always of the form: projects/{project-id\}/projectSettings In update request: never set In response: always set */ name?: string | null; + /** + * The percentage of pull traffic to redirect from GCR to AR when using partial redirection. + */ + pullPercent?: number | null; } + /** + * The metadata for promote artifact long running operation. + */ + export interface Schema$PromoteArtifactMetadata {} /** * PythonPackage represents a python artifact. */ @@ -1315,7 +1323,7 @@ export namespace artifactregistry_v1 { */ filename?: string | null; /** - * The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters. + * The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters. */ packageId?: string | null; /** @@ -5985,7 +5993,7 @@ export namespace artifactregistry_v1 { export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$List extends StandardParameters { /** - * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --\> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --\> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/x%2Fb%2Fc"` --\> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/x%2Fb%2F*"` --\> tags with an ID containing "/b/". + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --\> Tags that are applied to the version `1.0` in package `pkg1`. */ filter?: string; /** diff --git a/src/apis/artifactregistry/v1beta1.ts b/src/apis/artifactregistry/v1beta1.ts index 2c9536b6c4..cb9d9a6b7d 100644 --- a/src/apis/artifactregistry/v1beta1.ts +++ b/src/apis/artifactregistry/v1beta1.ts @@ -2674,7 +2674,7 @@ export namespace artifactregistry_v1beta1 { export interface Params$Resource$Projects$Locations$Repositories$Packages$Tags$List extends StandardParameters { /** - * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --\> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --\> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/x%2Fb%2Fc"` --\> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/x%2Fb%2F*"` --\> tags with an ID containing "/b/". + * An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --\> Tags that are applied to the version `1.0` in package `pkg1`. */ filter?: string; /** diff --git a/src/apis/assuredworkloads/v1.ts b/src/apis/assuredworkloads/v1.ts index 90e5c2c81a..1e889f658c 100644 --- a/src/apis/assuredworkloads/v1.ts +++ b/src/apis/assuredworkloads/v1.ts @@ -605,6 +605,10 @@ export namespace assuredworkloads_v1 { * Permissions granted to the AW Partner SA account for the customer workload */ export interface Schema$GoogleCloudAssuredworkloadsV1WorkloadPartnerPermissions { + /** + * Optional. Allow partner to view support case details for an AXT log + */ + accessTransparencyLogsSupportCaseViewer?: boolean | null; /** * Optional. Allow partner to view violation alerts. */ diff --git a/src/apis/assuredworkloads/v1beta1.ts b/src/apis/assuredworkloads/v1beta1.ts index 44eefd6130..3da38666ab 100644 --- a/src/apis/assuredworkloads/v1beta1.ts +++ b/src/apis/assuredworkloads/v1beta1.ts @@ -652,6 +652,10 @@ export namespace assuredworkloads_v1beta1 { * Permissions granted to the AW Partner SA account for the customer workload */ export interface Schema$GoogleCloudAssuredworkloadsV1beta1WorkloadPartnerPermissions { + /** + * Optional. Allow partner to view support case details for an AXT log + */ + accessTransparencyLogsSupportCaseViewer?: boolean | null; /** * Optional. Allow partner to view violation alerts. */ diff --git a/src/apis/authorizedbuyersmarketplace/index.ts b/src/apis/authorizedbuyersmarketplace/index.ts index 5afcd7b885..b382f0ff4a 100644 --- a/src/apis/authorizedbuyersmarketplace/index.ts +++ b/src/apis/authorizedbuyersmarketplace/index.ts @@ -15,9 +15,11 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {authorizedbuyersmarketplace_v1} from './v1'; +import {authorizedbuyersmarketplace_v1alpha} from './v1alpha'; export const VERSIONS = { v1: authorizedbuyersmarketplace_v1.Authorizedbuyersmarketplace, + v1alpha: authorizedbuyersmarketplace_v1alpha.Authorizedbuyersmarketplace, }; export function authorizedbuyersmarketplace( @@ -26,11 +28,23 @@ export function authorizedbuyersmarketplace( export function authorizedbuyersmarketplace( options: authorizedbuyersmarketplace_v1.Options ): authorizedbuyersmarketplace_v1.Authorizedbuyersmarketplace; +export function authorizedbuyersmarketplace( + version: 'v1alpha' +): authorizedbuyersmarketplace_v1alpha.Authorizedbuyersmarketplace; +export function authorizedbuyersmarketplace( + options: authorizedbuyersmarketplace_v1alpha.Options +): authorizedbuyersmarketplace_v1alpha.Authorizedbuyersmarketplace; export function authorizedbuyersmarketplace< - T = authorizedbuyersmarketplace_v1.Authorizedbuyersmarketplace, + T = + | authorizedbuyersmarketplace_v1.Authorizedbuyersmarketplace + | authorizedbuyersmarketplace_v1alpha.Authorizedbuyersmarketplace, >( this: GoogleConfigurable, - versionOrOptions: 'v1' | authorizedbuyersmarketplace_v1.Options + versionOrOptions: + | 'v1' + | authorizedbuyersmarketplace_v1.Options + | 'v1alpha' + | authorizedbuyersmarketplace_v1alpha.Options ) { return getAPI( 'authorizedbuyersmarketplace', @@ -43,6 +57,7 @@ export function authorizedbuyersmarketplace< const auth = new AuthPlus(); export {auth}; export {authorizedbuyersmarketplace_v1}; +export {authorizedbuyersmarketplace_v1alpha}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts new file mode 100644 index 0000000000..46488efbba --- /dev/null +++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts @@ -0,0 +1,6102 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace authorizedbuyersmarketplace_v1alpha { + export interface Options extends GlobalOptions { + version: 'v1alpha'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Authorized Buyers Marketplace API + * + * The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const authorizedbuyersmarketplace = google.authorizedbuyersmarketplace('v1alpha'); + * ``` + */ + export class Authorizedbuyersmarketplace { + context: APIRequestContext; + bidders: Resource$Bidders; + buyers: Resource$Buyers; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.bidders = new Resource$Bidders(this.context); + this.buyers = new Resource$Buyers(this.context); + } + } + + /** + * Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any. + */ + export interface Schema$AcceptProposalRequest { + /** + * The last known client revision number of the proposal. + */ + proposalRevision?: string | null; + } + /** + * Request message for activating a client. + */ + export interface Schema$ActivateClientRequest {} + /** + * Request message for activating a client user. + */ + export interface Schema$ActivateClientUserRequest {} + /** + * Request message for activating a data segment + */ + export interface Schema$ActivateDataSegmentRequest {} + /** + * Request message for adding creative to be used in the bidding process for the finalized deal. + */ + export interface Schema$AddCreativeRequest { + /** + * Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId\}/creatives/{creativeId\}`. See creative.name. + */ + creative?: string | null; + } + /** + * Request to add a note. + */ + export interface Schema$AddNoteRequest { + /** + * The note to add. + */ + note?: Schema$Note; + } + /** + * Represents size of a single ad slot, or a creative. + */ + export interface Schema$AdSize { + /** + * The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`. + */ + height?: string | null; + /** + * The type of the ad slot size. + */ + type?: string | null; + /** + * The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`. + */ + width?: string | null; + } + /** + * Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers. + */ + export interface Schema$AuctionPackage { + /** + * Output only. Time the auction package was created. + */ + createTime?: string | null; + /** + * Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId\}` + */ + creator?: string | null; + /** + * Output only. A description of the auction package. + */ + description?: string | null; + /** + * The display_name assigned to the auction package. + */ + displayName?: string | null; + /** + * Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace. + */ + eligibleSeatIds?: string[] | null; + /** + * Immutable. The unique identifier for the auction package. Format: `buyers/{accountId\}/auctionPackages/{auctionPackageId\}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse. + */ + name?: string | null; + /** + * Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId\}` + */ + subscribedBuyers?: string[] | null; + /** + * Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}` + */ + subscribedClients?: string[] | null; + /** + * Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. + */ + subscribedMediaPlanners?: Schema$MediaPlanner[]; + /** + * Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed. + */ + updateTime?: string | null; + } + /** + * Request message for batch updating deals. + */ + export interface Schema$BatchUpdateDealsRequest { + /** + * Required. List of request messages to update deals. + */ + requests?: Schema$UpdateDealRequest[]; + } + /** + * Response message for batch updating deals. + */ + export interface Schema$BatchUpdateDealsResponse { + /** + * Deals updated. + */ + deals?: Schema$Deal[]; + } + /** + * Request to cancel an ongoing negotiation. + */ + export interface Schema$CancelNegotiationRequest {} + /** + * A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI. + */ + export interface Schema$Client { + /** + * Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed. + */ + displayName?: string | null; + /** + * Output only. The resource name of the client. Format: `buyers/{accountId\}/clients/{clientAccountId\}` + */ + name?: string | null; + /** + * Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients. + */ + partnerClientId?: string | null; + /** + * Required. The role assigned to the client. Each role implies a set of permissions granted to the client. + */ + role?: string | null; + /** + * Whether the client will be visible to sellers. + */ + sellerVisible?: boolean | null; + /** + * Output only. The state of the client. + */ + state?: string | null; + } + /** + * A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client. + */ + export interface Schema$ClientUser { + /** + * Required. The client user's email address that has to be unique across all users for the same client. + */ + email?: string | null; + /** + * Output only. The resource name of the client user. Format: `buyers/{accountId\}/clients/{clientAccountId\}/users/{userId\}` + */ + name?: string | null; + /** + * Output only. The state of the client user. + */ + state?: string | null; + } + /** + * Contains information on how a buyer or seller can be reached. + */ + export interface Schema$Contact { + /** + * The display_name of the contact. + */ + displayName?: string | null; + /** + * Email address for the contact. + */ + email?: string | null; + } + /** + * Message captures data about the creatives in the deal. + */ + export interface Schema$CreativeRequirements { + /** + * Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals. + */ + creativeFormat?: string | null; + /** + * Output only. Specifies the creative pre-approval policy. + */ + creativePreApprovalPolicy?: string | null; + /** + * Output only. Specifies whether the creative is safeFrame compatible. + */ + creativeSafeFrameCompatibility?: string | null; + /** + * Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives. + */ + maxAdDurationMs?: string | null; + /** + * Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer. + */ + programmaticCreativeSource?: string | null; + /** + * Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives. + */ + skippableAdType?: string | null; + } + /** + * Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. + */ + export interface Schema$CriteriaTargeting { + /** + * A list of numeric IDs to be excluded. + */ + excludedCriteriaIds?: string[] | null; + /** + * A list of numeric IDs to be included. + */ + targetedCriteriaIds?: string[] | null; + } + /** + * Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. + */ + export interface Schema$DataSegment { + /** + * Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package. + */ + cpmFee?: Schema$Money; + /** + * Output only. Time the data segment was created. + */ + createTime?: string | null; + /** + * Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` + */ + name?: string | null; + /** + * Output only. The state of the data segment. + */ + state?: string | null; + /** + * Output only. Time the data segment was last updated. + */ + updateTime?: string | null; + } + /** + * Defines targeting for a period of time on a specific week day. + */ + export interface Schema$DayPart { + /** + * Day of week for the period. + */ + dayOfWeek?: string | null; + /** + * Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored. + */ + endTime?: Schema$TimeOfDay; + /** + * Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored. + */ + startTime?: Schema$TimeOfDay; + } + /** + * Represents Daypart targeting. + */ + export interface Schema$DayPartTargeting { + /** + * The targeted weekdays and times + */ + dayParts?: Schema$DayPart[]; + /** + * The time zone type of the day parts + */ + timeZoneType?: string | null; + } + /** + * Request message for disabling a client. + */ + export interface Schema$DeactivateClientRequest {} + /** + * Request message for deactivating a client user. + */ + export interface Schema$DeactivateClientUserRequest {} + /** + * Request message for deactivating a data segment + */ + export interface Schema$DeactivateDataSegmentRequest {} + /** + * A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. + */ + export interface Schema$Deal { + /** + * Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId\}` + */ + billedBuyer?: string | null; + /** + * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId\}` + */ + buyer?: string | null; + /** + * Output only. Refers to a Client. Format: `buyers/{buyerAccountId\}/clients/{clientAccountid\}` + */ + client?: string | null; + /** + * Output only. The time of the deal creation. + */ + createTime?: string | null; + /** + * Output only. Metadata about the creatives of this deal. + */ + creativeRequirements?: Schema$CreativeRequirements; + /** + * Output only. Type of deal. + */ + dealType?: string | null; + /** + * Output only. Specifies the pacing set by the publisher. + */ + deliveryControl?: Schema$DeliveryControl; + /** + * Output only. Free text description for the deal terms. + */ + description?: string | null; + /** + * Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal. + */ + displayName?: string | null; + /** + * Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace. + */ + eligibleSeatIds?: string[] | null; + /** + * Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly. + */ + estimatedGrossSpend?: Schema$Money; + /** + * Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals. + */ + flightEndTime?: string | null; + /** + * Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds. + */ + flightStartTime?: string | null; + /** + * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser). + */ + mediaPlanner?: Schema$MediaPlanner; + /** + * Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId\}/proposals/{proposalId\}/deals/{dealId\} + */ + name?: string | null; + /** + * The terms for preferred deals. + */ + preferredDealTerms?: Schema$PreferredDealTerms; + /** + * The terms for private auction deals. + */ + privateAuctionTerms?: Schema$PrivateAuctionTerms; + /** + * The terms for programmatic guaranteed deals. + */ + programmaticGuaranteedTerms?: Schema$ProgrammaticGuaranteedTerms; + /** + * Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. + */ + proposalRevision?: string | null; + /** + * Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId\}/publisherProfiles/{publisherProfileId\}` + */ + publisherProfile?: string | null; + /** + * Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing. + */ + sellerTimeZone?: Schema$TimeZone; + /** + * Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized. + */ + targeting?: Schema$MarketplaceTargeting; + /** + * Output only. The time when the deal was last updated. + */ + updateTime?: string | null; + } + /** + * Information related to deal pausing. + */ + export interface Schema$DealPausingInfo { + /** + * The reason for the pausing of the deal; empty for active deals. + */ + pauseReason?: string | null; + /** + * The party that first paused the deal; unspecified for active deals. + */ + pauseRole?: string | null; + /** + * Whether pausing is consented between buyer and seller for the deal. + */ + pausingConsented?: boolean | null; + } + /** + * Message contains details about how the deal will be paced. + */ + export interface Schema$DeliveryControl { + /** + * Output only. Specifies roadblocking in a main companion lineitem. + */ + companionDeliveryType?: string | null; + /** + * Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available. + */ + creativeRotationType?: string | null; + /** + * Output only. Specifies how the impression delivery will be paced. + */ + deliveryRateType?: string | null; + /** + * Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest. + */ + frequencyCap?: Schema$FrequencyCap[]; + /** + * Output only. Specifies the roadblocking type in display creatives. + */ + roadblockingType?: string | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more. + */ + export interface Schema$FinalizedDeal { + /** + * A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated. + */ + deal?: Schema$Deal; + /** + * Information related to deal pausing for the deal. + */ + dealPausingInfo?: Schema$DealPausingInfo; + /** + * Serving status of the deal. + */ + dealServingStatus?: string | null; + /** + * The resource name of the finalized deal. Format: `buyers/{accountId\}/finalizedDeals/{finalizedDealId\}` + */ + name?: string | null; + /** + * Whether the Programmatic Guaranteed deal is ready for serving. + */ + readyToServe?: boolean | null; + /** + * Real-time bidding metrics for this deal. + */ + rtbMetrics?: Schema$RtbMetrics; + } + /** + * Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. + */ + export interface Schema$FirstPartyMobileApplicationTargeting { + /** + * A list of application IDs to be excluded. + */ + excludedAppIds?: string[] | null; + /** + * A list of application IDs to be included. + */ + targetedAppIds?: string[] | null; + } + /** + * Message contains details about publisher-set frequency caps of the delivery. + */ + export interface Schema$FrequencyCap { + /** + * The maximum number of impressions that can be served to a user within the specified time period. + */ + maxImpressions?: number | null; + /** + * The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped. + */ + timeUnitsCount?: number | null; + /** + * The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped. + */ + timeUnitType?: string | null; + } + /** + * Represents the size of an ad unit that can be targeted on a bid request. + */ + export interface Schema$InventorySizeTargeting { + /** + * A list of inventory sizes to be excluded. + */ + excludedInventorySizes?: Schema$AdSize[]; + /** + * A list of inventory sizes to be included. + */ + targetedInventorySizes?: Schema$AdSize[]; + } + /** + * Targeting of the inventory types a bid request can originate from. + */ + export interface Schema$InventoryTypeTargeting { + /** + * The list of targeted inventory types for the bid request. + */ + inventoryTypes?: string[] | null; + } + /** + * Response message for listing auction packages. + */ + export interface Schema$ListAuctionPackagesResponse { + /** + * The list of auction packages. + */ + auctionPackages?: Schema$AuctionPackage[]; + /** + * Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for the list method. + */ + export interface Schema$ListClientsResponse { + /** + * The returned list of clients. + */ + clients?: Schema$Client[]; + /** + * A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for the list method. + */ + export interface Schema$ListClientUsersResponse { + /** + * The returned list of client users. + */ + clientUsers?: Schema$ClientUser[]; + /** + * A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing data segments. + */ + export interface Schema$ListDataSegmentsResponse { + /** + * The list of data segments. + */ + dataSegments?: Schema$DataSegment[]; + /** + * Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing deals in a proposal. + */ + export interface Schema$ListDealsResponse { + /** + * The list of deals. + */ + deals?: Schema$Deal[]; + /** + * Token to fetch the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing finalized deals. + */ + export interface Schema$ListFinalizedDealsResponse { + /** + * The list of finalized deals. + */ + finalizedDeals?: Schema$FinalizedDeal[]; + /** + * Token to fetch the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing proposals. + */ + export interface Schema$ListProposalsResponse { + /** + * Continuation token for fetching the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of proposals. + */ + proposals?: Schema$Proposal[]; + } + /** + * Response message for profiles visible to the buyer. + */ + export interface Schema$ListPublisherProfilesResponse { + /** + * Token to fetch the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of matching publisher profiles. + */ + publisherProfiles?: Schema$PublisherProfile[]; + } + /** + * Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. + */ + export interface Schema$MarketplaceTargeting { + /** + * Daypart targeting information. + */ + daypartTargeting?: Schema$DayPartTargeting; + /** + * Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs. + */ + excludedSensitiveCategoryIds?: string[] | null; + /** + * Output only. Geo criteria IDs to be included/excluded. + */ + geoTargeting?: Schema$CriteriaTargeting; + /** + * Output only. Inventory sizes to be included/excluded. + */ + inventorySizeTargeting?: Schema$InventorySizeTargeting; + /** + * Output only. Inventory type targeting information. + */ + inventoryTypeTargeting?: Schema$InventoryTypeTargeting; + /** + * Output only. Placement targeting information, for example, URL, mobile applications. + */ + placementTargeting?: Schema$PlacementTargeting; + /** + * Output only. Technology targeting information, for example, operating system, device category. + */ + technologyTargeting?: Schema$TechnologyTargeting; + /** + * Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader. + */ + userListTargeting?: Schema$CriteriaTargeting; + /** + * Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals + */ + verticalTargeting?: Schema$CriteriaTargeting; + /** + * Output only. Video targeting information. + */ + videoTargeting?: Schema$VideoTargeting; + } + /** + * Describes a single Media Planner account. + */ + export interface Schema$MediaPlanner { + /** + * Output only. Account ID of the media planner. + */ + accountId?: string | null; + } + /** + * Mobile application targeting settings. + */ + export interface Schema$MobileApplicationTargeting { + /** + * Publisher owned apps to be targeted or excluded by the publisher to display the ads in. + */ + firstPartyTargeting?: Schema$FirstPartyMobileApplicationTargeting; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The three-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * A text note attached to the proposal to facilitate the communication between buyers and sellers. + */ + export interface Schema$Note { + /** + * Output only. When this note was created. + */ + createTime?: string | null; + /** + * Output only. The role who created the note. + */ + creatorRole?: string | null; + /** + * The text of the note. Maximum length is 1024 characters. + */ + note?: string | null; + } + /** + * Represents targeting information for operating systems. + */ + export interface Schema$OperatingSystemTargeting { + /** + * IDs of operating systems to be included/excluded. + */ + operatingSystemCriteria?: Schema$CriteriaTargeting; + /** + * IDs of operating system versions to be included/excluded. + */ + operatingSystemVersionCriteria?: Schema$CriteriaTargeting; + } + /** + * Request message for pausing a finalized deal. + */ + export interface Schema$PauseFinalizedDealRequest { + /** + * The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters. + */ + reason?: string | null; + } + /** + * Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. + */ + export interface Schema$PlacementTargeting { + /** + * Mobile application targeting information in a deal. This doesn't apply to Auction Packages. + */ + mobileApplicationTargeting?: Schema$MobileApplicationTargeting; + /** + * URLs to be included/excluded. + */ + uriTargeting?: Schema$UriTargeting; + } + /** + * Pricing terms for Preferred Deals. + */ + export interface Schema$PreferredDealTerms { + /** + * Fixed price for the deal. + */ + fixedPrice?: Schema$Price; + } + /** + * Represents a price and a pricing type for a deal. + */ + export interface Schema$Price { + /** + * The actual price with currency specified. + */ + amount?: Schema$Money; + /** + * The pricing type for the deal. + */ + type?: string | null; + } + /** + * Pricing terms for Private Auctions. + */ + export interface Schema$PrivateAuctionTerms { + /** + * The minimum price buyer has to bid to compete in the private auction. + */ + floorPrice?: Schema$Price; + /** + * Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction. + */ + openAuctionAllowed?: boolean | null; + } + /** + * Buyers are allowed to store certain types of private data in a proposal or deal. + */ + export interface Schema$PrivateData { + /** + * A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units). + */ + referenceId?: string | null; + } + /** + * Pricing terms for Programmatic Guaranteed Deals. + */ + export interface Schema$ProgrammaticGuaranteedTerms { + /** + * Fixed price for the deal. + */ + fixedPrice?: Schema$Price; + /** + * Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored. + */ + guaranteedLooks?: string | null; + /** + * The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached. + */ + impressionCap?: string | null; + /** + * Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks. + */ + minimumDailyLooks?: string | null; + /** + * For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100. + */ + percentShareOfVoice?: string | null; + /** + * The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD. + */ + reservationType?: string | null; + } + /** + * Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer. + */ + export interface Schema$Proposal { + /** + * Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId\}` + */ + billedBuyer?: string | null; + /** + * Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId\}` + */ + buyer?: string | null; + /** + * Contact information for the buyer. + */ + buyerContacts?: Schema$Contact[]; + /** + * Buyer private data (hidden from seller). + */ + buyerPrivateData?: Schema$PrivateData; + /** + * Output only. Refers to a Client. Format: `buyers/{buyerAccountId\}/clients/{clientAccountid\}` + */ + client?: string | null; + /** + * Output only. Type of deal the proposal contains. + */ + dealType?: string | null; + /** + * Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal. + */ + displayName?: string | null; + /** + * Output only. True if the proposal was previously finalized and is now being renegotiated. + */ + isRenegotiating?: boolean | null; + /** + * Output only. The role of the last user that either updated the proposal or left a comment. + */ + lastUpdaterOrCommentorRole?: string | null; + /** + * Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId\}/proposals/{proposalId\} + */ + name?: string | null; + /** + * A list of notes from the buyer and the seller attached to this proposal. + */ + notes?: Schema$Note[]; + /** + * Output only. Indicates whether the buyer/seller created the proposal. + */ + originatorRole?: string | null; + /** + * Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers. + */ + pausingConsented?: boolean | null; + /** + * Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made. + */ + proposalRevision?: string | null; + /** + * Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId\}/publisherProfiles/{publisherProfileId\}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error. + */ + publisherProfile?: string | null; + /** + * Output only. Contact information for the seller. + */ + sellerContacts?: Schema$Contact[]; + /** + * Output only. Indicates the state of the proposal. + */ + state?: string | null; + /** + * Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it. + */ + termsAndConditions?: string | null; + /** + * Output only. The time when the proposal was last revised. + */ + updateTime?: string | null; + } + /** + * The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise. + */ + export interface Schema$PublisherProfile { + /** + * Description on the publisher's audience. + */ + audienceDescription?: string | null; + /** + * Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. + */ + directDealsContact?: string | null; + /** + * Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method. + */ + displayName?: string | null; + /** + * The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method. + */ + domains?: string[] | null; + /** + * Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true". + */ + isParent?: boolean | null; + /** + * A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image. + */ + logoUrl?: string | null; + /** + * URL to additional marketing and sales materials. + */ + mediaKitUrl?: string | null; + /** + * The list of apps represented in this publisher profile. Empty if this is a parent profile. + */ + mobileApps?: Schema$PublisherProfileMobileApplication[]; + /** + * Name of the publisher profile. Format: `buyers/{buyer\}/publisherProfiles/{publisher_profile\}` + */ + name?: string | null; + /** + * Overview of the publisher. + */ + overview?: string | null; + /** + * Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher. + */ + pitchStatement?: string | null; + /** + * Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses. + */ + programmaticDealsContact?: string | null; + /** + * A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method. + */ + publisherCode?: string | null; + /** + * URL to a sample content page. + */ + samplePageUrl?: string | null; + /** + * Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months". + */ + topHeadlines?: string[] | null; + } + /** + * A mobile application that contains a external app ID, name, and app store. + */ + export interface Schema$PublisherProfileMobileApplication { + /** + * The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method. + */ + appStore?: string | null; + /** + * The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method. + */ + externalAppId?: string | null; + /** + * The name of the app. + */ + name?: string | null; + } + /** + * Request message for resuming a finalized deal. + */ + export interface Schema$ResumeFinalizedDealRequest {} + /** + * Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) + */ + export interface Schema$RtbMetrics { + /** + * Ad impressions in last 7 days. + */ + adImpressions7Days?: string | null; + /** + * Bid rate in last 7 days, calculated by (bids / bid requests). + */ + bidRate7Days?: number | null; + /** + * Bid requests in last 7 days. + */ + bidRequests7Days?: string | null; + /** + * Bids in last 7 days. + */ + bids7Days?: string | null; + /** + * Filtered bid rate in last 7 days, calculated by (filtered bids / bids). + */ + filteredBidRate7Days?: number | null; + /** + * Must bid rate for current month. + */ + mustBidRateCurrentMonth?: number | null; + } + /** + * Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation. + */ + export interface Schema$SendRfpRequest { + /** + * Contact information for the buyer. + */ + buyerContacts?: Schema$Contact[]; + /** + * If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId\}/clients/{clientAccountid\}`. + */ + client?: string | null; + /** + * Required. The display name of the proposal being created by this RFP. + */ + displayName?: string | null; + /** + * Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly. + */ + estimatedGrossSpend?: Schema$Money; + /** + * Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second. + */ + flightEndTime?: string | null; + /** + * Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second. + */ + flightStartTime?: string | null; + /** + * Geo criteria IDs to be targeted. Refer to Geo tables. + */ + geoTargeting?: Schema$CriteriaTargeting; + /** + * Inventory sizes to be targeted. + */ + inventorySizeTargeting?: Schema$InventorySizeTargeting; + /** + * A message that is sent to the publisher. Maximum length is 1024 characters. + */ + note?: string | null; + /** + * The terms for preferred deals. + */ + preferredDealTerms?: Schema$PreferredDealTerms; + /** + * The terms for programmatic guaranteed deals. + */ + programmaticGuaranteedTerms?: Schema$ProgrammaticGuaranteedTerms; + /** + * Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId\}/publisherProfiles/{publisherProfileId\}`. + */ + publisherProfile?: string | null; + } + /** + * Request message for setting ready to serve for a finalized deal. + */ + export interface Schema$SetReadyToServeRequest {} + /** + * Request message for SubscribeAuctionPackage. + */ + export interface Schema$SubscribeAuctionPackageRequest {} + /** + * Request message for SubscribeAuctionPackageClients. + */ + export interface Schema$SubscribeClientsRequest { + /** + * Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId\}/clients/{clientAccountId\}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already. + */ + clients?: string[] | null; + } + /** + * Represents targeting about various types of technology. + */ + export interface Schema$TechnologyTargeting { + /** + * IDs of device capabilities to be included/excluded. + */ + deviceCapabilityTargeting?: Schema$CriteriaTargeting; + /** + * IDs of device categories to be included/excluded. + */ + deviceCategoryTargeting?: Schema$CriteriaTargeting; + /** + * Operating system related targeting information. + */ + operatingSystemTargeting?: Schema$OperatingSystemTargeting; + } + /** + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + */ + export interface Schema$TimeOfDay { + /** + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of hour of day. Must be from 0 to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone, e.g. "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number, e.g. "2019a". + */ + version?: string | null; + } + /** + * Request message for UnsubscribeAuctionPackage. + */ + export interface Schema$UnsubscribeAuctionPackageRequest {} + /** + * Request message for UnsubscribeAuctionPackage. + */ + export interface Schema$UnsubscribeClientsRequest { + /** + * Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId\}/clients/{clientAccountId\}`. + */ + clients?: string[] | null; + } + /** + * Request message for updating the deal at the given revision number. + */ + export interface Schema$UpdateDealRequest { + /** + * Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId\}/proposals/{proposalId\}/deals/{dealId\} + */ + deal?: Schema$Deal; + /** + * List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string | null; + } + /** + * Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. + */ + export interface Schema$UriTargeting { + /** + * A list of URLs to be excluded. + */ + excludedUris?: string[] | null; + /** + * A list of URLs to be included. + */ + targetedUris?: string[] | null; + } + /** + * Represents targeting information about video. + */ + export interface Schema$VideoTargeting { + /** + * A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty. + */ + excludedPositionTypes?: string[] | null; + /** + * A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty. + */ + targetedPositionTypes?: string[] | null; + } + + export class Resource$Bidders { + context: APIRequestContext; + auctionPackages: Resource$Bidders$Auctionpackages; + finalizedDeals: Resource$Bidders$Finalizeddeals; + constructor(context: APIRequestContext) { + this.context = context; + this.auctionPackages = new Resource$Bidders$Auctionpackages(this.context); + this.finalizedDeals = new Resource$Bidders$Finalizeddeals(this.context); + } + } + + export class Resource$Bidders$Auctionpackages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId\}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId\}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Bidders$Auctionpackages$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Bidders$Auctionpackages$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Bidders$Auctionpackages$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Bidders$Auctionpackages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Bidders$Auctionpackages$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Bidders$Auctionpackages$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Bidders$Auctionpackages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Bidders$Auctionpackages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/auctionPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Bidders$Auctionpackages$List + extends StandardParameters { + /** + * Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds + */ + filter?: string; + /** + * Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime + */ + orderBy?: string; + /** + * Requested page size. The server may return fewer results than requested. Max allowed page size is 500. + */ + pageSize?: number; + /** + * The page token as returned. ListAuctionPackagesResponse.nextPageToken + */ + pageToken?: string; + /** + * Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId\}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId\}`. + */ + parent?: string; + } + + export class Resource$Bidders$Finalizeddeals { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId\}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId\}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Bidders$Finalizeddeals$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Bidders$Finalizeddeals$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Bidders$Finalizeddeals$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Bidders$Finalizeddeals$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Bidders$Finalizeddeals$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Bidders$Finalizeddeals$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Bidders$Finalizeddeals$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Bidders$Finalizeddeals$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/finalizedDeals').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Bidders$Finalizeddeals$List + extends StandardParameters { + /** + * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus + */ + filter?: string; + /** + * An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth + */ + orderBy?: string; + /** + * Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. + */ + pageSize?: number; + /** + * The page token as returned from ListFinalizedDealsResponse. + */ + pageToken?: string; + /** + * Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId\}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId\}`. + */ + parent?: string; + } + + export class Resource$Buyers { + context: APIRequestContext; + auctionPackages: Resource$Buyers$Auctionpackages; + clients: Resource$Buyers$Clients; + dataSegments: Resource$Buyers$Datasegments; + finalizedDeals: Resource$Buyers$Finalizeddeals; + proposals: Resource$Buyers$Proposals; + publisherProfiles: Resource$Buyers$Publisherprofiles; + constructor(context: APIRequestContext) { + this.context = context; + this.auctionPackages = new Resource$Buyers$Auctionpackages(this.context); + this.clients = new Resource$Buyers$Clients(this.context); + this.dataSegments = new Resource$Buyers$Datasegments(this.context); + this.finalizedDeals = new Resource$Buyers$Finalizeddeals(this.context); + this.proposals = new Resource$Buyers$Proposals(this.context); + this.publisherProfiles = new Resource$Buyers$Publisherprofiles( + this.context + ); + } + } + + export class Resource$Buyers$Auctionpackages { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an auction package given its name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Auctionpackages$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Auctionpackages$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Auctionpackages$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Auctionpackages$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Auctionpackages$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Auctionpackages$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Auctionpackages$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Auctionpackages$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId\}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId\}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Auctionpackages$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Auctionpackages$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Auctionpackages$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Auctionpackages$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Auctionpackages$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Auctionpackages$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Auctionpackages$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Auctionpackages$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/auctionPackages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + subscribe( + params: Params$Resource$Buyers$Auctionpackages$Subscribe, + options: StreamMethodOptions + ): GaxiosPromise; + subscribe( + params?: Params$Resource$Buyers$Auctionpackages$Subscribe, + options?: MethodOptions + ): GaxiosPromise; + subscribe( + params: Params$Resource$Buyers$Auctionpackages$Subscribe, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + subscribe( + params: Params$Resource$Buyers$Auctionpackages$Subscribe, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + subscribe( + params: Params$Resource$Buyers$Auctionpackages$Subscribe, + callback: BodyResponseCallback + ): void; + subscribe(callback: BodyResponseCallback): void; + subscribe( + paramsOrCallback?: + | Params$Resource$Buyers$Auctionpackages$Subscribe + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Auctionpackages$Subscribe; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Auctionpackages$Subscribe; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:subscribe').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + subscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Subscribeclients, + options: StreamMethodOptions + ): GaxiosPromise; + subscribeClients( + params?: Params$Resource$Buyers$Auctionpackages$Subscribeclients, + options?: MethodOptions + ): GaxiosPromise; + subscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Subscribeclients, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + subscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Subscribeclients, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + subscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Subscribeclients, + callback: BodyResponseCallback + ): void; + subscribeClients( + callback: BodyResponseCallback + ): void; + subscribeClients( + paramsOrCallback?: + | Params$Resource$Buyers$Auctionpackages$Subscribeclients + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Auctionpackages$Subscribeclients; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Auctionpackages$Subscribeclients; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+auctionPackage}:subscribeClients' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['auctionPackage'], + pathParams: ['auctionPackage'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + unsubscribe( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribe, + options: StreamMethodOptions + ): GaxiosPromise; + unsubscribe( + params?: Params$Resource$Buyers$Auctionpackages$Unsubscribe, + options?: MethodOptions + ): GaxiosPromise; + unsubscribe( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribe, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unsubscribe( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribe, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unsubscribe( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribe, + callback: BodyResponseCallback + ): void; + unsubscribe(callback: BodyResponseCallback): void; + unsubscribe( + paramsOrCallback?: + | Params$Resource$Buyers$Auctionpackages$Unsubscribe + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Auctionpackages$Unsubscribe; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Auctionpackages$Unsubscribe; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:unsubscribe').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + unsubscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribeclients, + options: StreamMethodOptions + ): GaxiosPromise; + unsubscribeClients( + params?: Params$Resource$Buyers$Auctionpackages$Unsubscribeclients, + options?: MethodOptions + ): GaxiosPromise; + unsubscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribeclients, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unsubscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribeclients, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unsubscribeClients( + params: Params$Resource$Buyers$Auctionpackages$Unsubscribeclients, + callback: BodyResponseCallback + ): void; + unsubscribeClients( + callback: BodyResponseCallback + ): void; + unsubscribeClients( + paramsOrCallback?: + | Params$Resource$Buyers$Auctionpackages$Unsubscribeclients + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Auctionpackages$Unsubscribeclients; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Buyers$Auctionpackages$Unsubscribeclients; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+auctionPackage}:unsubscribeClients' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['auctionPackage'], + pathParams: ['auctionPackage'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Auctionpackages$Get + extends StandardParameters { + /** + * Required. Name of auction package to get. Format: `buyers/{accountId\}/auctionPackages/{auctionPackageId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Auctionpackages$List + extends StandardParameters { + /** + * Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds + */ + filter?: string; + /** + * Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime + */ + orderBy?: string; + /** + * Requested page size. The server may return fewer results than requested. Max allowed page size is 500. + */ + pageSize?: number; + /** + * The page token as returned. ListAuctionPackagesResponse.nextPageToken + */ + pageToken?: string; + /** + * Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId\}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId\}`. + */ + parent?: string; + } + export interface Params$Resource$Buyers$Auctionpackages$Subscribe + extends StandardParameters { + /** + * Required. Name of the auction package. Format: `buyers/{accountId\}/auctionPackages/{auctionPackageId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SubscribeAuctionPackageRequest; + } + export interface Params$Resource$Buyers$Auctionpackages$Subscribeclients + extends StandardParameters { + /** + * Required. Name of the auction package. Format: `buyers/{accountId\}/auctionPackages/{auctionPackageId\}` + */ + auctionPackage?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SubscribeClientsRequest; + } + export interface Params$Resource$Buyers$Auctionpackages$Unsubscribe + extends StandardParameters { + /** + * Required. Name of the auction package. Format: `buyers/{accountId\}/auctionPackages/{auctionPackageId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UnsubscribeAuctionPackageRequest; + } + export interface Params$Resource$Buyers$Auctionpackages$Unsubscribeclients + extends StandardParameters { + /** + * Required. Name of the auction package. Format: `buyers/{accountId\}/auctionPackages/{auctionPackageId\}` + */ + auctionPackage?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UnsubscribeClientsRequest; + } + + export class Resource$Buyers$Clients { + context: APIRequestContext; + users: Resource$Buyers$Clients$Users; + constructor(context: APIRequestContext) { + this.context = context; + this.users = new Resource$Buyers$Clients$Users(this.context); + } + + /** + * Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + activate( + params: Params$Resource$Buyers$Clients$Activate, + options: StreamMethodOptions + ): GaxiosPromise; + activate( + params?: Params$Resource$Buyers$Clients$Activate, + options?: MethodOptions + ): GaxiosPromise; + activate( + params: Params$Resource$Buyers$Clients$Activate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Buyers$Clients$Activate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Buyers$Clients$Activate, + callback: BodyResponseCallback + ): void; + activate(callback: BodyResponseCallback): void; + activate( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Activate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Activate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Activate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:activate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new client. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Buyers$Clients$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Buyers$Clients$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Buyers$Clients$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Buyers$Clients$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Buyers$Clients$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/clients').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deactivate( + params: Params$Resource$Buyers$Clients$Deactivate, + options: StreamMethodOptions + ): GaxiosPromise; + deactivate( + params?: Params$Resource$Buyers$Clients$Deactivate, + options?: MethodOptions + ): GaxiosPromise; + deactivate( + params: Params$Resource$Buyers$Clients$Deactivate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Buyers$Clients$Deactivate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Buyers$Clients$Deactivate, + callback: BodyResponseCallback + ): void; + deactivate(callback: BodyResponseCallback): void; + deactivate( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Deactivate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Deactivate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Deactivate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:deactivate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a client with a given resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Clients$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Clients$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Clients$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Clients$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Clients$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all the clients for the current buyer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Clients$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Clients$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Clients$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Clients$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Clients$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/clients').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing client. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Buyers$Clients$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Buyers$Clients$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Buyers$Clients$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Clients$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Clients$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Clients$Activate + extends StandardParameters { + /** + * Required. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ActivateClientRequest; + } + export interface Params$Resource$Buyers$Clients$Create + extends StandardParameters { + /** + * Required. The name of the buyer. Format: `buyers/{accountId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Client; + } + export interface Params$Resource$Buyers$Clients$Deactivate + extends StandardParameters { + /** + * Required. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeactivateClientRequest; + } + export interface Params$Resource$Buyers$Clients$Get + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/clients/{clientAccountId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Clients$List + extends StandardParameters { + /** + * Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response. + */ + filter?: string; + /** + * Requested page size. If left blank, a default page size of 500 will be applied. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method. + */ + pageToken?: string; + /** + * Required. The name of the buyer. Format: `buyers/{accountId\}` + */ + parent?: string; + } + export interface Params$Resource$Buyers$Clients$Patch + extends StandardParameters { + /** + * Output only. The resource name of the client. Format: `buyers/{accountId\}/clients/{clientAccountId\}` + */ + name?: string; + /** + * List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Client; + } + + export class Resource$Buyers$Clients$Users { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + activate( + params: Params$Resource$Buyers$Clients$Users$Activate, + options: StreamMethodOptions + ): GaxiosPromise; + activate( + params?: Params$Resource$Buyers$Clients$Users$Activate, + options?: MethodOptions + ): GaxiosPromise; + activate( + params: Params$Resource$Buyers$Clients$Users$Activate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Buyers$Clients$Users$Activate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Buyers$Clients$Users$Activate, + callback: BodyResponseCallback + ): void; + activate(callback: BodyResponseCallback): void; + activate( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Users$Activate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Users$Activate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Users$Activate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:activate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Buyers$Clients$Users$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Buyers$Clients$Users$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Buyers$Clients$Users$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Buyers$Clients$Users$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Buyers$Clients$Users$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Users$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Users$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Users$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/users').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deactivate( + params: Params$Resource$Buyers$Clients$Users$Deactivate, + options: StreamMethodOptions + ): GaxiosPromise; + deactivate( + params?: Params$Resource$Buyers$Clients$Users$Deactivate, + options?: MethodOptions + ): GaxiosPromise; + deactivate( + params: Params$Resource$Buyers$Clients$Users$Deactivate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Buyers$Clients$Users$Deactivate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Buyers$Clients$Users$Deactivate, + callback: BodyResponseCallback + ): void; + deactivate(callback: BodyResponseCallback): void; + deactivate( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Users$Deactivate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Users$Deactivate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Users$Deactivate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:deactivate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Buyers$Clients$Users$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Buyers$Clients$Users$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Buyers$Clients$Users$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Buyers$Clients$Users$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Buyers$Clients$Users$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Users$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Users$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Users$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves an existing client user. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Clients$Users$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Clients$Users$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Clients$Users$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Clients$Users$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Clients$Users$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Users$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Users$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Users$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all client users for a specified client. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Clients$Users$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Clients$Users$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Clients$Users$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Clients$Users$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Clients$Users$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Clients$Users$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Clients$Users$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Clients$Users$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/users').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Clients$Users$Activate + extends StandardParameters { + /** + * Required. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}/clientUsers/{userId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ActivateClientUserRequest; + } + export interface Params$Resource$Buyers$Clients$Users$Create + extends StandardParameters { + /** + * Required. The name of the client. Format: `buyers/{accountId\}/clients/{clientAccountId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ClientUser; + } + export interface Params$Resource$Buyers$Clients$Users$Deactivate + extends StandardParameters { + /** + * Required. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}/clientUsers/{userId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeactivateClientUserRequest; + } + export interface Params$Resource$Buyers$Clients$Users$Delete + extends StandardParameters { + /** + * Required. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}/clientUsers/{userId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Clients$Users$Get + extends StandardParameters { + /** + * Required. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}/clientUsers/{userId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Clients$Users$List + extends StandardParameters { + /** + * Requested page size. If left blank, a default page size of 500 will be applied. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method. + */ + pageToken?: string; + /** + * Required. The name of the client. Format: `buyers/{buyerAccountId\}/clients/{clientAccountId\}` + */ + parent?: string; + } + + export class Resource$Buyers$Datasegments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Activates a data segment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + activate( + params: Params$Resource$Buyers$Datasegments$Activate, + options: StreamMethodOptions + ): GaxiosPromise; + activate( + params?: Params$Resource$Buyers$Datasegments$Activate, + options?: MethodOptions + ): GaxiosPromise; + activate( + params: Params$Resource$Buyers$Datasegments$Activate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Buyers$Datasegments$Activate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + activate( + params: Params$Resource$Buyers$Datasegments$Activate, + callback: BodyResponseCallback + ): void; + activate(callback: BodyResponseCallback): void; + activate( + paramsOrCallback?: + | Params$Resource$Buyers$Datasegments$Activate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Datasegments$Activate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Datasegments$Activate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:activate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Buyers$Datasegments$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Buyers$Datasegments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Buyers$Datasegments$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Buyers$Datasegments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Buyers$Datasegments$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Buyers$Datasegments$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Datasegments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Datasegments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dataSegments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deactivates a data segment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deactivate( + params: Params$Resource$Buyers$Datasegments$Deactivate, + options: StreamMethodOptions + ): GaxiosPromise; + deactivate( + params?: Params$Resource$Buyers$Datasegments$Deactivate, + options?: MethodOptions + ): GaxiosPromise; + deactivate( + params: Params$Resource$Buyers$Datasegments$Deactivate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Buyers$Datasegments$Deactivate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deactivate( + params: Params$Resource$Buyers$Datasegments$Deactivate, + callback: BodyResponseCallback + ): void; + deactivate(callback: BodyResponseCallback): void; + deactivate( + paramsOrCallback?: + | Params$Resource$Buyers$Datasegments$Deactivate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Datasegments$Deactivate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Datasegments$Deactivate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:deactivate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a data segment given its name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Datasegments$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Datasegments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Datasegments$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Datasegments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Datasegments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Datasegments$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Datasegments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Datasegments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * List the data segments owned by a curator. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Datasegments$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Datasegments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Datasegments$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Datasegments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Datasegments$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Datasegments$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Datasegments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Datasegments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dataSegments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a data segment. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Buyers$Datasegments$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Buyers$Datasegments$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Buyers$Datasegments$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Datasegments$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Datasegments$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Buyers$Datasegments$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Datasegments$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Datasegments$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Datasegments$Activate + extends StandardParameters { + /** + * Required. Name of data segment to activate. Format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ActivateDataSegmentRequest; + } + export interface Params$Resource$Buyers$Datasegments$Create + extends StandardParameters { + /** + * Required. The parent resource where this data segment will be created. Format: `buyers/{accountId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DataSegment; + } + export interface Params$Resource$Buyers$Datasegments$Deactivate + extends StandardParameters { + /** + * Required. Name of data segment to deactivate. Format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DeactivateDataSegmentRequest; + } + export interface Params$Resource$Buyers$Datasegments$Get + extends StandardParameters { + /** + * Required. Name of data segment to get. Format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Datasegments$List + extends StandardParameters { + /** + * Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500. + */ + pageSize?: number; + /** + * Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken + */ + pageToken?: string; + /** + * Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId\}` + */ + parent?: string; + } + export interface Params$Resource$Buyers$Datasegments$Patch + extends StandardParameters { + /** + * Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId\}/dataSegments/{curatorDataSegmentId\}` + */ + name?: string; + /** + * Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DataSegment; + } + + export class Resource$Buyers$Finalizeddeals { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addCreative( + params: Params$Resource$Buyers$Finalizeddeals$Addcreative, + options: StreamMethodOptions + ): GaxiosPromise; + addCreative( + params?: Params$Resource$Buyers$Finalizeddeals$Addcreative, + options?: MethodOptions + ): GaxiosPromise; + addCreative( + params: Params$Resource$Buyers$Finalizeddeals$Addcreative, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addCreative( + params: Params$Resource$Buyers$Finalizeddeals$Addcreative, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addCreative( + params: Params$Resource$Buyers$Finalizeddeals$Addcreative, + callback: BodyResponseCallback + ): void; + addCreative(callback: BodyResponseCallback): void; + addCreative( + paramsOrCallback?: + | Params$Resource$Buyers$Finalizeddeals$Addcreative + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Finalizeddeals$Addcreative; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Finalizeddeals$Addcreative; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+deal}:addCreative').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['deal'], + pathParams: ['deal'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a finalized deal given its name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Finalizeddeals$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Finalizeddeals$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Finalizeddeals$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Finalizeddeals$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Finalizeddeals$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Finalizeddeals$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Finalizeddeals$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Finalizeddeals$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId\}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId\}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Finalizeddeals$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Finalizeddeals$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Finalizeddeals$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Finalizeddeals$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Finalizeddeals$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Finalizeddeals$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Finalizeddeals$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Finalizeddeals$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/finalizedDeals').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + pause( + params: Params$Resource$Buyers$Finalizeddeals$Pause, + options: StreamMethodOptions + ): GaxiosPromise; + pause( + params?: Params$Resource$Buyers$Finalizeddeals$Pause, + options?: MethodOptions + ): GaxiosPromise; + pause( + params: Params$Resource$Buyers$Finalizeddeals$Pause, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Buyers$Finalizeddeals$Pause, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + pause( + params: Params$Resource$Buyers$Finalizeddeals$Pause, + callback: BodyResponseCallback + ): void; + pause(callback: BodyResponseCallback): void; + pause( + paramsOrCallback?: + | Params$Resource$Buyers$Finalizeddeals$Pause + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Finalizeddeals$Pause; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Finalizeddeals$Pause; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resume( + params: Params$Resource$Buyers$Finalizeddeals$Resume, + options: StreamMethodOptions + ): GaxiosPromise; + resume( + params?: Params$Resource$Buyers$Finalizeddeals$Resume, + options?: MethodOptions + ): GaxiosPromise; + resume( + params: Params$Resource$Buyers$Finalizeddeals$Resume, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Buyers$Finalizeddeals$Resume, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resume( + params: Params$Resource$Buyers$Finalizeddeals$Resume, + callback: BodyResponseCallback + ): void; + resume(callback: BodyResponseCallback): void; + resume( + paramsOrCallback?: + | Params$Resource$Buyers$Finalizeddeals$Resume + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Finalizeddeals$Resume; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Finalizeddeals$Resume; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:resume').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setReadyToServe( + params: Params$Resource$Buyers$Finalizeddeals$Setreadytoserve, + options: StreamMethodOptions + ): GaxiosPromise; + setReadyToServe( + params?: Params$Resource$Buyers$Finalizeddeals$Setreadytoserve, + options?: MethodOptions + ): GaxiosPromise; + setReadyToServe( + params: Params$Resource$Buyers$Finalizeddeals$Setreadytoserve, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setReadyToServe( + params: Params$Resource$Buyers$Finalizeddeals$Setreadytoserve, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setReadyToServe( + params: Params$Resource$Buyers$Finalizeddeals$Setreadytoserve, + callback: BodyResponseCallback + ): void; + setReadyToServe(callback: BodyResponseCallback): void; + setReadyToServe( + paramsOrCallback?: + | Params$Resource$Buyers$Finalizeddeals$Setreadytoserve + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Finalizeddeals$Setreadytoserve; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Finalizeddeals$Setreadytoserve; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+deal}:setReadyToServe').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['deal'], + pathParams: ['deal'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Finalizeddeals$Addcreative + extends StandardParameters { + /** + * Required. Name of the finalized deal in the format of: `buyers/{accountId\}/finalizedDeals/{dealId\}` + */ + deal?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddCreativeRequest; + } + export interface Params$Resource$Buyers$Finalizeddeals$Get + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Finalizeddeals$List + extends StandardParameters { + /** + * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus + */ + filter?: string; + /** + * An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth + */ + orderBy?: string; + /** + * Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. + */ + pageSize?: number; + /** + * The page token as returned from ListFinalizedDealsResponse. + */ + pageToken?: string; + /** + * Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId\}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId\}`. + */ + parent?: string; + } + export interface Params$Resource$Buyers$Finalizeddeals$Pause + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PauseFinalizedDealRequest; + } + export interface Params$Resource$Buyers$Finalizeddeals$Resume + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResumeFinalizedDealRequest; + } + export interface Params$Resource$Buyers$Finalizeddeals$Setreadytoserve + extends StandardParameters { + /** + * Required. Format: `buyers/{accountId\}/finalizedDeals/{dealId\}` + */ + deal?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetReadyToServeRequest; + } + + export class Resource$Buyers$Proposals { + context: APIRequestContext; + deals: Resource$Buyers$Proposals$Deals; + constructor(context: APIRequestContext) { + this.context = context; + this.deals = new Resource$Buyers$Proposals$Deals(this.context); + } + + /** + * Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + accept( + params: Params$Resource$Buyers$Proposals$Accept, + options: StreamMethodOptions + ): GaxiosPromise; + accept( + params?: Params$Resource$Buyers$Proposals$Accept, + options?: MethodOptions + ): GaxiosPromise; + accept( + params: Params$Resource$Buyers$Proposals$Accept, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accept( + params: Params$Resource$Buyers$Proposals$Accept, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + accept( + params: Params$Resource$Buyers$Proposals$Accept, + callback: BodyResponseCallback + ): void; + accept(callback: BodyResponseCallback): void; + accept( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Accept + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Accept; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Accept; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:accept').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addNote( + params: Params$Resource$Buyers$Proposals$Addnote, + options: StreamMethodOptions + ): GaxiosPromise; + addNote( + params?: Params$Resource$Buyers$Proposals$Addnote, + options?: MethodOptions + ): GaxiosPromise; + addNote( + params: Params$Resource$Buyers$Proposals$Addnote, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addNote( + params: Params$Resource$Buyers$Proposals$Addnote, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addNote( + params: Params$Resource$Buyers$Proposals$Addnote, + callback: BodyResponseCallback + ): void; + addNote(callback: BodyResponseCallback): void; + addNote( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Addnote + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Addnote; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Addnote; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+proposal}:addNote').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['proposal'], + pathParams: ['proposal'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancelNegotiation( + params: Params$Resource$Buyers$Proposals$Cancelnegotiation, + options: StreamMethodOptions + ): GaxiosPromise; + cancelNegotiation( + params?: Params$Resource$Buyers$Proposals$Cancelnegotiation, + options?: MethodOptions + ): GaxiosPromise; + cancelNegotiation( + params: Params$Resource$Buyers$Proposals$Cancelnegotiation, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelNegotiation( + params: Params$Resource$Buyers$Proposals$Cancelnegotiation, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancelNegotiation( + params: Params$Resource$Buyers$Proposals$Cancelnegotiation, + callback: BodyResponseCallback + ): void; + cancelNegotiation(callback: BodyResponseCallback): void; + cancelNegotiation( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Cancelnegotiation + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Cancelnegotiation; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Cancelnegotiation; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+proposal}:cancelNegotiation').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['proposal'], + pathParams: ['proposal'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a proposal using its resource name. The proposal is returned at the latest revision. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Proposals$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Proposals$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Proposals$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Proposals$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Proposals$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Proposals$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Proposals$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Proposals$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Proposals$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Proposals$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/proposals').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Buyers$Proposals$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Buyers$Proposals$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Buyers$Proposals$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Proposals$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Proposals$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + sendRfp( + params: Params$Resource$Buyers$Proposals$Sendrfp, + options: StreamMethodOptions + ): GaxiosPromise; + sendRfp( + params?: Params$Resource$Buyers$Proposals$Sendrfp, + options?: MethodOptions + ): GaxiosPromise; + sendRfp( + params: Params$Resource$Buyers$Proposals$Sendrfp, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sendRfp( + params: Params$Resource$Buyers$Proposals$Sendrfp, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sendRfp( + params: Params$Resource$Buyers$Proposals$Sendrfp, + callback: BodyResponseCallback + ): void; + sendRfp(callback: BodyResponseCallback): void; + sendRfp( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Sendrfp + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Sendrfp; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Sendrfp; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+buyer}/proposals:sendRfp').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['buyer'], + pathParams: ['buyer'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Proposals$Accept + extends StandardParameters { + /** + * Name of the proposal. Format: `buyers/{accountId\}/proposals/{proposalId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AcceptProposalRequest; + } + export interface Params$Resource$Buyers$Proposals$Addnote + extends StandardParameters { + /** + * Name of the proposal. Format: `buyers/{accountId\}/proposals/{proposalId\}` + */ + proposal?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddNoteRequest; + } + export interface Params$Resource$Buyers$Proposals$Cancelnegotiation + extends StandardParameters { + /** + * Name of the proposal. Format: `buyers/{accountId\}/proposals/{proposalId\}` + */ + proposal?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelNegotiationRequest; + } + export interface Params$Resource$Buyers$Proposals$Get + extends StandardParameters { + /** + * Required. Name of the proposal. Format: `buyers/{accountId\}/proposals/{proposalId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Proposals$List + extends StandardParameters { + /** + * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state + */ + filter?: string; + /** + * Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500. + */ + pageSize?: number; + /** + * The page token as returned from ListProposalsResponse. + */ + pageToken?: string; + /** + * Required. Parent that owns the collection of proposals Format: `buyers/{accountId\}` + */ + parent?: string; + } + export interface Params$Resource$Buyers$Proposals$Patch + extends StandardParameters { + /** + * Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId\}/proposals/{proposalId\} + */ + name?: string; + /** + * List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Proposal; + } + export interface Params$Resource$Buyers$Proposals$Sendrfp + extends StandardParameters { + /** + * Required. The current buyer who is sending the RFP in the format: `buyers/{accountId\}`. + */ + buyer?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SendRfpRequest; + } + + export class Resource$Buyers$Proposals$Deals { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Batch updates multiple deals in the same proposal. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdate( + params: Params$Resource$Buyers$Proposals$Deals$Batchupdate, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdate( + params?: Params$Resource$Buyers$Proposals$Deals$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchUpdate( + params: Params$Resource$Buyers$Proposals$Deals$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Buyers$Proposals$Deals$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Buyers$Proposals$Deals$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Deals$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Deals$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Deals$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/deals:batchUpdate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a deal given its name. The deal is returned at its head revision. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Proposals$Deals$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Proposals$Deals$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Proposals$Deals$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Proposals$Deals$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Proposals$Deals$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Deals$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Deals$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Deals$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Proposals$Deals$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Proposals$Deals$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Proposals$Deals$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Proposals$Deals$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Proposals$Deals$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Deals$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Deals$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Deals$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/deals').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Buyers$Proposals$Deals$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Buyers$Proposals$Deals$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Buyers$Proposals$Deals$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Proposals$Deals$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Buyers$Proposals$Deals$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Buyers$Proposals$Deals$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Proposals$Deals$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Proposals$Deals$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Buyers$Proposals$Deals$Batchupdate + extends StandardParameters { + /** + * Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId\}/proposals/{proposalId\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchUpdateDealsRequest; + } + export interface Params$Resource$Buyers$Proposals$Deals$Get + extends StandardParameters { + /** + * Required. Format: buyers/{accountId\}/proposals/{proposalId\}/deals/{dealId\} + */ + name?: string; + } + export interface Params$Resource$Buyers$Proposals$Deals$List + extends StandardParameters { + /** + * Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. + */ + pageSize?: number; + /** + * The page token as returned from ListDealsResponse. + */ + pageToken?: string; + /** + * Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId\}/proposals/{proposalId\} + */ + parent?: string; + } + export interface Params$Resource$Buyers$Proposals$Deals$Patch + extends StandardParameters { + /** + * Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId\}/proposals/{proposalId\}/deals/{dealId\} + */ + name?: string; + /** + * List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Deal; + } + + export class Resource$Buyers$Publisherprofiles { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the requested publisher profile by name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Buyers$Publisherprofiles$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Buyers$Publisherprofiles$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Buyers$Publisherprofiles$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Publisherprofiles$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Buyers$Publisherprofiles$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Buyers$Publisherprofiles$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Publisherprofiles$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Publisherprofiles$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Buyers$Publisherprofiles$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Buyers$Publisherprofiles$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Buyers$Publisherprofiles$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Publisherprofiles$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Buyers$Publisherprofiles$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Buyers$Publisherprofiles$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Buyers$Publisherprofiles$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buyers$Publisherprofiles$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || + 'https://authorizedbuyersmarketplace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/publisherProfiles').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Buyers$Publisherprofiles$Get + extends StandardParameters { + /** + * Required. Name of the publisher profile. Format: `buyers/{buyerId\}/publisherProfiles/{publisherProfileId\}` + */ + name?: string; + } + export interface Params$Resource$Buyers$Publisherprofiles$List + extends StandardParameters { + /** + * Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax. + */ + filter?: string; + /** + * Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100. + */ + pageSize?: number; + /** + * The page token as returned from a previous ListPublisherProfilesResponse. + */ + pageToken?: string; + /** + * Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId\}` + */ + parent?: string; + } +} diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts index df71e2b6c6..be750f007b 100644 --- a/src/apis/backupdr/v1.ts +++ b/src/apis/backupdr/v1.ts @@ -125,422 +125,5031 @@ export namespace backupdr_v1 { } /** - * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. + * request message for AbandonBackup. */ - export interface Schema$AuditConfig { - /** - * The configuration for logging of each type of permission. - */ - auditLogConfigs?: Schema$AuditLogConfig[]; + export interface Schema$AbandonBackupRequest { /** - * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + * 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). */ - service?: string | null; + requestId?: string | null; } /** - * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + * A specification of the type and number of accelerator cards attached to the instance. */ - export interface Schema$AuditLogConfig { + export interface Schema$AcceleratorConfig { /** - * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + * Optional. The number of the guest accelerator cards exposed to this instance. */ - exemptedMembers?: string[] | null; + acceleratorCount?: number | null; /** - * The log type that this config enables. + * Optional. Full or partial URL of the accelerator type resource to attach to this instance. */ - logType?: string | null; + acceleratorType?: string | null; } /** - * Associates `members`, or principals, with a `role`. + * An access configuration attached to an instance's network interface. Only one access config per instance is supported. */ - export interface Schema$Binding { + export interface Schema$AccessConfig { /** - * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. The external IPv6 address of this access configuration. */ - condition?: Schema$Expr; + externalIpv6?: string | null; /** - * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + * Optional. The prefix length of the external IPv6 range. */ - members?: string[] | null; + externalIpv6PrefixLength?: number | null; /** - * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + * Optional. The name of this access configuration. */ - role?: string | null; - } - /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$CancelOperationRequest {} - /** - * 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); \} - */ - export interface Schema$Empty {} - /** - * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. - */ - export interface Schema$Expr { + name?: string | null; /** - * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. The external IP address of this access configuration. */ - description?: string | null; + natIP?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. + * Optional. This signifies the networking tier used for configuring this access */ - expression?: string | null; + networkTier?: string | null; /** - * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. The DNS domain name for the public PTR record. */ - location?: string | null; + publicPtrDomainName?: string | null; /** - * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. */ - title?: string | null; + setPublicPtr?: boolean | null; + /** + * Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. + */ + type?: string | null; } /** - * The response message for Locations.ListLocations. + * Specifies options for controlling advanced machine features. */ - export interface Schema$ListLocationsResponse { + export interface Schema$AdvancedMachineFeatures { /** - * A list of locations that matches the specified filter in the request. + * Optional. Whether to enable nested virtualization or not (default is false). */ - locations?: Schema$Location[]; + enableNestedVirtualization?: boolean | null; /** - * The standard List next-page token. + * Optional. Whether to enable UEFI networking for instance creation. */ - nextPageToken?: string | null; + enableUefiNetworking?: boolean | null; + /** + * Optional. The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. + */ + threadsPerCore?: number | null; + /** + * Optional. The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. + */ + visibleCoreCount?: number | null; } /** - * Response message for listing management servers. + * An alias IP range attached to an instance's network interface. */ - export interface Schema$ListManagementServersResponse { + export interface Schema$AliasIpRange { /** - * The list of ManagementServer instances in the project for the specified location. If the `{location\}` value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. - */ - managementServers?: Schema$ManagementServer[]; - /** - * A token identifying a page of results the server should return. + * Optional. The IP alias ranges to allocate for this interface. */ - nextPageToken?: string | null; + ipCidrRange?: string | null; /** - * Locations that could not be reached. + * Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. */ - unreachable?: string[] | null; + subnetworkRangeName?: string | null; } /** - * The response message for Operations.ListOperations. + * Specifies the reservations that this instance can consume from. */ - export interface Schema$ListOperationsResponse { + export interface Schema$AllocationAffinity { /** - * The standard List next-page token. + * Optional. Specifies the type of reservation from which this instance can consume */ - nextPageToken?: string | null; + consumeReservationType?: string | null; /** - * A list of operations that matches the specified filter in the request. + * Optional. Corresponds to the label key of a reservation resource. */ - operations?: Schema$Operation[]; + key?: string | null; + /** + * Optional. Corresponds to the label values of a reservation resource. + */ + values?: string[] | null; } /** - * A resource that represents a Google Cloud location. + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. */ - export interface Schema$Location { + export interface Schema$AssetLocation { /** - * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. */ - displayName?: string | null; + ccfeRmsPath?: string | null; /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. */ - labels?: {[key: string]: string} | null; + expected?: Schema$IsolationExpectations; /** - * The canonical id for this location. For example: `"us-east1"`. + * Defines extra parameters required for specific asset types. */ - locationId?: string | null; + extraParameters?: Schema$ExtraParameter[]; /** - * Service-specific metadata. For example the available capacity at the given location. + * Contains all kinds of physical location definitions for this asset. */ - metadata?: {[key: string]: any} | null; + locationData?: Schema$LocationData[]; /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. */ - name?: string | null; + parentAsset?: Schema$CloudAsset[]; } /** - * ManagementServer describes a single BackupDR ManagementServer instance. + * An instance-attached disk resource. */ - export interface Schema$ManagementServer { + export interface Schema$AttachedDisk { /** - * Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy. + * Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). */ - baProxyUri?: string[] | null; + autoDelete?: boolean | null; /** - * Output only. The time when the instance was created. + * Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. */ - createTime?: string | null; + boot?: boolean | null; /** - * Optional. The description of the ManagementServer instance (2048 characters or less). + * Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs) */ - description?: string | null; + deviceName?: string | null; /** - * Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + * Optional. Encrypts or decrypts a disk using a customer-supplied encryption key. */ - etag?: string | null; + diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode. + * Optional. Specifies the disk interface to use for attaching this disk. */ - labels?: {[key: string]: string} | null; + diskInterface?: string | null; /** - * Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs. + * Optional. The size of the disk in GB. */ - managementUri?: Schema$ManagementURI; + diskSizeGb?: string | null; /** - * Output only. Identifier. The resource name. + * Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd */ - name?: string | null; + diskType?: string | null; /** - * Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. + * Specifies the type of the disk. */ - networks?: Schema$NetworkConfig[]; + diskTypeDeprecated?: string | null; /** - * Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). + * Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. */ - oauth2ClientId?: string | null; + guestOsFeature?: Schema$GuestOsFeature[]; /** - * Output only. Reserved for future use. + * Optional. A zero-based index to this disk, where 0 is reserved for the boot disk. */ - satisfiesPzi?: boolean | null; + index?: string | null; /** - * Output only. Reserved for future use. + * Optional. Specifies the parameters to initialize this disk. */ - satisfiesPzs?: boolean | null; + initializeParams?: Schema$InitializeParams; /** - * Output only. The ManagementServer state. + * Optional. Type of the resource. */ - state?: string | null; + kind?: string | null; /** - * Optional. The type of the ManagementServer resource. + * Optional. Any valid publicly visible licenses. */ - type?: string | null; + license?: string[] | null; /** - * Output only. The time when the instance was updated. + * Optional. The mode in which to attach this disk. */ - updateTime?: string | null; + mode?: string | null; /** - * Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI. + * Optional. Output only. The state of the disk. */ - workforceIdentityBasedManagementUri?: Schema$WorkforceIdentityBasedManagementURI; + savedState?: string | null; /** - * Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. + * Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. */ - workforceIdentityBasedOauth2ClientId?: Schema$WorkforceIdentityBasedOAuth2ClientID; + source?: string | null; + /** + * Optional. Specifies the type of the disk. + */ + type?: string | null; } /** - * ManagementURI for the Management Server resource. + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. */ - export interface Schema$ManagementURI { + export interface Schema$AuditConfig { /** - * Output only. The ManagementServer AGM/RD API URL. + * The configuration for logging of each type of permission. */ - api?: string | null; + auditLogConfigs?: Schema$AuditLogConfig[]; /** - * Output only. The ManagementServer AGM/RD WebUI URL. + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ - webUi?: string | null; + service?: string | null; } /** - * Network configuration for ManagementServer instance. + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \} ] \} This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. */ - export interface Schema$NetworkConfig { + export interface Schema$AuditLogConfig { /** - * Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected. + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ - network?: string | null; + exemptedMembers?: string[] | null; /** - * Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported. + * The log type that this config enables. */ - peeringMode?: string | null; + logType?: string | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * Message describing a Backup object. */ - export interface Schema$Operation { + export interface Schema$Backup { /** - * 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. + * Output only. Backup Appliance specific backup properties. */ - done?: boolean | null; + backupApplianceBackupProperties?: Schema$BackupApplianceBackupProperties; /** - * The error result of the operation in case of failure or cancellation. + * Optional. The list of BackupLocks taken by the accessor Backup Appliance. */ - error?: Schema$Status; + backupApplianceLocks?: Schema$BackupLock[]; /** - * 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. + * Output only. Type of the backup, unspecified, scheduled or ondemand. */ - metadata?: {[key: string]: any} | null; + backupType?: string | null; /** - * 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\}`. + * Output only. Compute Engine specific backup properties. */ - name?: string | null; + computeInstanceBackupProperties?: Schema$ComputeInstanceBackupProperties; /** - * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * Output only. The point in time when this backup was captured from the source. */ - response?: {[key: string]: any} | null; - } - /** - * Represents the metadata of the long-running operation. - */ - export interface Schema$OperationMetadata { + consistencyTime?: string | null; /** - * Output only. AdditionalInfo contains additional Info related to backup plan association resource. + * Output only. The time when the instance was created. */ - additionalInfo?: {[key: string]: string} | null; + createTime?: string | null; /** - * Output only. API version used to start the operation. + * Output only. The description of the Backup instance (2048 characters or less). */ - apiVersion?: string | null; + description?: string | null; /** - * Output only. The time the operation was created. + * Optional. The backup can not be deleted before this time. */ - createTime?: string | null; + enforcedRetentionEndTime?: string | null; /** - * Output only. The time the operation finished running. + * Optional. Server specified ETag to prevent updates from overwriting each other. */ - endTime?: string | null; + etag?: string | null; /** - * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Optional. When this backup is automatically expired. */ - requestedCancellation?: boolean | null; + expireTime?: string | null; /** - * Output only. Human-readable status of the operation, if any. + * Output only. Configuration for a Google Cloud resource. */ - statusMessage?: string | null; + gcpBackupPlanInfo?: Schema$GCPBackupPlanInfo; /** - * Output only. Server-defined resource path for the target of the operation. + * Optional. Resource labels to represent user provided metadata. No labels currently defined. */ - target?: string | null; + labels?: {[key: string]: string} | null; /** - * Output only. Name of the verb executed by the operation. + * Output only. Identifier. Name of the resource. */ - verb?: string | null; - } - /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - */ - export interface Schema$Policy { + name?: string | null; /** - * Specifies cloud audit logging configuration for this policy. + * Output only. source resource size in bytes at the time of the backup. */ - auditConfigs?: Schema$AuditConfig[]; + resourceSizeBytes?: string | null; /** - * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + * Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup. */ - bindings?: Schema$Binding[]; + serviceLocks?: Schema$BackupLock[]; /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + * Output only. The Backup resource instance state. */ - etag?: string | null; + state?: string | null; /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Output only. The time when the instance was updated. */ - version?: number | null; + updateTime?: string | null; } /** - * Request message for `SetIamPolicy` method. + * BackupApplianceBackupConfig captures the backup configuration for applications that are protected by Backup Appliances. */ - export interface Schema$SetIamPolicyRequest { + export interface Schema$BackupApplianceBackupConfig { /** - * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + * The name of the application. */ - policy?: Schema$Policy; + applicationName?: string | null; /** - * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` + * The ID of the backup appliance. */ - updateMask?: string | null; - } - /** - * 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). - */ - export interface Schema$Status { + backupApplianceId?: string | null; /** - * The status code, which should be an enum value of google.rpc.Code. + * The name of the backup appliance. */ - code?: number | null; + backupApplianceName?: string | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * The name of the host where the application is running. */ - details?: Array<{[key: string]: any}> | null; + hostName?: string | null; /** - * 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. + * The ID of the SLA of this application. */ - message?: string | null; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$TestIamPermissionsRequest { + slaId?: string | null; /** - * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + * The name of the SLP associated with the application. */ - permissions?: string[] | null; + slpName?: string | null; + /** + * The name of the SLT associated with the application. + */ + sltName?: string | null; } /** - * Response message for `TestIamPermissions` method. + * BackupApplianceBackupProperties represents BackupDR backup appliance's properties. */ - export interface Schema$TestIamPermissionsResponse { + export interface Schema$BackupApplianceBackupProperties { /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + * Output only. The time when this backup object was finalized (if none, backup is not finalized). */ - permissions?: string[] | null; + finalizeTime?: string | null; + /** + * Output only. The numeric generation ID of the backup (monotonically increasing). + */ + generationId?: number | null; + /** + * Optional. The latest timestamp of data available in this Backup. + */ + recoveryRangeEndTime?: string | null; + /** + * Optional. The earliest timestamp of data available in this Backup. + */ + recoveryRangeStartTime?: string | null; } /** - * ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. + * BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. */ - export interface Schema$WorkforceIdentityBasedManagementURI { + export interface Schema$BackupApplianceLockInfo { /** - * Output only. First party Management URI for Google Identities. + * Required. The ID of the backup/recovery appliance that created this lock. */ - firstPartyManagementUri?: string | null; + backupApplianceId?: string | null; /** - * Output only. Third party Management URI for External Identity Providers. + * Required. The name of the backup/recovery appliance that created this lock. */ - thirdPartyManagementUri?: string | null; + backupApplianceName?: string | null; + /** + * The image name that depends on this Backup. + */ + backupImage?: string | null; + /** + * The job name on the backup/recovery appliance that created this lock. + */ + jobName?: string | null; + /** + * Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service. + */ + lockReason?: string | null; + /** + * The SLA on the backup/recovery appliance that owns the lock. + */ + slaId?: string | null; } /** - * OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, + * BackupConfigInfo has information about how the resource is configured for Backup and about the most recent backup to this vault. */ - export interface Schema$WorkforceIdentityBasedOAuth2ClientID { + export interface Schema$BackupConfigInfo { /** - * Output only. First party OAuth Client ID for Google Identities. + * Configuration for an application backed up by a Backup Appliance. */ - firstPartyOauth2ClientId?: string | null; + backupApplianceBackupConfig?: Schema$BackupApplianceBackupConfig; /** - * Output only. Third party OAuth Client ID for External Identity Providers. + * Configuration for a Google Cloud resource. */ - thirdPartyOauth2ClientId?: string | null; + gcpBackupConfig?: Schema$GcpBackupConfig; + /** + * Output only. If the last backup failed, this field has the error message. + */ + lastBackupError?: Schema$Status; + /** + * Output only. The status of the last backup to this BackupVault + */ + lastBackupState?: string | null; + /** + * Output only. If the last backup were successful, this field has the consistency date. + */ + lastSuccessfulBackupConsistencyTime?: string | null; + } + /** + * BackupLock represents a single lock on a Backup resource. An unexpired lock on a Backup prevents the Backup from being deleted. + */ + export interface Schema$BackupLock { + /** + * If the client is a backup and recovery appliance, this contains metadata about why the lock exists. + */ + backupApplianceLockInfo?: Schema$BackupApplianceLockInfo; + /** + * Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion. + */ + lockUntilTime?: string | null; + /** + * Output only. Contains metadata about the lock exist for Google Cloud native backups. + */ + serviceLockInfo?: Schema$ServiceLockInfo; + } + /** + * A `BackupPlan` specifies some common fields, such as `display_name` as well as one or more `BackupRule` messages. Each `BackupRule` has a retention policy and defines a schedule by which the system is to perform backup workloads. + */ + export interface Schema$BackupPlan { + /** + * Required. The backup rules for this `BackupPlan`. There must be at least one `BackupRule` message. + */ + backupRules?: Schema$BackupRule[]; + /** + * Required. Resource name of backup vault which will be used as storage location for backups. Format: projects/{project\}/locations/{location\}/backupVaults/{backupvault\} + */ + backupVault?: string | null; + /** + * Output only. The Google Cloud Platform Service Account to be used by the BackupVault for taking backups. Specify the email address of the Backup Vault Service Account. + */ + backupVaultServiceAccount?: string | null; + /** + * Output only. When the `BackupPlan` was created. + */ + createTime?: string | null; + /** + * Optional. The description of the `BackupPlan` resource. The description allows for additional details about `BackupPlan` and its use cases to be provided. An example description is the following: "This is a backup plan that performs a daily backup at 6pm and retains data for 3 months". The description must be at most 2048 characters. + */ + description?: string | null; + /** + * Optional. `etag` is returned from the service in the response. As a user of the service, you may provide an etag value in this field to prevent stale resources. + */ + etag?: string | null; + /** + * Optional. This collection of key/value pairs allows for custom labels to be supplied by the user. Example, {"tag": "Weekly"\}. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project\}/locations/{location\}/backupPlans/{backup_plan\}` + */ + name?: string | null; + /** + * Required. The resource type to which the `BackupPlan` will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket". + */ + resourceType?: string | null; + /** + * Output only. The `State` for the `BackupPlan`. + */ + state?: string | null; + /** + * Output only. When the `BackupPlan` was last updated. + */ + updateTime?: string | null; + } + /** + * A BackupPlanAssociation represents a single BackupPlanAssociation which contains details like workload, backup plan etc + */ + export interface Schema$BackupPlanAssociation { + /** + * Required. Resource name of backup plan which needs to be applied on workload. Format: projects/{project\}/locations/{location\}/backupPlans/{backupPlanId\} + */ + backupPlan?: string | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * Output only. Output Only. Resource name of data source which will be used as storage location for backups taken. Format : projects/{project\}/locations/{location\}/backupVaults/{backupvault\}/dataSources/{datasource\} + */ + dataSource?: string | null; + /** + * Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project\}/locations/{location\}/backupPlanAssociations/{backupPlanAssociationId\} + */ + name?: string | null; + /** + * Required. Immutable. Resource name of workload on which backupplan is applied + */ + resource?: string | null; + /** + * Output only. Output Only. Resource type of workload on which backupplan is applied + */ + resourceType?: string | null; + /** + * Output only. The config info related to backup rules. + */ + rulesConfigInfo?: Schema$RuleConfigInfo[]; + /** + * Output only. The BackupPlanAssociation resource state. + */ + state?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + } + /** + * `BackupRule` binds the backup schedule to a retention policy. + */ + export interface Schema$BackupRule { + /** + * Required. Configures the duration for which backup data will be kept. It is defined in “days”. The value should be greater than or equal to minimum enforced retention of the backup vault. + */ + backupRetentionDays?: number | null; + /** + * Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is unique per `BackupPlan`.The `rule_id` must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62\}/. + */ + ruleId?: string | null; + /** + * Required. Defines a schedule that runs within the confines of a defined window of time. + */ + standardSchedule?: Schema$StandardSchedule; + } + /** + * Message describing a BackupVault object. + */ + export interface Schema$BackupVault { + /** + * Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. + */ + annotations?: {[key: string]: string} | null; + /** + * Output only. The number of backups in this backup vault. + */ + backupCount?: string | null; + /** + * Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. + */ + backupMinimumEnforcedRetentionDuration?: string | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * Output only. Set to true when there are no backups nested under this resource. + */ + deletable?: boolean | null; + /** + * Optional. The description of the BackupVault instance (2048 characters or less). + */ + description?: string | null; + /** + * Optional. Time after which the BackupVault resource is locked. + */ + effectiveTime?: string | null; + /** + * Required. The default retention period for each backup in the backup vault (Deprecated). + */ + enforcedRetentionDuration?: string | null; + /** + * Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. No labels currently defined: + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Identifier. The resource name. + */ + name?: string | null; + /** + * Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there. + */ + serviceAccount?: string | null; + /** + * Output only. The BackupVault resource instance state. + */ + state?: string | null; + /** + * Output only. Total size of the storage used by all backup resources. + */ + totalStoredBytes?: string | null; + /** + * Output only. Output only Immutable after resource creation until resource deletion. + */ + uid?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + } + /** + * `BackupWindow` defines a window of the day during which backup jobs will run. + */ + export interface Schema$BackupWindow { + /** + * Required. The hour of day (1-24) when the window end for e.g. if value of end hour of day is 10 that mean backup window end time is 10:00. End hour of day should be greater than start hour of day. 0 <= start_hour_of_day < end_hour_of_day <= 24 End hour of day is not include in backup window that mean if end_hour_of_day= 10 jobs should start before 10:00. + */ + endHourOfDay?: number | null; + /** + * Required. The hour of day (0-23) when the window starts for e.g. if value of start hour of day is 6 that mean backup window start at 6:00. + */ + startHourOfDay?: number | null; + } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + condition?: Schema$Expr; + /** + * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/group/{group_id\}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/x`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/subject/{subject_attribute_value\}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/group/{group_id\}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/attribute.{attribute_name\}/{attribute_value\}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number\}/locations/global/workloadIdentityPools/{pool_id\}/x`: All identities in a workload identity pool. * `deleted:user:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid\}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid\}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid\}?uid={uniqueid\}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid\}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id\}/subject/{subject_attribute_value\}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles). + */ + role?: string | null; + } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } + /** + * ComputeInstanceBackupProperties represents Compute Engine instance backup properties. + */ + export interface Schema$ComputeInstanceBackupProperties { + /** + * Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information. + */ + canIpForward?: boolean | null; + /** + * An optional text description for the instances that are created from these properties. + */ + description?: string | null; + /** + * An array of disks that are associated with the instances that are created from these properties. + */ + disk?: Schema$AttachedDisk[]; + /** + * A list of guest accelerator cards' type and count to use for instances created from these properties. + */ + guestAccelerator?: Schema$AcceleratorConfig[]; + /** + * KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. + */ + keyRevocationActionType?: string | null; + /** + * The machine type to use for instances that are created from these properties. + */ + machineType?: string | null; + /** + * The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See https://cloud.google.com/compute/docs/metadata/overview for more information. + */ + metadata?: Schema$Metadata; + /** + * Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + */ + minCpuPlatform?: string | null; + /** + * An array of network access configurations for this interface. + */ + networkInterface?: Schema$NetworkInterface[]; + /** + * Specifies the scheduling options for the instances that are created from these properties. + */ + scheduling?: Schema$Scheduling; + /** + * A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. + */ + serviceAccount?: Schema$ServiceAccount[]; + /** + * The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance + */ + sourceInstance?: string | null; + /** + * A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). + */ + tags?: Schema$Tags; } + /** + * ComputeInstanceDataSourceProperties represents the properties of a ComputeEngine resource that are stored in the DataSource. + */ + export interface Schema$ComputeInstanceDataSourceProperties { + /** + * The description of the Compute Engine instance. + */ + description?: string | null; + /** + * The machine type of the instance. + */ + machineType?: string | null; + /** + * Name of the compute instance backed up by the datasource. + */ + name?: string | null; + /** + * The total number of disks attached to the Instance. + */ + totalDiskCount?: string | null; + /** + * The sum of all the disk sizes. + */ + totalDiskSizeGb?: string | null; + } + /** + * ComputeInstanceRestoreProperties represents Compute Engine instance properties to be overridden during restore. + */ + export interface Schema$ComputeInstanceRestoreProperties { + /** + * Optional. Controls for advanced machine-related behavior features. + */ + advancedMachineFeatures?: Schema$AdvancedMachineFeatures; + /** + * Optional. Allows this instance to send and receive packets with non-matching destination or source IPs. + */ + canIpForward?: boolean | null; + /** + * Optional. Controls Confidential compute options on the instance + */ + confidentialInstanceConfig?: Schema$ConfidentialInstanceConfig; + /** + * Optional. Whether the resource should be protected against deletion. + */ + deletionProtection?: boolean | null; + /** + * Optional. An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Optional. Array of disks associated with this instance. Persistent disks must be created before you can assign them. + */ + disks?: Schema$AttachedDisk[]; + /** + * Optional. Enables display device for the instance. + */ + displayDevice?: Schema$DisplayDevice; + /** + * Optional. A list of the type and count of accelerator cards attached to the instance. + */ + guestAccelerators?: Schema$AcceleratorConfig[]; + /** + * Optional. Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. + */ + hostname?: string | null; + /** + * Optional. Encrypts suspended data for an instance with a customer-managed encryption key. + */ + instanceEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * Optional. KeyRevocationActionType of the instance. + */ + keyRevocationActionType?: string | null; + /** + * Optional. Labels to apply to this instance. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. Full or partial URL of the machine type resource to use for this instance. + */ + machineType?: string | null; + /** + * Optional. This includes custom metadata and predefined keys. + */ + metadata?: Schema$Metadata; + /** + * Optional. Minimum CPU platform to use for this instance. + */ + minCpuPlatform?: string | null; + /** + * Required. Name of the compute instance. + */ + name?: string | null; + /** + * Optional. An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. + */ + networkInterfaces?: Schema$NetworkInterface[]; + /** + * Optional. Configure network performance such as egress bandwidth tier. + */ + networkPerformanceConfig?: Schema$NetworkPerformanceConfig; + /** + * Input only. Additional params passed with the request, but not persisted as part of resource payload. + */ + params?: Schema$InstanceParams; + /** + * Optional. The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. + */ + privateIpv6GoogleAccess?: string | null; + /** + * Optional. Specifies the reservations that this instance can consume from. + */ + reservationAffinity?: Schema$AllocationAffinity; + /** + * Optional. Resource policies applied to this instance. + */ + resourcePolicies?: string[] | null; + /** + * Optional. Sets the scheduling options for this instance. + */ + scheduling?: Schema$Scheduling; + /** + * Optional. A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. + */ + serviceAccounts?: Schema$ServiceAccount[]; + /** + * Optional. Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. + */ + tags?: Schema$Tags; + } + /** + * ComputeInstanceTargetEnvironment represents Compute Engine target environment to be used during restore. + */ + export interface Schema$ComputeInstanceTargetEnvironment { + /** + * Required. Target project for the Compute Engine instance. + */ + project?: string | null; + /** + * Required. The zone of the Compute Engine instance. + */ + zone?: string | null; + } + /** + * A set of Confidential Instance options. + */ + export interface Schema$ConfidentialInstanceConfig { + /** + * Optional. Defines whether the instance should have confidential compute enabled. + */ + enableConfidentialCompute?: boolean | null; + } + /** + * A customer-supplied encryption key. + */ + export interface Schema$CustomerEncryptionKey { + /** + * Optional. The name of the encryption key that is stored in Google Cloud KMS. + */ + kmsKeyName?: string | null; + /** + * Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. + */ + kmsKeyServiceAccount?: string | null; + /** + * Optional. Specifies a 256-bit customer-supplied encryption key. + */ + rawKey?: string | null; + /** + * Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. + */ + rsaEncryptedKey?: string | null; + } + /** + * Message describing a DataSource object. Datasource object used to represent Datasource details for both admin and basic view. + */ + export interface Schema$DataSource { + /** + * Output only. Details of how the resource is configured for backup. + */ + backupConfigInfo?: Schema$BackupConfigInfo; + /** + * Number of backups in the data source. + */ + backupCount?: string | null; + /** + * Output only. The backup configuration state. + */ + configState?: string | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * The backed up resource is a backup appliance application. + */ + dataSourceBackupApplianceApplication?: Schema$DataSourceBackupApplianceApplication; + /** + * The backed up resource is a Google Cloud resource. The word 'DataSource' was included in the names to indicate that this is the representation of the Google Cloud resource used within the DataSource object. + */ + dataSourceGcpResource?: Schema$DataSourceGcpResource; + /** + * Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. No labels currently defined: + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Identifier. The resource name. + */ + name?: string | null; + /** + * Output only. The DataSource resource instance state. + */ + state?: string | null; + /** + * The number of bytes (metadata and data) stored in this datasource. + */ + totalStoredBytes?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + } + /** + * BackupApplianceApplication describes a Source Resource when it is an application backed up by a BackupAppliance. + */ + export interface Schema$DataSourceBackupApplianceApplication { + /** + * Appliance Id of the Backup Appliance. + */ + applianceId?: string | null; + /** + * The appid field of the application within the Backup Appliance. + */ + applicationId?: string | null; + /** + * The name of the Application as known to the Backup Appliance. + */ + applicationName?: string | null; + /** + * Appliance name. + */ + backupAppliance?: string | null; + /** + * Hostid of the application host. + */ + hostId?: string | null; + /** + * Hostname of the host where the application is running. + */ + hostname?: string | null; + /** + * The type of the application. e.g. VMBackup + */ + type?: string | null; + } + /** + * DataSourceGcpResource is used for protected resources that are Google Cloud Resources. This name is easeier to understand than GcpResourceDataSource or GcpDataSourceResource + */ + export interface Schema$DataSourceGcpResource { + /** + * ComputeInstanceDataSourceProperties has a subset of Compute Instance properties that are useful at the Datasource level. + */ + computeInstanceDatasourceProperties?: Schema$ComputeInstanceDataSourceProperties; + /** + * Output only. Full resource pathname URL of the source Google Cloud resource. + */ + gcpResourcename?: string | null; + /** + * Location of the resource: //"global"/"unspecified". + */ + location?: string | null; + /** + * The type of the Google Cloud resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. + */ + type?: string | null; + } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } + /** + * A set of Display Device options + */ + export interface Schema$DisplayDevice { + /** + * Optional. Enables display for the Compute Engine VM + */ + enableDisplay?: boolean | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * A key/value pair to be used for storing metadata. + */ + export interface Schema$Entry { + /** + * Optional. Key for the metadata entry. + */ + key?: string | null; + /** + * Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). + */ + value?: string | null; + } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } + /** + * Request message for FetchAccessToken. + */ + export interface Schema$FetchAccessTokenRequest { + /** + * Required. The generation of the backup to update. + */ + generationId?: number | null; + } + /** + * Response message for FetchAccessToken. + */ + export interface Schema$FetchAccessTokenResponse { + /** + * The token is valid until this time. + */ + expireTime?: string | null; + /** + * The location in bucket that can be used for reading. + */ + readLocation?: string | null; + /** + * The downscoped token that was created. + */ + token?: string | null; + /** + * The location in bucket that can be used for writing. + */ + writeLocation?: string | null; + } + /** + * Response message for fetching usable BackupVaults. + */ + export interface Schema$FetchUsableBackupVaultsResponse { + /** + * The list of BackupVault instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backupVaults?: Schema$BackupVault[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for finalizing a Backup. + */ + export interface Schema$FinalizeBackupRequest { + /** + * Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest. + */ + backupId?: string | null; + /** + * The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup. + */ + consistencyTime?: string | null; + /** + * This will be assigned to the description field of the newly created Backup. + */ + description?: string | null; + /** + * The latest timestamp of data available in this Backup. This will be set on the newly created Backup. + */ + recoveryRangeEndTime?: string | null; + /** + * The earliest timestamp of data available in this Backup. This will set on the newly created Backup. + */ + recoveryRangeStartTime?: string | null; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime. + */ + retentionDuration?: string | null; + } + /** + * GcpBackupConfig captures the Backup configuration details for Google Cloud resources. All Google Cloud resources regardless of type are protected with backup plan associations. + */ + export interface Schema$GcpBackupConfig { + /** + * The name of the backup plan. + */ + backupPlan?: string | null; + /** + * The name of the backup plan association. + */ + backupPlanAssociation?: string | null; + /** + * The description of the backup plan. + */ + backupPlanDescription?: string | null; + /** + * The names of the backup plan rules which point to this backupvault + */ + backupPlanRules?: string[] | null; + } + /** + * GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. + */ + export interface Schema$GCPBackupPlanInfo { + /** + * Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project\}/locations/{location\}/backupPlans/{backupPlanId\} + */ + backupPlan?: string | null; + /** + * The rule id of the backup plan which triggered this backup in case of scheduled backup or used for + */ + backupPlanRuleId?: string | null; + } + /** + * Feature type of the Guest OS. + */ + export interface Schema$GuestOsFeature { + /** + * The ID of a supported feature. + */ + type?: string | null; + } + /** + * Specifies the parameters to initialize this disk. + */ + export interface Schema$InitializeParams { + /** + * Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. + */ + diskName?: string | null; + /** + * Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance. + */ + replicaZones?: string[] | null; + } + /** + * request message for InitiateBackup. + */ + export interface Schema$InitiateBackupRequest { + /** + * Required. Resource ID of the Backup resource. + */ + backupId?: string | null; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Response message for InitiateBackup. + */ + export interface Schema$InitiateBackupResponse { + /** + * The name of the backup that was created. + */ + backup?: string | null; + /** + * The generation id of the base backup. It is needed for the incremental backups. + */ + baseBackupGenerationId?: number | null; + /** + * The generation id of the new backup. + */ + newBackupGenerationId?: number | null; + } + /** + * Additional instance params. + */ + export interface Schema$InstanceParams { + /** + * Optional. Resource manager tags to be bound to the instance. + */ + resourceManagerTags?: {[key: string]: string} | null; + } + export interface Schema$IsolationExpectations { + /** + * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. + */ + requirementOverride?: Schema$RequirementOverride; + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } + /** + * Response message for List BackupPlanAssociation + */ + export interface Schema$ListBackupPlanAssociationsResponse { + /** + * The list of Backup Plan Associations in the project for the specified location. If the `{location\}` value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup plan associations in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backupPlanAssociations?: Schema$BackupPlanAssociation[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for getting a list of `BackupPlan`. + */ + export interface Schema$ListBackupPlansResponse { + /** + * The list of `BackupPlans` in the project for the specified location. If the `{location\}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan + */ + backupPlans?: Schema$BackupPlan[]; + /** + * A token which may be sent as page_token in a subsequent `ListBackupPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for listing Backups. + */ + export interface Schema$ListBackupsResponse { + /** + * The list of Backup instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backups?: Schema$Backup[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for listing BackupVaults. + */ + export interface Schema$ListBackupVaultsResponse { + /** + * The list of BackupVault instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + backupVaults?: Schema$BackupVault[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Response message for listing DataSources. + */ + export interface Schema$ListDataSourcesResponse { + /** + * The list of DataSource instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return data sources in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + dataSources?: Schema$DataSource[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing management servers. + */ + export interface Schema$ListManagementServersResponse { + /** + * The list of ManagementServer instances in the project for the specified location. If the '{location\}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + managementServers?: Schema$ManagementServer[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } + /** + * ManagementServer describes a single BackupDR ManagementServer instance. + */ + export interface Schema$ManagementServer { + /** + * Output only. The hostname or ip address of the exposed AGM endpoints, used by BAs to connect to BA proxy. + */ + baProxyUri?: string[] | null; + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * Optional. The description of the ManagementServer instance (2048 characters or less). + */ + description?: string | null; + /** + * Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs. + */ + managementUri?: Schema$ManagementURI; + /** + * Output only. Identifier. The resource name. + */ + name?: string | null; + /** + * Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. + */ + networks?: Schema$NetworkConfig[]; + /** + * Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the 'aud' field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). + */ + oauth2ClientId?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Output only. The ManagementServer state. + */ + state?: string | null; + /** + * Optional. The type of the ManagementServer resource. + */ + type?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + /** + * Output only. The hostnames of the exposed AGM endpoints for both types of user i.e. 1p and 3p, used to connect AGM/RM UI. + */ + workforceIdentityBasedManagementUri?: Schema$WorkforceIdentityBasedManagementURI; + /** + * Output only. The OAuth client IDs for both types of user i.e. 1p and 3p. + */ + workforceIdentityBasedOauth2ClientId?: Schema$WorkforceIdentityBasedOAuth2ClientID; + } + /** + * ManagementURI for the Management Server resource. + */ + export interface Schema$ManagementURI { + /** + * Output only. The ManagementServer AGM/RD API URL. + */ + api?: string | null; + /** + * Output only. The ManagementServer AGM/RD WebUI URL. + */ + webUi?: string | null; + } + /** + * A metadata key/value entry. + */ + export interface Schema$Metadata { + /** + * Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. + */ + items?: Schema$Entry[]; + } + /** + * Network configuration for ManagementServer instance. + */ + export interface Schema$NetworkConfig { + /** + * Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected. + */ + network?: string | null; + /** + * Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported. + */ + peeringMode?: string | null; + } + /** + * A network interface resource attached to an instance. s + */ + export interface Schema$NetworkInterface { + /** + * Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access. + */ + accessConfigs?: Schema$AccessConfig[]; + /** + * Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. + */ + aliasIpRanges?: Schema$AliasIpRange[]; + /** + * Optional. The prefix length of the primary internal IPv6 range. + */ + internalIpv6PrefixLength?: number | null; + /** + * Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. + */ + ipv6AccessConfigs?: Schema$AccessConfig[]; + /** + * Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. + */ + ipv6AccessType?: string | null; + /** + * Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork. + */ + ipv6Address?: string | null; + /** + * Output only. [Output Only] The name of the network interface, which is generated by the server. + */ + name?: string | null; + /** + * Optional. URL of the VPC network resource for this instance. + */ + network?: string | null; + /** + * Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number\}/regions/{region_name\}/networkAttachments/{network_attachment_name\}. + */ + networkAttachment?: string | null; + /** + * Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. + */ + networkIP?: string | null; + /** + * Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. + */ + nicType?: string | null; + /** + * Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. + */ + queueCount?: number | null; + /** + * The stack type for this network interface. + */ + stackType?: string | null; + /** + * Optional. The URL of the Subnetwork resource for this instance. + */ + subnetwork?: string | null; + } + /** + * Network performance configuration. + */ + export interface Schema$NetworkPerformanceConfig { + /** + * Optional. The tier of the total egress bandwidth. + */ + totalEgressBandwidthTier?: string | null; + } + /** + * Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled. + */ + export interface Schema$NodeAffinity { + /** + * Optional. Corresponds to the label key of Node resource. + */ + key?: string | null; + /** + * Optional. Defines the operation of node selection. + */ + operator?: string | null; + /** + * Optional. Corresponds to the label values of Node resource. + */ + values?: string[] | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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?: {[key: string]: any} | null; + /** + * 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 | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. AdditionalInfo contains additional Info related to backup plan association resource. + */ + additionalInfo?: {[key: string]: string} | null; + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to 'Code.CANCELLED'. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. + */ + bindings?: Schema$Binding[]; + /** + * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + version?: number | null; + } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } + /** + * Message for deleting a DataSource. + */ + export interface Schema$RemoveDataSourceRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + export interface Schema$RequirementOverride { + ziOverride?: string | null; + zsOverride?: string | null; + } + /** + * Request message for restoring from a Backup. + */ + export interface Schema$RestoreBackupRequest { + /** + * Compute Engine instance properties to be overridden during restore. + */ + computeInstanceRestoreProperties?: Schema$ComputeInstanceRestoreProperties; + /** + * Compute Engine target environment to be used during restore. + */ + computeInstanceTargetEnvironment?: Schema$ComputeInstanceTargetEnvironment; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Message for rules config info. + */ + export interface Schema$RuleConfigInfo { + /** + * Output only. Output Only. google.rpc.Status object to store the last backup error. + */ + lastBackupError?: Schema$Status; + /** + * Output only. The last backup state for rule. + */ + lastBackupState?: string | null; + /** + * Output only. The point in time when the last successful backup was captured from the source. + */ + lastSuccessfulBackupConsistencyTime?: string | null; + /** + * Output only. Output Only. Backup Rule id fetched from backup plan. + */ + ruleId?: string | null; + } + /** + * Sets the scheduling options for an Instance. + */ + export interface Schema$Scheduling { + /** + * Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). + */ + automaticRestart?: boolean | null; + /** + * Optional. Specifies the termination action for the instance. + */ + instanceTerminationAction?: string | null; + /** + * Optional. Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. + */ + localSsdRecoveryTimeout?: Schema$SchedulingDuration; + /** + * Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. + */ + minNodeCpus?: number | null; + /** + * Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity. + */ + nodeAffinities?: Schema$NodeAffinity[]; + /** + * Optional. Defines the maintenance behavior for this instance. + */ + onHostMaintenance?: string | null; + /** + * Optional. Defines whether the instance is preemptible. + */ + preemptible?: boolean | null; + /** + * Optional. Specifies the provisioning model of the instance. + */ + provisioningModel?: string | null; + } + /** + * A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. + */ + export interface Schema$SchedulingDuration { + /** + * Optional. Span of time that's a fraction of a second at nanosecond resolution. + */ + nanos?: number | null; + /** + * Optional. Span of time at a resolution of a second. + */ + seconds?: string | null; + } + /** + * A service account. + */ + export interface Schema$ServiceAccount { + /** + * Optional. Email address of the service account. + */ + email?: string | null; + /** + * Optional. The list of scopes to be made available for this service account. + */ + scopes?: string[] | null; + } + /** + * ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. + */ + export interface Schema$ServiceLockInfo { + /** + * Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes. + */ + operation?: string | null; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. + */ + policy?: Schema$Policy; + /** + * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"` + */ + updateMask?: string | null; + } + /** + * Request message for SetStatusInternal method. + */ + export interface Schema$SetInternalStatusRequest { + /** + * Required. Output only. The new BackupConfigState to set for the DataSource. + */ + backupConfigState?: string | null; + /** + * 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * Required. The value required for this method to work. This field must be the 32-byte SHA256 hash of the DataSourceID. The DataSourceID used here is only the final piece of the fully qualified resource path for this DataSource (i.e. the part after '.../dataSources/'). This field exists to make this method difficult to call since it is intended for use only by Backup Appliances. + */ + value?: string | null; + } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } + /** + * `StandardSchedule` defines a schedule that run within the confines of a defined window of days. We can define recurrence type for schedule as HOURLY, DAILY, WEEKLY, MONTHLY or YEARLY. + */ + export interface Schema$StandardSchedule { + /** + * Required. A BackupWindow defines the window of day during which backup jobs will run. Jobs are queued at the beginning of the window and will be marked as `NOT_RUN` if they do not start by the end of the window. Note: running jobs will not be cancelled at the end of the window. + */ + backupWindow?: Schema$BackupWindow; + /** + * Optional. Specifies days of months like 1, 5, or 14 on which jobs will run. Values for `days_of_month` are only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied. + */ + daysOfMonth?: number[] | null; + /** + * Optional. Specifies days of week like, MONDAY or TUESDAY, on which jobs will run. This is required for `recurrence_type`, `WEEKLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `WEEKLY`. + */ + daysOfWeek?: string[] | null; + /** + * Optional. Specifies frequency for hourly backups. A hourly frequency of 2 means jobs will run every 2 hours from start time till end time defined. This is required for `recurrence_type`, `HOURLY` and is not applicable otherwise. A validation error will occur if a value is supplied and `recurrence_type` is not `HOURLY`. Value of hourly frequency should be between 6 and 23. Reason for limit : We found that there is bandwidth limitation of 3GB/S for GMI while taking a backup and 5GB/S while doing a restore. Given the amount of parallel backups and restore we are targeting, this will potentially take the backup time to mins and hours (in worst case scenario). + */ + hourlyFrequency?: number | null; + /** + * Optional. Specifies the months of year, like `FEBRUARY` and/or `MAY`, on which jobs will run. This field is only applicable when `recurrence_type` is `YEARLY`. A validation error will occur if other values are supplied. + */ + months?: string[] | null; + /** + * Required. Specifies the `RecurrenceType` for the schedule. + */ + recurrenceType?: string | null; + /** + * Required. The time zone to be used when interpreting the schedule. The value of this field must be a time zone name from the IANA tz database. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for the list of valid timezone names. For e.g., Europe/Paris. + */ + timeZone?: string | null; + /** + * Optional. Specifies a week day of the month like, FIRST SUNDAY or LAST MONDAY, on which jobs will run. This will be specified by two fields in `WeekDayOfMonth`, one for the day, e.g. `MONDAY`, and one for the week, e.g. `LAST`. This field is only applicable for `recurrence_type`, `MONTHLY` and `YEARLY`. A validation error will occur if other values are supplied. + */ + weekDayOfMonth?: Schema$WeekDayOfMonth; + } + /** + * 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). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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 | null; + } + /** + * A set of instance tags. + */ + export interface Schema$Tags { + /** + * Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. + */ + items?: string[] | null; + } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * Request message for triggering a backup. + */ + export interface Schema$TriggerBackupRequest { + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + /** + * Required. backup rule_id for which a backup needs to be triggered. + */ + ruleId?: string | null; + } + /** + * `WeekDayOfMonth` defines the week day of the month on which the backups will run. The message combines a `WeekOfMonth` and `DayOfWeek` to produce values like `FIRST`/`MONDAY` or `LAST`/`FRIDAY`. + */ + export interface Schema$WeekDayOfMonth { + /** + * Required. Specifies the day of the week. + */ + dayOfWeek?: string | null; + /** + * Required. Specifies the week of the month. + */ + weekOfMonth?: string | null; + } + /** + * ManagementURI depending on the Workforce Identity i.e. either 1p or 3p. + */ + export interface Schema$WorkforceIdentityBasedManagementURI { + /** + * Output only. First party Management URI for Google Identities. + */ + firstPartyManagementUri?: string | null; + /** + * Output only. Third party Management URI for External Identity Providers. + */ + thirdPartyManagementUri?: string | null; + } + /** + * OAuth Client ID depending on the Workforce Identity i.e. either 1p or 3p, + */ + export interface Schema$WorkforceIdentityBasedOAuth2ClientID { + /** + * Output only. First party OAuth Client ID for Google Identities. + */ + firstPartyOauth2ClientId?: string | null; + /** + * Output only. Third party OAuth Client ID for External Identity Providers. + */ + thirdPartyOauth2ClientId?: string | null; + } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + backupPlanAssociations: Resource$Projects$Locations$Backupplanassociations; + backupPlans: Resource$Projects$Locations$Backupplans; + backupVaults: Resource$Projects$Locations$Backupvaults; + managementServers: Resource$Projects$Locations$Managementservers; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.backupPlanAssociations = + new Resource$Projects$Locations$Backupplanassociations(this.context); + this.backupPlans = new Resource$Projects$Locations$Backupplans( + this.context + ); + this.backupVaults = new Resource$Projects$Locations$Backupvaults( + this.context + ); + this.managementServers = + new Resource$Projects$Locations$Managementservers(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Backupplanassociations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a BackupPlanAssociation + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Backupplanassociations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backupplanassociations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backupplanassociations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupplanassociations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupplanassociations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplanassociations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplanassociations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplanassociations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupPlanAssociations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single BackupPlanAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Backupplanassociations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backupplanassociations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupplanassociations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupplanassociations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupplanassociations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplanassociations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplanassociations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplanassociations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single BackupPlanAssociation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupplanassociations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupplanassociations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupplanassociations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupplanassociations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupplanassociations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplanassociations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplanassociations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplanassociations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists BackupPlanAssociations in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupplanassociations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupplanassociations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupplanassociations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplanassociations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplanassociations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplanassociations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplanassociations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplanassociations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupPlanAssociations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Triggers a new Backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + triggerBackup( + params: Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup, + options: StreamMethodOptions + ): GaxiosPromise; + triggerBackup( + params?: Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup, + options?: MethodOptions + ): GaxiosPromise; + triggerBackup( + params: Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + triggerBackup( + params: Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + triggerBackup( + params: Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup, + callback: BodyResponseCallback + ): void; + triggerBackup(callback: BodyResponseCallback): void; + triggerBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:triggerBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backupplanassociations$Create + extends StandardParameters { + /** + * Required. The name of the backup plan association to create. The name must be unique for the specified project and location. + */ + backupPlanAssociationId?: string; + /** + * Required. The backup plan association project and location in the format `projects/{project_id\}/locations/{location\}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupPlanAssociation; + } + export interface Params$Resource$Projects$Locations$Backupplanassociations$Delete + extends StandardParameters { + /** + * Required. Name of the backup plan association resource, in the format `projects/{project\}/locations/{location\}/backupPlanAssociations/{backupPlanAssociationId\}` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Backupplanassociations$Get + extends StandardParameters { + /** + * Required. Name of the backup plan association resource, in the format `projects/{project\}/locations/{location\}/backupPlanAssociations/{backupPlanAssociationId\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupplanassociations$List + extends StandardParameters { + /** + * Optional. Filtering results + */ + filter?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id\}/locations/{location\}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve backup plan associations for all locations, use "-" for the `{location\}` value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupplanassociations$Triggerbackup + extends StandardParameters { + /** + * Required. Name of the backup plan association resource, in the format `projects/{project\}/locations/{location\}/backupPlanAssociations/{backupPlanAssociationId\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TriggerBackupRequest; + } + + export class Resource$Projects$Locations$Backupplans { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a BackupPlan + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Backupplans$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backupplans$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backupplans$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupplans$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupplans$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupplans$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupPlans').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single BackupPlan. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Backupplans$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backupplans$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupplans$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupplans$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupplans$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupplans$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single BackupPlan. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupplans$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupplans$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupplans$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupplans$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupplans$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupplans$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists BackupPlans in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupplans$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupplans$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupplans$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplans$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupplans$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupplans$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupplans$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupplans$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupPlans').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backupplans$Create + extends StandardParameters { + /** + * Required. The name of the `BackupPlan` to create. The name must be unique for the specified project and location.The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, /a-z{,62\}/. + */ + backupPlanId?: string; + /** + * Required. The `BackupPlan` project and location in the format `projects/{project\}/locations/{location\}`. In Cloud BackupDR locations map to GCP regions, for example **us-central1**. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupPlan; + } + export interface Params$Resource$Projects$Locations$Backupplans$Delete + extends StandardParameters { + /** + * Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project\}/locations/{location\}/backupPlans/{backup_plan\}` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$Get + extends StandardParameters { + /** + * Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project\}/locations/{location\}/backupPlans/{backup_plan\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupplans$List + extends StandardParameters { + /** + * Optional. Field match expression used to filter the results. + */ + filter?: string; + /** + * Optional. Field by which to sort the results. + */ + orderBy?: string; + /** + * Optional. The maximum number of `BackupPlans` to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve `BackupPlans` information. Format: `projects/{project\}/locations/{location\}`. In Cloud BackupDR, locations map to GCP regions, for e.g. **us-central1**. To retrieve backup plans for all locations, use "-" for the `{location\}` value. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Backupvaults { + context: APIRequestContext; + dataSources: Resource$Projects$Locations$Backupvaults$Datasources; + constructor(context: APIRequestContext) { + this.context = context; + this.dataSources = + new Resource$Projects$Locations$Backupvaults$Datasources(this.context); + } + + /** + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Backupvaults$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Backupvaults$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupVaults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a BackupVault. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backupvaults$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options: StreamMethodOptions + ): GaxiosPromise; + fetchUsable( + params?: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options?: MethodOptions + ): GaxiosPromise; + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchUsable( + params: Params$Resource$Projects$Locations$Backupvaults$Fetchusable, + callback: BodyResponseCallback + ): void; + fetchUsable( + callback: BodyResponseCallback + ): void; + fetchUsable( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Fetchusable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Fetchusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Fetchusable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupVaults:fetchUsable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a BackupVault. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupvaults$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists BackupVaults in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupvaults$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupVaults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the settings of a BackupVault. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Backupvaults$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Backupvaults$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Backupvaults$Create + extends StandardParameters { + /** + * Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC + */ + backupVaultId?: string; + /** + * Required. Value for parent. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupVault; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Delete + extends StandardParameters { + /** + * Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken. + */ + allowMissing?: boolean; + /** + * The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. + */ + etag?: string; + /** + * Optional. If set to true, any data source from this backup vault will also be deleted. + */ + force?: boolean; + /** + * Required. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Fetchusable + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Get + extends StandardParameters { + /** + * Required. Name of the backupvault store resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}' + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Patch + extends StandardParameters { + /** + * Optional. If set to true, will not check plan duration against backup vault enforcement duration. + */ + force?: boolean; + /** + * Output only. Identifier. The resource name. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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 the request will fail. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is 'false'. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupVault; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Backupvaults$Datasources { + context: APIRequestContext; + backups: Resource$Projects$Locations$Backupvaults$Datasources$Backups; + constructor(context: APIRequestContext) { + this.context = context; + this.backups = + new Resource$Projects$Locations$Backupvaults$Datasources$Backups( + this.context + ); + } + + /** + * Internal only. Abandons a backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: StreamMethodOptions + ): GaxiosPromise; + abandonBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options?: MethodOptions + ): GaxiosPromise; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + abandonBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup, + callback: BodyResponseCallback + ): void; + abandonBackup(callback: BodyResponseCallback): void; + abandonBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:abandonBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Internal only. Fetch access token for a given data source. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options: StreamMethodOptions + ): GaxiosPromise; + fetchAccessToken( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options?: MethodOptions + ): GaxiosPromise; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken, + callback: BodyResponseCallback + ): void; + fetchAccessToken( + callback: BodyResponseCallback + ): void; + fetchAccessToken( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:fetchAccessToken').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Internal only. Finalize a backup that was started by a call to InitiateBackup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: StreamMethodOptions + ): GaxiosPromise; + finalizeBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options?: MethodOptions + ): GaxiosPromise; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + finalizeBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup, + callback: BodyResponseCallback + ): void; + finalizeBackup(callback: BodyResponseCallback): void; + finalizeBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:finalizeBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a DataSource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Internal only. Initiates a backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: StreamMethodOptions + ): GaxiosPromise; + initiateBackup( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options?: MethodOptions + ): GaxiosPromise; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initiateBackup( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup, + callback: BodyResponseCallback + ): void; + initiateBackup( + callback: BodyResponseCallback + ): void; + initiateBackup( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:initiateBackup').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists DataSources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dataSources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the settings of a DataSource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: StreamMethodOptions + ): GaxiosPromise; + remove( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options?: MethodOptions + ): GaxiosPromise; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + remove( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove, + callback: BodyResponseCallback + ): void; + remove(callback: BodyResponseCallback): void; + remove( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:remove').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); + /** + * Sets the internal status of a DataSource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options: StreamMethodOptions + ): GaxiosPromise; + setInternalStatus( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options?: MethodOptions + ): GaxiosPromise; + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInternalStatus( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus, + callback: BodyResponseCallback + ): void; + setInternalStatus(callback: BodyResponseCallback): void; + setInternalStatus( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataSource}:setInternalStatus').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataSource'], + pathParams: ['dataSource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } } - export class Resource$Projects$Locations { + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Abandonbackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AbandonBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Fetchaccesstoken + extends StandardParameters { + /** + * Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/x/locations/x/backupVaults/x/dataSources'. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FetchAccessTokenRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Finalizebackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FinalizeBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Get + extends StandardParameters { + /** + * Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{resource_name\}/dataSource/{resource_name\}' + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Initiatebackup + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InitiateBackupRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Patch + extends StandardParameters { + /** + * Optional. Enable upsert. + */ + allowMissing?: boolean; + /** + * Output only. Identifier. The resource name. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the DataSource 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 the request will fail. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DataSource; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Remove + extends StandardParameters { + /** + * Required. Name of the resource. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RemoveDataSourceRequest; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Setinternalstatus + extends StandardParameters { + /** + * Required. The resource name of the instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/'. + */ + dataSource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetInternalStatusRequest; + } + + export class Resource$Projects$Locations$Backupvaults$Datasources$Backups { context: APIRequestContext; - managementServers: Resource$Projects$Locations$Managementservers; - operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; - this.managementServers = - new Resource$Projects$Locations$Managementservers(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); } /** - * Gets information about a location. + * Deletes a Backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a Backup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -548,49 +5157,50 @@ export namespace backupdr_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Get, + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Get, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get; options = {}; } @@ -615,17 +5225,17 @@ export namespace backupdr_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Lists Backups in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -633,54 +5243,53 @@ export namespace backupdr_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$List, + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$List, + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List; options = {}; } @@ -693,7 +5302,7 @@ export namespace backupdr_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+parent}/backups').replace( /([^:]\/)\/+/g, '$1' ), @@ -703,46 +5312,268 @@ export namespace backupdr_v1 { options ), params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the settings of a Backup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, requiredParams: ['name'], pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); + } + } + + /** + * Restore from a Backup + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + restore( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Get + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Delete extends StandardParameters { /** - * Resource name for the location. + * Required. Name of the resource. */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$List + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Get extends StandardParameters { /** - * 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). + * Required. Name of the data source resource name, in the format 'projects/{project_id\}/locations/{location\}/backupVaults/{backupVault\}/dataSources/{datasource\}/backups/{backup\}' + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$List + extends StandardParameters { + /** + * Optional. Filtering results. */ filter?: string; /** - * The resource that owns the locations collection, if applicable. + * Optional. Hint for how to order the results. */ - name?: string; + orderBy?: string; /** - * The maximum number of results to return. If not set, the service selects a default. + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */ pageSize?: number; /** - * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + * Optional. A token identifying a page of results the server should return. */ pageToken?: string; + /** + * Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location\}' value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Patch + extends StandardParameters { + /** + * Output only. Identifier. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the Backup 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 the request will fail. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Backup; + } + export interface Params$Resource$Projects$Locations$Backupvaults$Datasources$Backups$Restore + extends StandardParameters { + /** + * Required. The resource name of the Backup instance, in the format 'projects/x/locations/x/backupVaults/x/dataSources/x/backups/'. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RestoreBackupRequest; } export class Resource$Projects$Locations$Managementservers { @@ -1391,7 +6222,7 @@ export namespace backupdr_v1 { */ managementServerId?: string; /** - * Required. The management server project and location in the format `projects/{project_id\}/locations/{location\}`. In Cloud Backup and DR locations map to GCP regions, for example **us-central1**. + * Required. The management server project and location in the format 'projects/{project_id\}/locations/{location\}'. In Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**. */ parent?: string; /** @@ -1418,7 +6249,7 @@ export namespace backupdr_v1 { export interface Params$Resource$Projects$Locations$Managementservers$Get extends StandardParameters { /** - * Required. Name of the management server resource name, in the format `projects/{project_id\}/locations/{location\}/managementServers/{resource_name\}` + * Required. Name of the management server resource name, in the format 'projects/{project_id\}/locations/{location\}/managementServers/{resource_name\}' */ name?: string; } @@ -1452,7 +6283,7 @@ export namespace backupdr_v1 { */ pageToken?: string; /** - * Required. The project and location for which to retrieve management servers information, in the format `projects/{project_id\}/locations/{location\}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the `{location\}` value. + * Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id\}/locations/{location\}'. In Cloud BackupDR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the '{location\}' value. */ parent?: string; } diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index c7aa5c2996..48be774c34 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -474,7 +474,7 @@ export namespace batch_v1 { newDisk?: Schema$Disk; } /** - * Barrier runnable blocks until all tasks in a taskgroup reach it. + * A barrier runnable automatically blocks the execution of subsequent runnables until all the tasks in the task group reach the barrier. */ export interface Schema$Barrier { /** @@ -521,7 +521,7 @@ export namespace batch_v1 { */ blockExternalNetwork?: boolean | null; /** - * Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. + * Required for some container images. Overrides the `CMD` specified in the container. If there is an `ENTRYPOINT` (either in the container image or with the `entrypoint` field below) then these commands are appended as arguments to the `ENTRYPOINT`. */ commands?: string[] | null; /** @@ -529,15 +529,15 @@ export namespace batch_v1 { */ enableImageStreaming?: boolean | null; /** - * Overrides the `ENTRYPOINT` specified in the container. + * Required for some container images. Overrides the `ENTRYPOINT` specified in the container. */ entrypoint?: string | null; /** - * The URI to pull the container image from. + * Required. The URI to pull the container image from. */ imageUri?: string | null; /** - * Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". + * Required for some container images. Arbitrary additional options to include in the `docker run` command when running this container—for example, `--network host`. For the `--volume` option, use the `volumes` field for the container. */ options?: string | null; /** @@ -549,7 +549,7 @@ export namespace batch_v1 { */ username?: string | null; /** - * Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro If the `TaskSpec.Volumes` field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (ro) for existing persistent disks and read-write (rw) for other volume types, regardless of the original mount options specified in `TaskSpec.Volumes`. If you need different mount settings, you can explicitly configure them in this field. + * Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match `--volume` option for the `docker run` command—for example, `/foo:/bar` or `/foo:/bar:ro`. If the `TaskSpec.Volumes` field is specified but this field is not, Batch will mount each volume from the host machine to the container with the same mount path by default. In this case, the default mount option for containers will be read-only (`ro`) for existing persistent disks and read-write (`rw`) for other volume types, regardless of the original mount options specified in `TaskSpec.Volumes`. If you need different mount settings, you can explicitly configure them in this field. */ volumes?: string[] | null; } @@ -562,7 +562,7 @@ export namespace batch_v1 { */ diskInterface?: string | null; /** - * URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project\}/global/images/family/{image_family\} * Specify the image version: projects/{project\}/global/images/{image_version\} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * `batch-debian`: use Batch Debian images. * `batch-centos`: use Batch CentOS images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-centos`: use Batch HPC CentOS images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images. + * URL for a VM image to use as the data source for this disk. For example, the following are all valid URLs: * Specify the image by its family name: projects/{project\}/global/images/family/{image_family\} * Specify the image version: projects/{project\}/global/images/{image_version\} You can also use Batch customized image in short names. The following image values are supported for a boot disk: * `batch-debian`: use Batch Debian images. * `batch-cos`: use Batch Container-Optimized images. * `batch-hpc-rocky`: use Batch HPC Rocky Linux images. */ image?: string | null; /** @@ -1071,7 +1071,7 @@ export namespace batch_v1 { */ alwaysRun?: boolean | null; /** - * This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide debugging support tools like SSH servers). + * Normally, a runnable that doesn't exit causes its task to fail. However, you can set this field to `true` to configure a background runnable. Background runnables are allowed continue running in the background while the task executes subsequent runnables. For example, background runnables are useful for providing services to other runnables or providing debugging-support tools like SSH servers. Specifically, background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as task failures. */ background?: boolean | null; /** @@ -1091,7 +1091,7 @@ export namespace batch_v1 { */ environment?: Schema$Environment; /** - * Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead. + * Normally, a runnable that returns a non-zero exit status fails and causes the task to fail. However, you can set this field to `true` to allow the task to continue executing its other runnables even if this runnable fails. */ ignoreExitStatus?: boolean | null; /** @@ -1112,11 +1112,11 @@ export namespace batch_v1 { */ export interface Schema$Script { /** - * Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be executed by `/bin/sh`. + * The path to a script file that is accessible from the host VM(s). Unless the script file supports the default `#!/bin/sh` shell interpreter, you must specify an interpreter by including a [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) as the first line of the file. For example, to execute the script using bash, include `#!/bin/bash` as the first line of the file. Alternatively, to execute the script using Python3, include `#!/usr/bin/env python3` as the first line of the file. */ path?: string | null; /** - * Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be executed by `/bin/sh`. + * The text for a script. Unless the script text supports the default `#!/bin/sh` shell interpreter, you must specify an interpreter by including a [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix) at the beginning of the text. For example, to execute the script using bash, include `#!/bin/bash\n` at the beginning of the text. Alternatively, to execute the script using Python3, include `#!/usr/bin/env python3\n` at the beginning of the text. */ text?: string | null; } @@ -1151,7 +1151,7 @@ export namespace batch_v1 { message?: string | null; } /** - * Status event + * Status event. */ export interface Schema$StatusEvent { /** @@ -1163,11 +1163,11 @@ export namespace batch_v1 { */ eventTime?: string | null; /** - * Task Execution + * Task Execution. This field is only defined for task-level status events where the task fails. */ taskExecution?: Schema$TaskExecution; /** - * Task State + * Task State. This field is only defined for task-level status events. */ taskState?: string | null; /** @@ -1284,7 +1284,7 @@ export namespace batch_v1 { */ maxRunDuration?: string | null; /** - * The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not treated as Task failures. + * Required. The sequence of one or more runnables (executable scripts, executable containers, and/or barriers) for each task in this task group to run. Each task runs this list of runnables in order. For a task to succeed, all of its script and container runnables each must meet at least one of the following conditions: + The runnable exited with a zero status. + The runnable didn't finish, but you enabled its `background` subfield. + The runnable exited with a non-zero status, but you enabled its `ignore_exit_status` subfield. */ runnables?: Schema$Runnable[]; /** @@ -1293,11 +1293,11 @@ export namespace batch_v1 { volumes?: Schema$Volume[]; } /** - * Status of a task + * Status of a task. */ export interface Schema$TaskStatus { /** - * Task state + * Task state. */ state?: string | null; /** diff --git a/src/apis/beyondcorp/v1.ts b/src/apis/beyondcorp/v1.ts index fc258ec7b2..a5544c4b2c 100644 --- a/src/apis/beyondcorp/v1.ts +++ b/src/apis/beyondcorp/v1.ts @@ -1259,6 +1259,15 @@ export namespace beyondcorp_v1 { */ unreachable?: string[] | null; } + /** + * Response message for calling ShouldThrottle + */ + export interface Schema$ShouldThrottleResponse { + /** + * Whether the port should be throttled + */ + shouldThrottle?: boolean | null; + } /** * TunnelerError is an error proto for errors returned by the connection manager. */ @@ -5674,6 +5683,102 @@ export namespace beyondcorp_v1 { } } + /** + * Calls the Bouncer method ShouldThrottle to check if a request should be throttled. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options: StreamMethodOptions + ): GaxiosPromise; + shouldThrottle( + params?: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options?: MethodOptions + ): GaxiosPromise; + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + callback: BodyResponseCallback + ): void; + shouldThrottle( + callback: BodyResponseCallback + ): void; + shouldThrottle( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Appgateways$Shouldthrottle + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:shouldThrottle').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @@ -5865,6 +5970,21 @@ export namespace beyondcorp_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Appgateways$Shouldthrottle + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. The port that is being throttled + */ + port?: number; + /** + * Optional. The current throughput through the port (mbps) + */ + requestedAmount?: string; + } export interface Params$Resource$Projects$Locations$Appgateways$Testiampermissions extends StandardParameters { /** diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 2ce1b15eea..4f4ad27080 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1620,6 +1620,133 @@ export namespace beyondcorp_v1alpha { */ type?: string | null; } + /** + * A Beyondcorp Application resource information. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication { + /** + * Required. Application filter conditions associated with an application. + */ + applicationMatchFilter?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter; + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. An arbitrary user-provided name for the Route resource. Cannot exceed 64 characters. + */ + displayName?: string | null; + /** + * Identifier. Name of the resource. + */ + name?: string | null; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * Match Criteria for Application Filtering. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilter { + /** + * Required. Match conditions for AND logic. An array of match conditions to allow for multiple matching criteria. The rule is considered a match if all the conditions are met. The conditions can be one of the following combination (FQDN), (FQDN & PORTS), (IP_ADDRESS), (IP_ADDRESS & PORTS) EXAMPLES: FQDN - ("*.abc.com"), ("xyz.abc.com") FQDN and PORTS - ("abc.com" and "22"), ("abc.com" and "22,33)" etc IP_ADDRESS - ("10.20.30.40"), ("100.20.30.40") IP_ADDRESS and PORTS - ("10.20.30.40" and "4"), ("10.20.30.40" and "4,5") + */ + matchConditions?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition[]; + } + /** + * Match condition for idenfying the application. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplicationMatchFilterMatchCondition { + /** + * Optional. FQDN of the application. + */ + fqdn?: string | null; + /** + * Optional. IP Address of the application. + */ + ipAddress?: string | null; + /** + * Optional. Ports of the application. + */ + ports?: number[] | null; + } + /** + * A Beyondcorp Hub resource information. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub { + /** + * Output only. Timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. An arbitrary user-provided name for the Hub. Cannot exceed 64 characters. + */ + displayName?: string | null; + /** + * Identifier. Name of the resource. + */ + name?: string | null; + /** + * Required. NAT gateway setup to ensure enough NAT IP addresses are available to handle the traffic needed to access the applications. Allows to explicitly enable or disable the NAT in the Hub along with the total IPs allocated to handle the capacity limits. + */ + natGatewayConfig?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig; + /** + * Output only. The operational state of the Hub. + */ + state?: string | null; + /** + * Output only. Timestamp when the resource was last modified. + */ + updateTime?: string | null; + } + /** + * Represents the NAT Gateway configuration. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHubNatGatewayConfig { + /** + * Optional. Explicitly enable or disable the NAT Gateway. This is defaulted to false until NAT Gateway configuration is fully supported and any request with a disable option will be rejected. + */ + enableNatGateway?: boolean | null; + /** + * Output only. List of NAT IPs that will be used for establishing connection to the endpoints. + */ + natIps?: string[] | null; + } + /** + * Message for response to listing Applications. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaListApplicationsResponse { + /** + * A list of BeyondCorp Application in the project. + */ + applications?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication[]; + /** + * A token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * A list of locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing Hubs. + */ + export interface Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaListHubsResponse { + /** + * A list of BeyondCorp Hub in the project. + */ + hubs?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub[]; + /** + * A token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * A list of locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Message for response to listing SecurityGateways. */ @@ -2075,6 +2202,15 @@ export namespace beyondcorp_v1alpha { */ email?: string | null; } + /** + * Response message for calling ShouldThrottle + */ + export interface Schema$ShouldThrottleResponse { + /** + * Whether the port should be throttled + */ + shouldThrottle?: boolean | null; + } /** * TunnelerError is an error proto for errors returned by the connection manager. */ @@ -5146,7 +5282,15 @@ export namespace beyondcorp_v1alpha { export interface Params$Resource$Organizations$Locations$Insights$List extends StandardParameters { /** - * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + * Optional. Aggregation type. The default is 'DAILY'. + */ + aggregation?: string; + /** + * Optional. Ending time for the duration for which insights are to be pulled. The default is the current time. + */ + endTime?: string; + /** + * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). */ filter?: string; /** @@ -5165,6 +5309,10 @@ export namespace beyondcorp_v1alpha { * Required. The resource name of InsightMetadata using the form: `organizations/{organization_id\}/locations/{location\}` `projects/{project_id\}/locations/{location_id\}` */ parent?: string; + /** + * Optional. Starting time for the duration for which insights are to be pulled. The default is 7 days before the current time. + */ + startTime?: string; /** * Required. List only metadata or full data. */ @@ -6274,6 +6422,7 @@ export namespace beyondcorp_v1alpha { clientGateways: Resource$Projects$Locations$Clientgateways; connections: Resource$Projects$Locations$Connections; connectors: Resource$Projects$Locations$Connectors; + global: Resource$Projects$Locations$Global; insights: Resource$Projects$Locations$Insights; netConnections: Resource$Projects$Locations$Netconnections; operations: Resource$Projects$Locations$Operations; @@ -6305,6 +6454,7 @@ export namespace beyondcorp_v1alpha { this.connectors = new Resource$Projects$Locations$Connectors( this.context ); + this.global = new Resource$Projects$Locations$Global(this.context); this.insights = new Resource$Projects$Locations$Insights(this.context); this.netConnections = new Resource$Projects$Locations$Netconnections( this.context @@ -9209,6 +9359,102 @@ export namespace beyondcorp_v1alpha { } } + /** + * Calls the Bouncer method ShouldThrottle to check if a request should be throttled. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options: StreamMethodOptions + ): GaxiosPromise; + shouldThrottle( + params?: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options?: MethodOptions + ): GaxiosPromise; + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + shouldThrottle( + params: Params$Resource$Projects$Locations$Appgateways$Shouldthrottle, + callback: BodyResponseCallback + ): void; + shouldThrottle( + callback: BodyResponseCallback + ): void; + shouldThrottle( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Appgateways$Shouldthrottle + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Appgateways$Shouldthrottle; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:shouldThrottle').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * @@ -9400,6 +9646,21 @@ export namespace beyondcorp_v1alpha { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Appgateways$Shouldthrottle + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. The port that is being throttled + */ + port?: number; + /** + * Optional. The current throughput through the port (mbps) + */ + requestedAmount?: string; + } export interface Params$Resource$Projects$Locations$Appgateways$Testiampermissions extends StandardParameters { /** @@ -12817,72 +13078,98 @@ export namespace beyondcorp_v1alpha { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Insights { + export class Resource$Projects$Locations$Global { + context: APIRequestContext; + securityGateways: Resource$Projects$Locations$Global$Securitygateways; + constructor(context: APIRequestContext) { + this.context = context; + this.securityGateways = + new Resource$Projects$Locations$Global$Securitygateways(this.context); + } + } + + export class Resource$Projects$Locations$Global$Securitygateways { + context: APIRequestContext; + applications: Resource$Projects$Locations$Global$Securitygateways$Applications; + hubs: Resource$Projects$Locations$Global$Securitygateways$Hubs; + constructor(context: APIRequestContext) { + this.context = context; + this.applications = + new Resource$Projects$Locations$Global$Securitygateways$Applications( + this.context + ); + this.hubs = new Resource$Projects$Locations$Global$Securitygateways$Hubs( + this.context + ); + } + } + + export class Resource$Projects$Locations$Global$Securitygateways$Applications { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the value for a selected particular insight based on the provided filters. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. + * Creates a new Application in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options: StreamMethodOptions ): GaxiosPromise; - configuredInsight( - params?: Params$Resource$Projects$Locations$Insights$Configuredinsight, + create( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options?: MethodOptions - ): GaxiosPromise; - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - configuredInsight( - params: Params$Resource$Projects$Locations$Insights$Configuredinsight, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create, + callback: BodyResponseCallback ): void; - configuredInsight( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - configuredInsight( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Insights$Configuredinsight - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Insights$Configuredinsight; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Insights$Configuredinsight; + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create; options = {}; } @@ -12895,91 +13182,90 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+insight}:configuredInsight').replace( + url: (rootUrl + '/v1alpha/{+parent}/applications').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['insight'], - pathParams: ['insight'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the value for a selected particular insight with default configuration. The default aggregation level is 'DAILY' and no grouping will be applied or default grouping if applicable. The data will be returned for recent 7 days starting the day before. The insight data size will be limited to 50 rows. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. Setting the `view` to `BASIC` will only return the metadata for the insight. + * Updates the parameters of a single Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Insights$Get, + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Insights$Get, + patch( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Insights$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Insights$Get, + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Insights$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Insights$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Insights$Get; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Insights$Get; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch; options = {}; } @@ -12993,7 +13279,7 @@ export namespace beyondcorp_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -13004,76 +13290,75 @@ export namespace beyondcorp_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists for all the available insights that could be fetched from the system. Allows to filter using category. Setting the `view` to `BASIC` will let you iterate over the list of insight metadatas. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Insights$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Insights$List, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Insights$List, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Insights$List, + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Insights$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - list( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Insights$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Insights$List; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Insights$List; + params = + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions; options = {}; } @@ -13086,179 +13371,152 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/insights').replace( + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Insights$Configuredinsight + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Create extends StandardParameters { /** - * Required. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view. - */ - aggregation?: string; - /** - * Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). - */ - 'customGrouping.fieldFilter'?: string; - /** - * Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here. - */ - 'customGrouping.groupFields'?: string[]; - /** - * Required. Ending time for the duration for which insight is to be pulled. - */ - endTime?: string; - /** - * Optional. Other filterable/configurable parameters as applicable to the selected insight. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). - */ - fieldFilter?: string; - /** - * Optional. Group id of the available groupings for the insight. Available groupings could be fetched by calling insight list and get APIs in `BASIC` view. - */ - group?: string; - /** - * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}`. + * Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. */ - insight?: string; + applicationId?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + * Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` */ - pageSize?: number; + parent?: string; /** - * Optional. Used to fetch the page represented by the token. Fetches the first page when not set. + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. */ - pageToken?: string; + requestId?: string; + /** - * Required. Starting time for the duration for which insight is to be pulled. + * Request body metadata */ - startTime?: string; + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication; } - export interface Params$Resource$Projects$Locations$Insights$Get + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Patch extends StandardParameters { /** - * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}` + * Identifier. Name of the resource. */ name?: string; /** - * Required. Metadata only or full data view. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Insights$List - extends StandardParameters { - /** - * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). - */ - filter?: string; - /** - * Optional. Hint for how to order the results. This is currently ignored. + * 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 timed 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). */ - orderBy?: string; + requestId?: string; /** - * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. + * Required. Mutable fields include: display_name. */ - pageSize?: number; + updateMask?: string; + /** - * Optional. A token identifying a page of results the server should return. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaApplication; + } + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Applications$Testiampermissions + extends StandardParameters { /** - * Required. The resource name of InsightMetadata using the form: `organizations/{organization_id\}/locations/{location\}` `projects/{project_id\}/locations/{location_id\}` + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - parent?: string; + resource?: string; + /** - * Required. List only metadata or full data. + * Request body metadata */ - view?: string; + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Netconnections { + export class Resource$Projects$Locations$Global$Securitygateways$Hubs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a new Hub in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Netconnections$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Netconnections$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Netconnections$Getiampolicy; + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create; options = {}; } @@ -13271,88 +13529,90 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1alpha/{+parent}/hubs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Updates the parameters of a single Hub. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - setIamPolicy( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Netconnections$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Netconnections$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Netconnections$Setiampolicy; + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch; options = {}; } @@ -13365,27 +13625,24 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -13398,27 +13655,27 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + params?: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + params: Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -13426,7 +13683,7 @@ export namespace beyondcorp_v1alpha { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Netconnections$Testiampermissions + | Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13442,13 +13699,13 @@ export namespace beyondcorp_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Netconnections$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Netconnections$Testiampermissions; + {} as Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions; options = {}; } @@ -13488,30 +13745,47 @@ export namespace beyondcorp_v1alpha { } } - export interface Params$Resource$Projects$Locations$Netconnections$Getiampolicy + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Create extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. User-settable Hub resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. */ - 'options.requestedPolicyVersion'?: number; + hubId?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. The resource name of the parent SecurityGateway using the form: `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` */ - resource?: string; + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub; } - export interface Params$Resource$Projects$Locations$Netconnections$Setiampolicy + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Patch extends StandardParameters { /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Identifier. Name of the resource. */ - resource?: string; + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mutable fields include: display_name. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaHub; } - export interface Params$Resource$Projects$Locations$Netconnections$Testiampermissions + export interface Params$Resource$Projects$Locations$Global$Securitygateways$Hubs$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -13524,64 +13798,72 @@ export namespace beyondcorp_v1alpha { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Insights { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Gets the value for a selected particular insight based on the provided filters. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + configuredInsight( + params?: Params$Resource$Projects$Locations$Insights$Configuredinsight, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + configuredInsight( + params: Params$Resource$Projects$Locations$Insights$Configuredinsight, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + configuredInsight( + callback: BodyResponseCallback + ): void; + configuredInsight( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Insights$Configuredinsight + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Insights$Configuredinsight; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = + {} as Params$Resource$Projects$Locations$Insights$Configuredinsight; options = {}; } @@ -13594,82 +13876,91 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + url: (rootUrl + '/v1alpha/{+insight}:configuredInsight').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['insight'], + pathParams: ['insight'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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`. + * Gets the value for a selected particular insight with default configuration. The default aggregation level is 'DAILY' and no grouping will be applied or default grouping if applicable. The data will be returned for recent 7 days starting the day before. The insight data size will be limited to 50 rows. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. Setting the `view` to `BASIC` will only return the metadata for the insight. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + get( + params: Params$Resource$Projects$Locations$Insights$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + get( + params?: Params$Resource$Projects$Locations$Insights$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Insights$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Insights$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Insights$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Insights$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Insights$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Insights$Get; options = {}; } @@ -13683,7 +13974,7 @@ export namespace beyondcorp_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -13694,74 +13985,76 @@ export namespace beyondcorp_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * 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. + * Lists for all the available insights that could be fetched from the system. Allows to filter using category. Setting the `view` to `BASIC` will let you iterate over the list of insight metadatas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Insights$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Insights$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Insights$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Insights$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Insights$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Insights$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Insights$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Insights$List; options = {}; } @@ -13774,10 +14067,1436 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, + url: (rootUrl + '/v1alpha/{+parent}/insights').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Insights$Configuredinsight + extends StandardParameters { + /** + * Required. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view. + */ + aggregation?: string; + /** + * Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). + */ + 'customGrouping.fieldFilter'?: string; + /** + * Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here. + */ + 'customGrouping.groupFields'?: string[]; + /** + * Required. Ending time for the duration for which insight is to be pulled. + */ + endTime?: string; + /** + * Optional. Other filterable/configurable parameters as applicable to the selected insight. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160). + */ + fieldFilter?: string; + /** + * Optional. Group id of the available groupings for the insight. Available groupings could be fetched by calling insight list and get APIs in `BASIC` view. + */ + group?: string; + /** + * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}`. + */ + insight?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. Used to fetch the page represented by the token. Fetches the first page when not set. + */ + pageToken?: string; + /** + * Required. Starting time for the duration for which insight is to be pulled. + */ + startTime?: string; + } + export interface Params$Resource$Projects$Locations$Insights$Get + extends StandardParameters { + /** + * Required. The resource name of the insight using the form: `organizations/{organization_id\}/locations/{location_id\}/insights/{insight_id\}` `projects/{project_id\}/locations/{location_id\}/insights/{insight_id\}` + */ + name?: string; + /** + * Required. Metadata only or full data view. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Insights$List + extends StandardParameters { + /** + * Optional. Aggregation type. The default is 'DAILY'. + */ + aggregation?: string; + /** + * Optional. Ending time for the duration for which insights are to be pulled. The default is the current time. + */ + endTime?: string; + /** + * Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + */ + filter?: string; + /** + * Optional. Hint for how to order the results. This is currently ignored. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The resource name of InsightMetadata using the form: `organizations/{organization_id\}/locations/{location\}` `projects/{project_id\}/locations/{location_id\}` + */ + parent?: string; + /** + * Optional. Starting time for the duration for which insights are to be pulled. The default is 7 days before the current time. + */ + startTime?: string; + /** + * Required. List only metadata or full data. + */ + view?: string; + } + + export class Resource$Projects$Locations$Netconnections { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Netconnections$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Netconnections$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Netconnections$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Netconnections$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Netconnections$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Netconnections$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Netconnections$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Netconnections$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Netconnections$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Netconnections$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Netconnections$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Netconnections$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Netconnections$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Netconnections$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Securitygateways { + context: APIRequestContext; + applications: Resource$Projects$Locations$Securitygateways$Applications; + hubs: Resource$Projects$Locations$Securitygateways$Hubs; + constructor(context: APIRequestContext) { + this.context = context; + this.applications = + new Resource$Projects$Locations$Securitygateways$Applications( + this.context + ); + this.hubs = new Resource$Projects$Locations$Securitygateways$Hubs( + this.context + ); + } + + /** + * Creates a new SecurityGateway in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Securitygateways$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Securitygateways$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Securitygateways$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Securitygateways$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Securitygateways$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists SecurityGateways in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Securitygateways$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Securitygateways$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Securitygateways$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single SecurityGateway. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Securitygateways$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Securitygateways$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, options ), params, @@ -13796,64 +15515,159 @@ export namespace beyondcorp_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Securitygateways$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - list( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; options = {}; } @@ -13866,183 +15680,162 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Securitygateways$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id\}/locations/{location_id\}` */ - name?: string; + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. + */ + requestId?: string; + /** + * Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. + */ + securityGatewayId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Securitygateways$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id\}/locations/{location_id\}/securityGateways/{security_gateway_id\}` + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Get + extends StandardParameters { + /** + * Required. The resource name of the PartnerTenant using the form: `projects/{project_id\}/locations/{location_id\}/securityGateway/{security_gateway_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Securitygateways$Getiampolicy extends StandardParameters { /** - * The name of the operation resource. + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$List + extends StandardParameters { + /** + * Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any. + */ + pageToken?: string; + /** + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/{location_id\}/` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Patch + extends StandardParameters { + /** + * Identifier. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mutable fields include: display_name, gateway_regions. + */ + updateMask?: string; + + /** + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Securitygateways$Setiampolicy extends StandardParameters { /** - * The standard list filter. + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - filter?: string; + resource?: string; + /** - * The name of the operation's parent resource. + * Request body metadata */ - name?: string; + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Testiampermissions + extends StandardParameters { /** - * The standard list page size. + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - pageSize?: number; + resource?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Securitygateways { + export class Resource$Projects$Locations$Securitygateways$Applications { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new SecurityGateway in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Securitygateways$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Securitygateways$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Securitygateways$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Securitygateways$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Securitygateways$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Securitygateways$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single SecurityGateway. + * Deletes a single Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14050,27 +15843,27 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Securitygateways$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Securitygateways$Delete, + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Securitygateways$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Securitygateways$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Securitygateways$Delete, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Delete, callback: BodyResponseCallback ): void; delete( @@ -14078,7 +15871,7 @@ export namespace beyondcorp_v1alpha { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Delete + | Params$Resource$Projects$Locations$Securitygateways$Applications$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14094,13 +15887,13 @@ export namespace beyondcorp_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Delete; + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Delete; + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Delete; options = {}; } @@ -14135,7 +15928,7 @@ export namespace beyondcorp_v1alpha { } /** - * Gets details of a single SecurityGateway. + * Gets details of a single Application. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14143,56 +15936,57 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Securitygateways$Get, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Securitygateways$Get, + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Securitygateways$Get, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Securitygateways$Get, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Securitygateways$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Securitygateways$Applications$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Applications$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Get; + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Securitygateways$Get; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$Get; options = {}; } @@ -14217,113 +16011,19 @@ export namespace beyondcorp_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Securitygateways$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://beyondcorp.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists SecurityGateways in a given project and location. + * Lists Applications in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14331,56 +16031,57 @@ export namespace beyondcorp_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Securitygateways$List, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Securitygateways$List, + params?: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Securitygateways$List, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Securitygateways$List, + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Securitygateways$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Securitygateways$Applications$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Applications$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$List; + {}) as Params$Resource$Projects$Locations$Securitygateways$Applications$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Securitygateways$List; + params = + {} as Params$Resource$Projects$Locations$Securitygateways$Applications$List; options = {}; } @@ -14393,7 +16094,7 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/securityGateways').replace( + url: (rootUrl + '/v1alpha/{+parent}/applications').replace( /([^:]\/)\/+/g, '$1' ), @@ -14408,55 +16109,108 @@ export namespace beyondcorp_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Delete + extends StandardParameters { /** - * Updates the parameters of a single SecurityGateway. + * Required. Name of the resource. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. If set, validates request by executing a dry-run which would not alter the resource in any way. + */ + validateOnly?: boolean; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$Get + extends StandardParameters { + /** + * Required. The resource name of the Application using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}/applications/{application_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Securitygateways$Applications$List + extends StandardParameters { + /** + * Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-application" For more information, please refer to https://google.aip.dev/160. + */ + filter?: string; + /** + * Optional. Specifies the ordering of results. See [Sorting order](https://cloud.google.com/apis/design/design_patterns#sorting_order) for more information. + */ + orderBy?: string; + /** + * Optional. The maximum number of items to return. If not specified, a default value of 50 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried. + */ + pageSize?: number; + /** + * Optional. The next_page_token value returned from a previous ListHubsRequest, if any. + */ + pageToken?: string; + /** + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Securitygateways$Hubs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a single Hub. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Securitygateways$Patch, + delete( + params?: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Securitygateways$Patch, + delete( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Patch + | Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14472,13 +16226,13 @@ export namespace beyondcorp_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Patch; + {}) as Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Patch; + {} as Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete; options = {}; } @@ -14492,7 +16246,7 @@ export namespace beyondcorp_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -14513,63 +16267,65 @@ export namespace beyondcorp_v1alpha { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets details of a single Hub. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Securitygateways$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$Get, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - setIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Hubs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Securitygateways$Hubs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Setiampolicy; + {} as Params$Resource$Projects$Locations$Securitygateways$Hubs$Get; options = {}; } @@ -14582,90 +16338,89 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists Hubs in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Securitygateways$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Securitygateways$Hubs$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Securitygateways$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Securitygateways$Hubs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Securitygateways$Hubs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Securitygateways$Testiampermissions; + {} as Params$Resource$Projects$Locations$Securitygateways$Hubs$List; options = {}; } @@ -14678,57 +16433,37 @@ export namespace beyondcorp_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1alpha/{+parent}/hubs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Securitygateways$Create - extends StandardParameters { - /** - * Required. The resource project name of the SecurityGateway location using the form: `projects/{project_id\}/locations/{location_id\}` - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. - */ - requestId?: string; - /** - * Optional. User-settable SecurityGateway resource ID. * Must start with a letter. * Must contain between 4-63 characters from `/a-z-/`. * Must end with a number or letter. - */ - securityGatewayId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Delete + export interface Params$Resource$Projects$Locations$Securitygateways$Hubs$Delete extends StandardParameters { /** - * Required. BeyondCorp SecurityGateway name using the form: `projects/{project_id\}/locations/{location_id\}/securityGateways/{security_gateway_id\}` + * Required. Name of the resource. */ name?: string; /** @@ -14740,28 +16475,17 @@ export namespace beyondcorp_v1alpha { */ validateOnly?: boolean; } - export interface Params$Resource$Projects$Locations$Securitygateways$Get + export interface Params$Resource$Projects$Locations$Securitygateways$Hubs$Get extends StandardParameters { /** - * Required. The resource name of the PartnerTenant using the form: `projects/{project_id\}/locations/{location_id\}/securityGateway/{security_gateway_id\}` + * Required. The resource name of the Hub using the form: `projects/{project_id\}/locations/global/securityGateway/{security_gateway_id\}/hubs/{hub_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Securitygateways$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Securitygateways$List + export interface Params$Resource$Projects$Locations$Securitygateways$Hubs$List extends StandardParameters { /** - * Optional. A filter specifying constraints of a list operation. All fields in the SecurityGateway message are supported. For example, the following query will return the SecurityGateway with displayName "test-security-gateway" For more information, please refer to https://google.aip.dev/160. + * Optional. A filter specifying constraints of a list operation. All fields in the Hub message are supported. For example, the following query will return the Hub with displayName "test-hub" For more information, please refer to https://google.aip.dev/160. */ filter?: string; /** @@ -14773,56 +16497,12 @@ export namespace beyondcorp_v1alpha { */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous ListSecurityGatewayRequest, if any. + * Optional. The next_page_token value returned from a previous ListHubsRequest, if any. */ pageToken?: string; /** - * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/{location_id\}/` + * Required. The parent location to which the resources belong. `projects/{project_id\}/locations/global/securityGateways/{security_gateway_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Securitygateways$Patch - extends StandardParameters { - /** - * Identifier. Name of the resource. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Required. Mutable fields include: display_name, gateway_regions. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudBeyondcorpSecuritygatewaysV1alphaSecurityGateway; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Securitygateways$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } } diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 064ac527fe..4b06acf98a 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -458,7 +458,7 @@ export namespace bigquery_v2 { */ export interface Schema$BigLakeConfiguration { /** - * Required. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form ".." or "projects//locations//connections/". + * Required. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project\}.{location\}.{connection_id\}` or `projects/{project\}/locations/{location\}/connections/{connection_id\}". */ connectionId?: string | null; /** @@ -466,7 +466,7 @@ export namespace bigquery_v2 { */ fileFormat?: string | null; /** - * Required. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format "gs://bucket/path_to_table/" + * Required. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` */ storageUri?: string | null; /** @@ -501,7 +501,7 @@ export namespace bigquery_v2 { */ onlyReadLatest?: boolean | null; /** - * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name. + * [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as field_name. */ qualifierEncoded?: string | null; /** @@ -518,7 +518,7 @@ export namespace bigquery_v2 { */ export interface Schema$BigtableColumnFamily { /** - * Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field. + * Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. */ columns?: Schema$BigtableColumn[]; /** @@ -864,9 +864,21 @@ export namespace bigquery_v2 { */ dataMaskingApplied?: boolean | null; } + /** + * Data policy option proto, it currently supports name only, will support precedence later. + */ + export interface Schema$DataPolicyOption { + /** + * Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id. + */ + name?: string | null; + } + /** + * Represents a BigQuery dataset. + */ export interface Schema$Dataset { /** - * Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + * Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. */ access?: Array<{ dataset?: Schema$DatasetAccessEntry; @@ -940,7 +952,7 @@ export namespace bigquery_v2 { */ kind?: string | null; /** - * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information. + * The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See [Creating and Updating Dataset Labels](https://cloud.google.com/bigquery/docs/creating-managing-labels#creating_and_updating_dataset_labels) for more information. */ labels?: {[key: string]: string} | null; /** @@ -988,7 +1000,7 @@ export namespace bigquery_v2 { */ storageBillingModel?: string | null; /** - * Output only. Tags for the Dataset. + * Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. */ tags?: Array<{tagKey?: string; tagValue?: string}> | null; /** @@ -1041,6 +1053,9 @@ export namespace bigquery_v2 { */ unreachable?: string[] | null; } + /** + * Identifier for a dataset. + */ export interface Schema$DatasetReference { /** * Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters. @@ -1187,6 +1202,9 @@ export namespace bigquery_v2 { */ min?: number | null; } + /** + * Configuration for Cloud KMS encryption settings. + */ export interface Schema$EncryptionConfiguration { /** * Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. @@ -1497,7 +1515,7 @@ export namespace bigquery_v2 { */ compression?: string | null; /** - * Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form ".." or "projects//locations//connections/". + * Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form `{project_id\}.{location_id\};{connection_id\}` or `projects/{project_id\}/locations/{location_id\}/connections/{connection_id\}`. */ connectionId?: string | null; /** @@ -2575,6 +2593,10 @@ export namespace bigquery_v2 { * Output only. Statistics for data-masking. Present only for query and extract jobs. */ dataMaskingStatistics?: Schema$DataMaskingStatistics; + /** + * Output only. Name of edition corresponding to the reservation for this job at the time of this update. + */ + edition?: string | null; /** * Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. */ @@ -4637,6 +4659,10 @@ export namespace bigquery_v2 { * Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior. */ collation?: string | null; + /** + * Optional. Data policy options, will replace the data_policies. + */ + dataPolicies?: Schema$DataPolicyOption[]; /** * Optional. A SQL expression to specify the [default value] (https://cloud.google.com/bigquery/docs/default-values) for this field. */ @@ -4737,6 +4763,10 @@ export namespace bigquery_v2 { * Free form human-readable reason metadata caching was unused for the job. */ explanation?: string | null; + /** + * Duration since last refresh as of this job for managed tables (indicates metadata cache staleness as seen by this job). + */ + staleness?: string | null; /** * Metadata caching eligible table referenced in the query. */ @@ -5987,7 +6017,7 @@ export namespace bigquery_v2 { */ all?: boolean; /** - * An expression for filtering the results of the request by label. The syntax is \"labels.[:]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See [Filtering datasets using labels](/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. + * An expression for filtering the results of the request by label. The syntax is `labels.[:]`. Multiple filters can be ANDed together by connecting with a space. Example: `labels.department:receiving labels.active`. See [Filtering datasets using labels](https://cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels) for details. */ filter?: string; /** @@ -6681,7 +6711,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -6709,7 +6739,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** @@ -6728,7 +6758,7 @@ export namespace bigquery_v2 { */ jobId?: string; /** - * The geographic location of the job. You must specify the location to run the job for the following scenarios: - If the location to run a job is not in the `us` or the `eu` multi-regional location - If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. + * The geographic location of the job. You must specify the location to run the job for the following scenarios: * If the location to run a job is not in the `us` or the `eu` multi-regional location * If the job's location is in a single region (for example, `us-central1`) For more information, see https://cloud.google.com/bigquery/docs/locations#specifying_your_location. */ location?: string; /** diff --git a/src/apis/bigqueryconnection/v1.ts b/src/apis/bigqueryconnection/v1.ts index b15adc0920..7ec3e491cb 100644 --- a/src/apis/bigqueryconnection/v1.ts +++ b/src/apis/bigqueryconnection/v1.ts @@ -343,7 +343,7 @@ export namespace bigqueryconnection_v1 { */ hasCredential?: boolean | null; /** - * Optional. The Cloud KMS key that is used for encryption. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` + * Optional. The Cloud KMS key that is used for credentials encryption. If omitted, internal Google owned encryption keys are used. Example: `projects/[kms_project_id]/locations/[region]/keyRings/[key_region]/cryptoKeys/[key]` */ kmsKeyName?: string | null; /** diff --git a/src/apis/bigquerydatapolicy/v1.ts b/src/apis/bigquerydatapolicy/v1.ts index 1431609d6f..70f8b789d4 100644 --- a/src/apis/bigquerydatapolicy/v1.ts +++ b/src/apis/bigquerydatapolicy/v1.ts @@ -1168,6 +1168,10 @@ export namespace bigquerydatapolicy_v1 { } export interface Params$Resource$Projects$Locations$Datapolicies$Delete extends StandardParameters { + /** + * Optional. If true, the data policy will be deleted even when it is referenced by one or more table columns. + */ + force?: boolean; /** * Required. Resource name of the data policy to delete. Format is `projects/{project_number\}/locations/{location_id\}/dataPolicies/{data_policy_id\}`. */ @@ -1213,6 +1217,10 @@ export namespace bigquerydatapolicy_v1 { } export interface Params$Resource$Projects$Locations$Datapolicies$Patch extends StandardParameters { + /** + * Optional. If set to true, and the data policy is not found, a new data policy will be created. In this situation, update_mask is ignored. + */ + allowMissing?: boolean; /** * Output only. Resource name of this data policy, in the format of `projects/{project_number\}/locations/{location_id\}/dataPolicies/{data_policy_id\}`. */ diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index b1bb51490b..073ee2ad70 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -2508,7 +2508,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Create extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. + * Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */ authorizationCode?: string; /** @@ -2520,7 +2520,7 @@ export namespace bigquerydatatransfer_v1 { */ serviceAccountName?: string; /** - * Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. + * Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */ versionInfo?: string; @@ -2565,7 +2565,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Locations$Transferconfigs$Patch extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. + * Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */ authorizationCode?: string; /** @@ -2581,7 +2581,7 @@ export namespace bigquerydatatransfer_v1 { */ updateMask?: string; /** - * Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. + * Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */ versionInfo?: string; @@ -3704,7 +3704,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Create extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. + * Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */ authorizationCode?: string; /** @@ -3716,7 +3716,7 @@ export namespace bigquerydatatransfer_v1 { */ serviceAccountName?: string; /** - * Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. + * Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to create the transfer config. */ versionInfo?: string; @@ -3761,7 +3761,7 @@ export namespace bigquerydatatransfer_v1 { export interface Params$Resource$Projects$Transferconfigs$Patch extends StandardParameters { /** - * Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. + * Deprecated: Authorization code was required when `transferConfig.dataSourceId` is 'youtube_channel' but it is no longer used in any data sources. Use `version_info` instead. Optional OAuth2 authorization code to use with this transfer configuration. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain authorization_code, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */ authorizationCode?: string; /** @@ -3777,7 +3777,7 @@ export namespace bigquerydatatransfer_v1 { */ updateMask?: string; /** - * Optional version info. This is required only if `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the a data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. + * Optional version info. This parameter replaces `authorization_code` which is no longer used in any data sources. This is required only if `transferConfig.dataSourceId` is 'youtube_channel' *or* new credentials are needed, as indicated by `CheckValidCreds`. In order to obtain version info, make a request to the following URL: https://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes * The client_id is the OAuth client_id of the data source as returned by ListDataSources method. * data_source_scopes are the scopes returned by ListDataSources method. Note that this should not be set when `service_account_name` is used to update the transfer config. */ versionInfo?: string; diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index 4b7329e44f..6db00743dd 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -253,6 +253,10 @@ export namespace bigtableadmin_v2 { * A backup of a Cloud Bigtable table. */ export interface Schema$Backup { + /** + * Indicates the backup type of the backup. + */ + backupType?: string | null; /** * Output only. The encryption information for the backup. */ @@ -262,9 +266,13 @@ export namespace bigtableadmin_v2 { */ endTime?: string | null; /** - * Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the new value must: - Be at most 90 days in the future - Be at least 6 hours in the future Once the `expire_time` has passed, Cloud Bigtable will delete the backup. + * Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup. */ expireTime?: string | null; + /** + * The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request. + */ + hotToStandardTime?: string | null; /** * A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project\}/instances/{instance\}/clusters/{cluster\}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project\}/instances/{instance\}/clusters/{cluster\}`. */ @@ -812,10 +820,22 @@ export namespace bigtableadmin_v2 { * A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . */ export interface Schema$GoogleBigtableAdminV2TypeAggregate { + /** + * HyperLogLogPlusPlusUniqueCount aggregator. + */ + hllppUniqueCount?: Schema$GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount; /** * Type of the inputs that are accumulated by this `Aggregate`, which must specify a full encoding. Use `AddInput` mutations to accumulate new inputs. */ inputType?: Schema$Type; + /** + * Max aggregator. + */ + max?: Schema$GoogleBigtableAdminV2TypeAggregateMax; + /** + * Min aggregator. + */ + min?: Schema$GoogleBigtableAdminV2TypeAggregateMin; /** * Output only. Type that holds the internal accumulator state for the `Aggregate`. This is a function of the `input_type` and `aggregator` chosen, and will always specify a full encoding. */ @@ -825,10 +845,35 @@ export namespace bigtableadmin_v2 { */ sum?: Schema$GoogleBigtableAdminV2TypeAggregateSum; } + /** + * Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateHyperLogLogPlusPlusUniqueCount {} + /** + * Computes the max of the input values. Allowed input: `Int64` State: same as input + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateMax {} + /** + * Computes the min of the input values. Allowed input: `Int64` State: same as input + */ + export interface Schema$GoogleBigtableAdminV2TypeAggregateMin {} /** * Computes the sum of the input values. Allowed input: `Int64` State: same as input */ export interface Schema$GoogleBigtableAdminV2TypeAggregateSum {} + /** + * An ordered list of elements of a given type. Values of type `Array` are stored in `Value.array_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeArray { + /** + * The type of the elements in the array. This must not be `Array`. + */ + elementType?: Schema$Type; + } + /** + * bool Values of type `Bool` are stored in `Value.bool_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeBool {} /** * Bytes Values of type `Bytes` are stored in `Value.bytes_value`. */ @@ -848,9 +893,21 @@ export namespace bigtableadmin_v2 { raw?: Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw; } /** - * Leaves the value "as-is" * Natural sort? Yes * Self-delimiting? No * Compatibility? N/A + * Leaves the value "as-is" * Order-preserving? Yes * Self-delimiting? No * Compatibility? N/A */ export interface Schema$GoogleBigtableAdminV2TypeBytesEncodingRaw {} + /** + * Date Values of type `Date` are stored in `Value.date_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeDate {} + /** + * Float32 Values of type `Float32` are stored in `Value.float_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeFloat32 {} + /** + * Float64 Values of type `Float64` are stored in `Value.float_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeFloat64 {} /** * Int64 Values of type `Int64` are stored in `Value.int_value`. */ @@ -870,14 +927,83 @@ export namespace bigtableadmin_v2 { bigEndianBytes?: Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes; } /** - * Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Natural sort? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` + * Encodes the value as an 8-byte big endian twos complement `Bytes` value. * Order-preserving? No (positive values only) * Self-delimiting? Yes * Compatibility? - BigQuery Federation `BINARY` encoding - HBase `Bytes.toBytes` - Java `ByteBuffer.putLong()` with `ByteOrder.BIG_ENDIAN` */ export interface Schema$GoogleBigtableAdminV2TypeInt64EncodingBigEndianBytes { /** - * The underlying `Bytes` type, which may be able to encode further. + * Deprecated: ignored if set. */ bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; } + /** + * A mapping of keys to values of a given type. Values of type `Map` are stored in a `Value.array_value` where each entry is another `Value.array_value` with two elements (the key and the value, in that order). Normally encoded Map values won't have repeated keys, however, clients are expected to handle the case in which they do. If the same key appears multiple times, the _last_ value takes precedence. + */ + export interface Schema$GoogleBigtableAdminV2TypeMap { + /** + * The type of a map key. Only `Bytes`, `String`, and `Int64` are allowed as key types. + */ + keyType?: Schema$Type; + /** + * The type of the values in a map. + */ + valueType?: Schema$Type; + } + /** + * String Values of type `String` are stored in `Value.string_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeString { + /** + * The encoding to use when converting to/from lower level types. + */ + encoding?: Schema$GoogleBigtableAdminV2TypeStringEncoding; + } + /** + * Rules used to convert to/from lower level types. + */ + export interface Schema$GoogleBigtableAdminV2TypeStringEncoding { + /** + * Use `Utf8Bytes` encoding. + */ + utf8Bytes?: Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes; + /** + * Deprecated: if set, converts to an empty `utf8_bytes`. + */ + utf8Raw?: Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Raw; + } + /** + * UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` + */ + export interface Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes {} + /** + * Deprecated: prefer the equivalent `Utf8Bytes`. + */ + export interface Schema$GoogleBigtableAdminV2TypeStringEncodingUtf8Raw {} + /** + * A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. + */ + export interface Schema$GoogleBigtableAdminV2TypeStruct { + /** + * The names and types of the fields in this struct. + */ + fields?: Schema$GoogleBigtableAdminV2TypeStructField[]; + } + /** + * A struct field and its type. + */ + export interface Schema$GoogleBigtableAdminV2TypeStructField { + /** + * The field name (optional). Fields without a `field_name` are considered anonymous and cannot be referenced by name. + */ + fieldName?: string | null; + /** + * The type of values in this field. + */ + type?: Schema$Type; + } + /** + * Timestamp Values of type `Timestamp` are stored in `Value.timestamp_value`. + */ + export interface Schema$GoogleBigtableAdminV2TypeTimestamp {} /** * A tablet is a defined by a start and end key and is explained in https://cloud.google.com/bigtable/docs/overview#architecture and https://cloud.google.com/bigtable/docs/performance#optimization. A Hot tablet is a tablet that exhibits high average cpu usage during the time interval from start time to end time. */ @@ -1485,21 +1611,57 @@ export namespace bigtableadmin_v2 { permissions?: string[] | null; } /** - * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. This might involve composing a series of steps into an "encoding chain," for example to convert from INT64 -\> STRING -\> raw bytes. In most cases, a "link" in the encoding chain will be based an on existing GoogleSQL conversion function like `CAST`. Each link in the encoding chain also defines the following properties: * Natural sort: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 to a fixed-width STRING does *not* preserve sort order when dealing with negative numbers. INT64(1) \> INT64(-1), but STRING("-00001") \> STRING("00001). - The overall encoding chain has this property if *every* link does. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. - The overall encoding chain has this property if *any* link does. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? + * `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) \> INT64(-1)`, but `STRING("-00001") \> STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? */ export interface Schema$Type { /** * Aggregate */ aggregateType?: Schema$GoogleBigtableAdminV2TypeAggregate; + /** + * Array + */ + arrayType?: Schema$GoogleBigtableAdminV2TypeArray; + /** + * Bool + */ + boolType?: Schema$GoogleBigtableAdminV2TypeBool; /** * Bytes */ bytesType?: Schema$GoogleBigtableAdminV2TypeBytes; + /** + * Date + */ + dateType?: Schema$GoogleBigtableAdminV2TypeDate; + /** + * Float32 + */ + float32Type?: Schema$GoogleBigtableAdminV2TypeFloat32; + /** + * Float64 + */ + float64Type?: Schema$GoogleBigtableAdminV2TypeFloat64; /** * Int64 */ int64Type?: Schema$GoogleBigtableAdminV2TypeInt64; + /** + * Map + */ + mapType?: Schema$GoogleBigtableAdminV2TypeMap; + /** + * String + */ + stringType?: Schema$GoogleBigtableAdminV2TypeString; + /** + * Struct + */ + structType?: Schema$GoogleBigtableAdminV2TypeStruct; + /** + * Timestamp + */ + timestampType?: Schema$GoogleBigtableAdminV2TypeTimestamp; } /** * Metadata type for the operation returned by google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable. @@ -4740,7 +4902,7 @@ export namespace bigtableadmin_v2 { export interface Params$Resource$Projects$Instances$Clusters$Backups$Copy extends StandardParameters { /** - * Required. The name of the destination cluster that will contain the backup copy. The cluster must already exists. Values are of the form: `projects/{project\}/instances/{instance\}/clusters/{cluster\}`. + * Required. The name of the destination cluster that will contain the backup copy. The cluster must already exist. Values are of the form: `projects/{project\}/instances/{instance\}/clusters/{cluster\}`. */ parent?: string; diff --git a/src/apis/calendar/v3.ts b/src/apis/calendar/v3.ts index 241d5a583c..7abcc4f2c1 100644 --- a/src/apis/calendar/v3.ts +++ b/src/apis/calendar/v3.ts @@ -760,7 +760,7 @@ export namespace calendar_v3 { */ recurringEventId?: string | null; /** - * Information about the event's reminders for the authenticated user. + * Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. */ reminders?: { overrides?: Schema$EventReminder[]; @@ -802,7 +802,7 @@ export namespace calendar_v3 { */ transparency?: string | null; /** - * Last modification time of the event (as a RFC3339 timestamp). Read-only. + * Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. */ updated?: string | null; /** diff --git a/src/apis/certificatemanager/v1.ts b/src/apis/certificatemanager/v1.ts index d78ac425f3..20aef517b2 100644 --- a/src/apis/certificatemanager/v1.ts +++ b/src/apis/certificatemanager/v1.ts @@ -142,7 +142,7 @@ export namespace certificatemanager_v1 { */ details?: string | null; /** - * Domain name of the authorization attempt. + * Output only. Domain name of the authorization attempt. */ domain?: string | null; /** @@ -167,7 +167,7 @@ export namespace certificatemanager_v1 { */ createTime?: string | null; /** - * One or more paragraphs of text description of a certificate. + * Optional. One or more paragraphs of text description of a certificate. */ description?: string | null; /** @@ -175,7 +175,7 @@ export namespace certificatemanager_v1 { */ expireTime?: string | null; /** - * Set of labels associated with a Certificate. + * Optional. Set of labels associated with a Certificate. */ labels?: {[key: string]: string} | null; /** @@ -183,7 +183,7 @@ export namespace certificatemanager_v1 { */ managed?: Schema$ManagedCertificate; /** - * A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/x/locations/x/certificates/x`. + * Identifier. A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/x/locations/x/certificates/x`. */ name?: string | null; /** @@ -195,7 +195,7 @@ export namespace certificatemanager_v1 { */ sanDnsnames?: string[] | null; /** - * Immutable. The scope of the certificate. + * Optional. Immutable. The scope of the certificate. */ scope?: string | null; /** @@ -238,7 +238,7 @@ export namespace certificatemanager_v1 { */ createTime?: string | null; /** - * One or more paragraphs of text description of a CertificateIssuanceConfig. + * Optional. One or more paragraphs of text description of a CertificateIssuanceConfig. */ description?: string | null; /** @@ -246,7 +246,7 @@ export namespace certificatemanager_v1 { */ keyAlgorithm?: string | null; /** - * Set of labels associated with a CertificateIssuanceConfig. + * Optional. Set of labels associated with a CertificateIssuanceConfig. */ labels?: {[key: string]: string} | null; /** @@ -254,7 +254,7 @@ export namespace certificatemanager_v1 { */ lifetime?: string | null; /** - * A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/x/locations/x/certificateIssuanceConfigs/x`. + * Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/x/locations/x/certificateIssuanceConfigs/x`. */ name?: string | null; /** @@ -275,7 +275,7 @@ export namespace certificatemanager_v1 { */ createTime?: string | null; /** - * One or more paragraphs of text description of a certificate map. + * Optional. One or more paragraphs of text description of a certificate map. */ description?: string | null; /** @@ -283,11 +283,11 @@ export namespace certificatemanager_v1 { */ gclbTargets?: Schema$GclbTarget[]; /** - * Set of labels associated with a Certificate Map. + * Optional. Set of labels associated with a Certificate Map. */ labels?: {[key: string]: string} | null; /** - * A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x`. + * Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x`. */ name?: string | null; /** @@ -300,7 +300,7 @@ export namespace certificatemanager_v1 { */ export interface Schema$CertificateMapEntry { /** - * A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/x/locations/x/certificates/x`. + * Optional. A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/x/locations/x/certificates/x`. */ certificates?: string[] | null; /** @@ -308,7 +308,7 @@ export namespace certificatemanager_v1 { */ createTime?: string | null; /** - * One or more paragraphs of text description of a certificate map entry. + * Optional. One or more paragraphs of text description of a certificate map entry. */ description?: string | null; /** @@ -316,7 +316,7 @@ export namespace certificatemanager_v1 { */ hostname?: string | null; /** - * Set of labels associated with a Certificate Map Entry. + * Optional. Set of labels associated with a Certificate Map Entry. */ labels?: {[key: string]: string} | null; /** @@ -324,7 +324,7 @@ export namespace certificatemanager_v1 { */ matcher?: string | null; /** - * A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x/certificateMapEntries/x`. + * Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x/certificateMapEntries/x`. */ name?: string | null; /** @@ -345,7 +345,7 @@ export namespace certificatemanager_v1 { */ createTime?: string | null; /** - * One or more paragraphs of text description of a DnsAuthorization. + * Optional. One or more paragraphs of text description of a DnsAuthorization. */ description?: string | null; /** @@ -357,15 +357,15 @@ export namespace certificatemanager_v1 { */ domain?: string | null; /** - * Set of labels associated with a DnsAuthorization. + * Optional. Set of labels associated with a DnsAuthorization. */ labels?: {[key: string]: string} | null; /** - * A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/x/locations/x/dnsAuthorizations/x`. + * Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/x/locations/x/dnsAuthorizations/x`. */ name?: string | null; /** - * Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + * Optional. Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. */ type?: string | null; /** @@ -595,15 +595,15 @@ export namespace certificatemanager_v1 { */ authorizationAttemptInfo?: Schema$AuthorizationAttemptInfo[]; /** - * Immutable. Authorizations that will be used for performing domain authorization. + * Optional. Immutable. Authorizations that will be used for performing domain authorization. */ dnsAuthorizations?: string[] | null; /** - * Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution. + * Optional. Immutable. The domains for which a managed SSL certificate will be generated. Wildcard domains are only supported with DNS challenge resolution. */ domains?: string[] | null; /** - * Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/x/locations/x/certificateIssuanceConfigs/x`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. + * Optional. Immutable. The resource name for a CertificateIssuanceConfig used to configure private PKI certificates in the format `projects/x/locations/x/certificateIssuanceConfigs/x`. If this field is not set, the certificates will instead be publicly signed as documented at https://cloud.google.com/load-balancing/docs/ssl-certificates/google-managed-certs#caa. */ issuanceConfig?: string | null; /** @@ -691,11 +691,11 @@ export namespace certificatemanager_v1 { */ export interface Schema$SelfManagedCertificate { /** - * Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. + * Optional. Input only. The PEM-encoded certificate chain. Leaf certificate comes first, followed by intermediate ones if any. */ pemCertificate?: string | null; /** - * Input only. The PEM-encoded private key of the leaf certificate. + * Optional. Input only. The PEM-encoded private key of the leaf certificate. */ pemPrivateKey?: string | null; } @@ -738,7 +738,7 @@ export namespace certificatemanager_v1 { */ createTime?: string | null; /** - * One or more paragraphs of text description of a TrustConfig. + * Optional. One or more paragraphs of text description of a TrustConfig. */ description?: string | null; /** @@ -746,15 +746,15 @@ export namespace certificatemanager_v1 { */ etag?: string | null; /** - * Set of labels associated with a TrustConfig. + * Optional. Set of labels associated with a TrustConfig. */ labels?: {[key: string]: string} | null; /** - * A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/x/locations/x/trustConfigs/x`. + * Identifier. A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/x/locations/x/trustConfigs/x`. */ name?: string | null; /** - * Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. + * Optional. Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. */ trustStores?: Schema$TrustStore[]; /** @@ -767,11 +767,11 @@ export namespace certificatemanager_v1 { */ export interface Schema$TrustStore { /** - * Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature. + * Optional. Set of intermediate CA certificates used for the path building phase of chain validation. The field is currently not supported if TrustConfig is used for the workload certificate feature. */ intermediateCas?: Schema$IntermediateCA[]; /** - * List of Trust Anchors to be used while performing validation against a given TrustStore. + * Optional. List of Trust Anchors to be used while performing validation against a given TrustStore. */ trustAnchors?: Schema$TrustAnchor[]; } @@ -1396,6 +1396,93 @@ export namespace certificatemanager_v1 { ); } } + + /** + * Updates a CertificateIssuanceConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://certificatemanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Certificateissuanceconfigs$Create @@ -1431,19 +1518,19 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificateissuanceconfigs$List extends StandardParameters { /** - * Filter expression to restrict the Certificates Configs returned. + * Optional. Filter expression to restrict the Certificates Configs returned. */ filter?: string; /** - * A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. + * Optional. A list of Certificate Config field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. */ orderBy?: string; /** - * Maximum number of certificate configs to return per call. + * Optional. Maximum number of certificate configs to return per call. */ pageSize?: number; /** - * The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data. + * Optional. The value returned by the last `ListCertificateIssuanceConfigsResponse`. Indicates that this is a continuation of a prior `ListCertificateIssuanceConfigs` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -1451,6 +1538,22 @@ export namespace certificatemanager_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Certificateissuanceconfigs$Patch + extends StandardParameters { + /** + * Identifier. A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/x/locations/x/certificateIssuanceConfigs/x`. + */ + name?: string; + /** + * Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CertificateIssuanceConfig; + } export class Resource$Projects$Locations$Certificatemaps { context: APIRequestContext; @@ -1942,19 +2045,19 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificatemaps$List extends StandardParameters { /** - * Filter expression to restrict the Certificates Maps returned. + * Optional. Filter expression to restrict the Certificates Maps returned. */ filter?: string; /** - * A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. + * Optional. A list of Certificate Map field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. */ orderBy?: string; /** - * Maximum number of certificate maps to return per call. + * Optional. Maximum number of certificate maps to return per call. */ pageSize?: number; /** - * The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data. + * Optional. The value returned by the last `ListCertificateMapsResponse`. Indicates that this is a continuation of a prior `ListCertificateMaps` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -1965,7 +2068,7 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificatemaps$Patch extends StandardParameters { /** - * A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x`. + * Identifier. A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x`. */ name?: string; /** @@ -2472,19 +2575,19 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificatemaps$Certificatemapentries$List extends StandardParameters { /** - * Filter expression to restrict the returned Certificate Map Entries. + * Optional. Filter expression to restrict the returned Certificate Map Entries. */ filter?: string; /** - * A list of Certificate Map Entry field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. + * Optional. A list of Certificate Map Entry field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. */ orderBy?: string; /** - * Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of certificate map entries to return. The service may return fewer than this value. If unspecified, at most 50 certificate map entries will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * The value returned by the last `ListCertificateMapEntriesResponse`. Indicates that this is a continuation of a prior `ListCertificateMapEntries` call, and that the system should return the next page of data. + * Optional. The value returned by the last `ListCertificateMapEntriesResponse`. Indicates that this is a continuation of a prior `ListCertificateMapEntries` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -2495,7 +2598,7 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificatemaps$Certificatemapentries$Patch extends StandardParameters { /** - * A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x/certificateMapEntries/x`. + * Identifier. A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/x/locations/x/certificateMaps/x/certificateMapEntries/x`. */ name?: string; /** @@ -2990,19 +3093,19 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificates$List extends StandardParameters { /** - * Filter expression to restrict the Certificates returned. + * Optional. Filter expression to restrict the Certificates returned. */ filter?: string; /** - * A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. + * Optional. A list of Certificate field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. */ orderBy?: string; /** - * Maximum number of certificates to return per call. + * Optional. Maximum number of certificates to return per call. */ pageSize?: number; /** - * The value returned by the last `ListCertificatesResponse`. Indicates that this is a continuation of a prior `ListCertificates` call, and that the system should return the next page of data. + * Optional. The value returned by the last `ListCertificatesResponse`. Indicates that this is a continuation of a prior `ListCertificates` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -3013,7 +3116,7 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Certificates$Patch extends StandardParameters { /** - * A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/x/locations/x/certificates/x`. + * Identifier. A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/x/locations/x/certificates/x`. */ name?: string; /** @@ -3516,19 +3619,19 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Dnsauthorizations$List extends StandardParameters { /** - * Filter expression to restrict the Dns Authorizations returned. + * Optional. Filter expression to restrict the Dns Authorizations returned. */ filter?: string; /** - * A list of Dns Authorization field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. + * Optional. A list of Dns Authorization field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. */ orderBy?: string; /** - * Maximum number of dns authorizations to return per call. + * Optional. Maximum number of dns authorizations to return per call. */ pageSize?: number; /** - * The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that this is a continuation of a prior `ListDnsAuthorizations` call, and that the system should return the next page of data. + * Optional. The value returned by the last `ListDnsAuthorizationsResponse`. Indicates that this is a continuation of a prior `ListDnsAuthorizations` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -3539,7 +3642,7 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Dnsauthorizations$Patch extends StandardParameters { /** - * A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/x/locations/x/dnsAuthorizations/x`. + * Identifier. A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/x/locations/x/dnsAuthorizations/x`. */ name?: string; /** @@ -4425,7 +4528,7 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Trustconfigs$Delete extends StandardParameters { /** - * The current etag of the TrustConfig. If an etag is provided and does not match the current etag of the resource, deletion will be blocked and an ABORTED error will be returned. + * Optional. The current etag of the TrustConfig. If an etag is provided and does not match the current etag of the resource, deletion will be blocked and an ABORTED error will be returned. */ etag?: string; /** @@ -4443,19 +4546,19 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Trustconfigs$List extends StandardParameters { /** - * Filter expression to restrict the TrustConfigs returned. + * Optional. Filter expression to restrict the TrustConfigs returned. */ filter?: string; /** - * A list of TrustConfig field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. + * Optional. A list of TrustConfig field names used to specify the order of the returned results. The default sorting order is ascending. To specify descending order for a field, add a suffix `" desc"`. */ orderBy?: string; /** - * Maximum number of TrustConfigs to return per call. + * Optional. Maximum number of TrustConfigs to return per call. */ pageSize?: number; /** - * The value returned by the last `ListTrustConfigsResponse`. Indicates that this is a continuation of a prior `ListTrustConfigs` call, and that the system should return the next page of data. + * Optional. The value returned by the last `ListTrustConfigsResponse`. Indicates that this is a continuation of a prior `ListTrustConfigs` call, and that the system should return the next page of data. */ pageToken?: string; /** @@ -4466,7 +4569,7 @@ export namespace certificatemanager_v1 { export interface Params$Resource$Projects$Locations$Trustconfigs$Patch extends StandardParameters { /** - * A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/x/locations/x/trustConfigs/x`. + * Identifier. A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/x/locations/x/trustConfigs/x`. */ name?: string; /** diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 7f6100df47..f60ae0f5d9 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -146,7 +146,7 @@ export namespace chat_v1 { */ accessState?: string | null; /** - * Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience\}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + * Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience\}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. */ audience?: string | null; } @@ -501,7 +501,7 @@ export namespace chat_v1 { deletionType?: string | null; } /** - * A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). + * A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview). */ export interface Schema$DeprecatedEvent { /** @@ -509,11 +509,11 @@ export namespace chat_v1 { */ action?: Schema$FormAction; /** - * Represents informatmessage_visibilityion about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card. + * Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card. */ common?: Schema$CommonEventObject; /** - * The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools). + * For `MESSAGE` interaction events, the URL that users must be redirected to after they complete an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services and tools](https://developers.google.com/workspace/chat/connect-web-services-tools). */ configCompleteRedirectUrl?: string | null; /** @@ -529,11 +529,11 @@ export namespace chat_v1 { */ isDialogEvent?: boolean | null; /** - * The message that triggered the interaction event, if applicable. + * For `ADDED_TO_SPACE`, `CARD_CLICKED`, and `MESSAGE` interaction events, the message that triggered the interaction event, if applicable. */ message?: Schema$Message; /** - * The space in which the interaction event occurred. + * The space in which the user interacted with the Chat app. */ space?: Schema$Space; /** @@ -545,11 +545,11 @@ export namespace chat_v1 { */ token?: string | null; /** - * The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). + * The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`. */ type?: string | null; /** - * The user that triggered the interaction event. + * The user that interacted with the Chat app. */ user?: Schema$User; } @@ -843,7 +843,7 @@ export namespace chat_v1 { widgets?: Schema$GoogleAppsCardV1Widgets[]; } /** - * The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): Columns for Google Workspace Add-ons are in Developer Preview. + * The `Columns` widget displays up to 2 columns in a card or dialog. You can add widgets to each column; the widgets appear in the order that they are specified. For an example in Google Chat apps, see [Display cards and dialogs in columns](https://developers.google.com/workspace/chat/format-structure-card-dialog#display_cards_and_dialogs_in_columns). The height of each column is determined by the taller column. For example, if the first column is taller than the second column, both columns have the height of the first column. Because each column can contain a different number of widgets, you can't define rows or align widgets between the columns. Columns are displayed side-by-side. You can customize the width of each column using the `HorizontalSizeStyle` field. If the user's screen width is too narrow, the second column wraps below the first: * On web, the second column wraps if the screen width is less than or equal to 480 pixels. * On iOS devices, the second column wraps if the screen width is less than or equal to 300 pt. * On Android devices, the second column wraps if the screen width is less than or equal to 320 dp. To include more than 2 columns, or to use rows, use the `Grid` widget. [Google Workspace Add-ons and Chat apps](https://developers.google.com/workspace/extend): */ export interface Schema$GoogleAppsCardV1Columns { /** @@ -1173,7 +1173,7 @@ export namespace chat_v1 { */ multiSelectMinQueryLength?: number | null; /** - * The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). + * Required. The name that identifies the selection input in a form input event. For details about working with form inputs, see [Receive form data](https://developers.google.com/workspace/chat/read-form-data). */ name?: string | null; /** @@ -2035,7 +2035,7 @@ export namespace chat_v1 { */ displayName?: string | null; /** - * Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + * Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. */ externalUserAllowed?: boolean | null; /** @@ -2271,7 +2271,7 @@ export namespace chat_v1 { */ export interface Schema$Thread { /** - * Output only. Resource name of the thread. Example: `spaces/{space\}/threads/{thread\}` + * Resource name of the thread. Example: `spaces/{space\}/threads/{thread\}` */ name?: string | null; /** @@ -3399,7 +3399,7 @@ export namespace chat_v1 { */ name?: string; /** - * Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. + * Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. */ updateMask?: string; diff --git a/src/apis/chromemanagement/v1.ts b/src/apis/chromemanagement/v1.ts index 393699e8b3..ee67fb5953 100644 --- a/src/apis/chromemanagement/v1.ts +++ b/src/apis/chromemanagement/v1.ts @@ -4122,11 +4122,11 @@ export namespace chromemanagement_v1 { */ customer?: string; /** - * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id + * Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions */ filter?: string; /** - * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id + * Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions */ orderBy?: string; /** @@ -4634,7 +4634,7 @@ export namespace chromemanagement_v1 { */ parent?: string; /** - * Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event + * Required. Read mask to specify which fields to return. Although currently required, this field will become optional, while the filter parameter with an event type will be come required. Supported read_mask paths are: - device - user - audio_severe_underrun_event - usb_peripherals_event - https_latency_change_event - network_state_change_event - wifi_signal_strength_event - vpn_connection_state_change_event - app_install_event - app_uninstall_event - app_launch_event - os_crash_event */ readMask?: string; } diff --git a/src/apis/chromepolicy/v1.ts b/src/apis/chromepolicy/v1.ts index 1470365f36..98bf505229 100644 --- a/src/apis/chromepolicy/v1.ts +++ b/src/apis/chromepolicy/v1.ts @@ -431,7 +431,7 @@ export namespace chromepolicy_v1 { */ policyApiLifecycleStage?: string | null; /** - * Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy. This field should not be manually set but will be set and exposed through PolicyAPI automatically. + * Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy. */ scheduledToDeprecatePolicies?: string[] | null; } diff --git a/src/apis/classroom/v1.ts b/src/apis/classroom/v1.ts index 599569f9a4..46dbd8b07b 100644 --- a/src/apis/classroom/v1.ts +++ b/src/apis/classroom/v1.ts @@ -3080,7 +3080,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -4277,7 +4277,7 @@ export namespace classroom_v1 { } /** - * Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course, course work, or student submission does not exist. + * Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4406,7 +4406,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -4472,7 +4472,7 @@ export namespace classroom_v1 { */ id?: string; /** - * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` + * Mask that identifies which fields on the course work to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the `CourseWork` object. If a field that does not support empty values is included in the update mask and not set in the `CourseWork` object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `due_date` * `due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * `topic_id` * `grading_period_id` Available in [V1_20240401_PREVIEW](https://developers.google.com/classroom/reference/preview) and later. */ updateMask?: string; @@ -6713,7 +6713,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** @@ -7461,7 +7461,7 @@ export namespace classroom_v1 { */ addOnToken?: string; /** - * Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + * Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). */ attachmentId?: string; /** diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index a099d5e498..c737ea07c5 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -1372,7 +1372,7 @@ export namespace cloudasset_v1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressFrom { /** - * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -1432,7 +1432,7 @@ export namespace cloudasset_v1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1IngressFrom { /** - * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -2123,7 +2123,7 @@ export namespace cloudasset_v1 { */ export interface Schema$QueryAssetsResponse { /** - * The query response, which can be either an `error` or a valid `response`. If `done` == `false` and the query result is being saved in a output, the output_config field will be set. If `done` == `true`, exactly one of `error`, `query_result` or `output_config` will be set. + * The query response, which can be either an `error` or a valid `response`. If `done` == `false` and the query result is being saved in an output, the output_config field will be set. If `done` == `true`, exactly one of `error`, `query_result` or `output_config` will be set. [done] is unset unless the [QueryAssetsResponse] contains a [QueryAssetsResponse.job_reference]. */ done?: boolean | null; /** @@ -2135,7 +2135,7 @@ export namespace cloudasset_v1 { */ jobReference?: string | null; /** - * Output configuration which indicates instead of being returned in API response on the fly, the query result will be saved in a specific output. + * Output configuration, which indicates that instead of being returned in an API response on the fly, the query result will be saved in a specific output. */ outputConfig?: Schema$QueryAssetsOutputConfig; /** diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index bcd126f93a..474ba58a01 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -641,7 +641,7 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressFrom { /** - * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -701,7 +701,7 @@ export namespace cloudasset_v1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1IngressFrom { /** - * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** diff --git a/src/apis/cloudasset/v1p1beta1.ts b/src/apis/cloudasset/v1p1beta1.ts index 543c72f327..e9b33ec1e5 100644 --- a/src/apis/cloudasset/v1p1beta1.ts +++ b/src/apis/cloudasset/v1p1beta1.ts @@ -568,7 +568,7 @@ export namespace cloudasset_v1p1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressFrom { /** - * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -628,7 +628,7 @@ export namespace cloudasset_v1p1beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1IngressFrom { /** - * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** diff --git a/src/apis/cloudasset/v1p5beta1.ts b/src/apis/cloudasset/v1p5beta1.ts index c27d43edb3..a906ed9138 100644 --- a/src/apis/cloudasset/v1p5beta1.ts +++ b/src/apis/cloudasset/v1p5beta1.ts @@ -598,7 +598,7 @@ export namespace cloudasset_v1p5beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressFrom { /** - * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -658,7 +658,7 @@ export namespace cloudasset_v1p5beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1IngressFrom { /** - * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** diff --git a/src/apis/cloudasset/v1p7beta1.ts b/src/apis/cloudasset/v1p7beta1.ts index 6e4b62544e..9c4d7c9e63 100644 --- a/src/apis/cloudasset/v1p7beta1.ts +++ b/src/apis/cloudasset/v1p7beta1.ts @@ -644,7 +644,7 @@ export namespace cloudasset_v1p7beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1EgressFrom { /** - * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [EgressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** @@ -704,7 +704,7 @@ export namespace cloudasset_v1p7beta1 { */ export interface Schema$GoogleIdentityAccesscontextmanagerV1IngressFrom { /** - * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, `principal`, and `principalSet` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. + * A list of identities that are allowed access through [IngressPolicy]. Identities can be an individual user, service account, Google group, or third-party identity. For third-party identity, only single identities are supported and other identity types are not supported. The `v1` identities that have the prefix `user`, `group`, `serviceAccount`, and `principal` in https://cloud.google.com/iam/docs/principal-identifiers#v1 are supported. */ identities?: string[] | null; /** diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index 50082a93c6..63dffae3db 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -1514,7 +1514,7 @@ export namespace cloudbuild_v1 { */ export interface Schema$HttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + * SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string | null; } diff --git a/src/apis/cloudbuild/v2.ts b/src/apis/cloudbuild/v2.ts index 9cb109be63..5ab576c74b 100644 --- a/src/apis/cloudbuild/v2.ts +++ b/src/apis/cloudbuild/v2.ts @@ -848,6 +848,10 @@ export namespace cloudbuild_v2 { * Value of the parameter if type is array. */ arrayVal?: string[] | null; + /** + * Optional. Value of the parameter if type is object. + */ + objectVal?: {[key: string]: string} | null; /** * Value of the parameter if type is string. */ @@ -862,7 +866,7 @@ export namespace cloudbuild_v2 { */ export interface Schema$PipelineRef { /** - * Name of the Pipeline. + * Optional. Name of the Pipeline. */ name?: string | null; /** @@ -1272,7 +1276,7 @@ export namespace cloudbuild_v2 { */ secretName?: string | null; /** - * Output only. Resource name of the SecretVersion. In format: projects/x/secrets/x/versions/x + * Optional. Resource name of the SecretVersion. In format: projects/x/secrets/x/versions/x */ secretVersion?: string | null; } @@ -1502,7 +1506,7 @@ export namespace cloudbuild_v2 { */ export interface Schema$TaskRef { /** - * Name of the task. + * Optional. Name of the task. */ name?: string | null; /** diff --git a/src/apis/cloudchannel/v1.ts b/src/apis/cloudchannel/v1.ts index 1b261992d8..ea79d5b277 100644 --- a/src/apis/cloudchannel/v1.ts +++ b/src/apis/cloudchannel/v1.ts @@ -113,6 +113,7 @@ export namespace cloudchannel_v1 { export class Cloudchannel { context: APIRequestContext; accounts: Resource$Accounts; + integrators: Resource$Integrators; operations: Resource$Operations; products: Resource$Products; @@ -123,6 +124,7 @@ export namespace cloudchannel_v1 { }; this.accounts = new Resource$Accounts(this.context); + this.integrators = new Resource$Integrators(this.context); this.operations = new Resource$Operations(this.context); this.products = new Resource$Products(this.context); } @@ -1882,6 +1884,10 @@ export namespace cloudchannel_v1 { * Request Message for RegisterSubscriber. */ export interface Schema$GoogleCloudChannelV1RegisterSubscriberRequest { + /** + * Optional. Resource name of the integrator. + */ + integrator?: string | null; /** * Required. Service account that provides subscriber access to the registered topic. */ @@ -2303,6 +2309,10 @@ export namespace cloudchannel_v1 { * Request Message for UnregisterSubscriber. */ export interface Schema$GoogleCloudChannelV1UnregisterSubscriberRequest { + /** + * Optional. Resource name of the integrator. + */ + integrator?: string | null; /** * Required. Service account to unregister from subscriber access to the topic. */ @@ -3182,9 +3192,13 @@ export namespace cloudchannel_v1 { export interface Params$Resource$Accounts$Listsubscribers extends StandardParameters { /** - * Required. Resource name of the account. + * Optional. Resource name of the account. */ account?: string; + /** + * Optional. Resource name of the integrator. + */ + integrator?: string; /** * Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000. */ @@ -3221,7 +3235,7 @@ export namespace cloudchannel_v1 { export interface Params$Resource$Accounts$Register extends StandardParameters { /** - * Required. Resource name of the account. + * Optional. Resource name of the account. */ account?: string; @@ -3233,7 +3247,7 @@ export namespace cloudchannel_v1 { export interface Params$Resource$Accounts$Unregister extends StandardParameters { /** - * Required. Resource name of the account. + * Optional. Resource name of the account. */ account?: string; @@ -8796,6 +8810,354 @@ export namespace cloudchannel_v1 { parent?: string; } + export class Resource$Integrators { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists service accounts with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: A list of service email addresses. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listSubscribers( + params: Params$Resource$Integrators$Listsubscribers, + options: StreamMethodOptions + ): GaxiosPromise; + listSubscribers( + params?: Params$Resource$Integrators$Listsubscribers, + options?: MethodOptions + ): GaxiosPromise; + listSubscribers( + params: Params$Resource$Integrators$Listsubscribers, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listSubscribers( + params: Params$Resource$Integrators$Listsubscribers, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listSubscribers( + params: Params$Resource$Integrators$Listsubscribers, + callback: BodyResponseCallback + ): void; + listSubscribers( + callback: BodyResponseCallback + ): void; + listSubscribers( + paramsOrCallback?: + | Params$Resource$Integrators$Listsubscribers + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Integrators$Listsubscribers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Integrators$Listsubscribers; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudchannel.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+integrator}:listSubscribers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['integrator'], + pathParams: ['integrator'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + register( + params: Params$Resource$Integrators$Register, + options: StreamMethodOptions + ): GaxiosPromise; + register( + params?: Params$Resource$Integrators$Register, + options?: MethodOptions + ): GaxiosPromise; + register( + params: Params$Resource$Integrators$Register, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + register( + params: Params$Resource$Integrators$Register, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + register( + params: Params$Resource$Integrators$Register, + callback: BodyResponseCallback + ): void; + register( + callback: BodyResponseCallback + ): void; + register( + paramsOrCallback?: + | Params$Resource$Integrators$Register + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Integrators$Register; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Integrators$Register; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudchannel.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+integrator}:register').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['integrator'], + pathParams: ['integrator'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + unregister( + params: Params$Resource$Integrators$Unregister, + options: StreamMethodOptions + ): GaxiosPromise; + unregister( + params?: Params$Resource$Integrators$Unregister, + options?: MethodOptions + ): GaxiosPromise; + unregister( + params: Params$Resource$Integrators$Unregister, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unregister( + params: Params$Resource$Integrators$Unregister, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + unregister( + params: Params$Resource$Integrators$Unregister, + callback: BodyResponseCallback + ): void; + unregister( + callback: BodyResponseCallback + ): void; + unregister( + paramsOrCallback?: + | Params$Resource$Integrators$Unregister + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Integrators$Unregister; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Integrators$Unregister; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudchannel.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+integrator}:unregister').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['integrator'], + pathParams: ['integrator'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Integrators$Listsubscribers + extends StandardParameters { + /** + * Optional. Resource name of the account. + */ + account?: string; + /** + * Optional. Resource name of the integrator. + */ + integrator?: string; + /** + * Optional. The maximum number of service accounts to return. The service may return fewer than this value. If unspecified, returns at most 100 service accounts. The maximum value is 1000; the server will coerce values above 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListSubscribers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubscribers` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Integrators$Register + extends StandardParameters { + /** + * Optional. Resource name of the account. + */ + account?: string; + /** + * Optional. Resource name of the integrator. + */ + integrator?: string; + /** + * Required. Service account that provides subscriber access to the registered topic. + */ + serviceAccount?: string; + } + export interface Params$Resource$Integrators$Unregister + extends StandardParameters { + /** + * Optional. Resource name of the account. + */ + account?: string; + /** + * Optional. Resource name of the integrator. + */ + integrator?: string; + /** + * Required. Service account to unregister from subscriber access to the topic. + */ + serviceAccount?: string; + } + export class Resource$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/cloudcontrolspartner/v1.ts b/src/apis/cloudcontrolspartner/v1.ts index ebd6c28b0d..cf3279860b 100644 --- a/src/apis/cloudcontrolspartner/v1.ts +++ b/src/apis/cloudcontrolspartner/v1.ts @@ -193,15 +193,15 @@ export namespace cloudcontrolspartner_v1 { */ export interface Schema$Customer { /** - * Container for customer onboarding steps + * Output only. Container for customer onboarding steps */ customerOnboardingState?: Schema$CustomerOnboardingState; /** - * The customer organization's display name. E.g. "google.com". + * Optional. The customer organization's display name. E.g. "Google". */ displayName?: string | null; /** - * Indicates whether a customer is fully onboarded + * Output only. Indicates whether a customer is fully onboarded */ isOnboarded?: boolean | null; /** diff --git a/src/apis/cloudcontrolspartner/v1beta.ts b/src/apis/cloudcontrolspartner/v1beta.ts index 01c700139e..c14030a465 100644 --- a/src/apis/cloudcontrolspartner/v1beta.ts +++ b/src/apis/cloudcontrolspartner/v1beta.ts @@ -193,15 +193,15 @@ export namespace cloudcontrolspartner_v1beta { */ export interface Schema$Customer { /** - * Container for customer onboarding steps + * Output only. Container for customer onboarding steps */ customerOnboardingState?: Schema$CustomerOnboardingState; /** - * The customer organization's display name. E.g. "google.com". + * Optional. The customer organization's display name. E.g. "Google". */ displayName?: string | null; /** - * Indicates whether a customer is fully onboarded + * Output only. Indicates whether a customer is fully onboarded */ isOnboarded?: boolean | null; /** diff --git a/src/apis/clouddeploy/v1.ts b/src/apis/clouddeploy/v1.ts index 3073663e11..5046363504 100644 --- a/src/apis/clouddeploy/v1.ts +++ b/src/apis/clouddeploy/v1.ts @@ -773,6 +773,27 @@ export namespace clouddeploy_v1 { */ updateTime?: string | null; } + /** + * Payload proto for "clouddeploy.googleapis.com/customtargettype_notification" Platform Log event that describes the failure to send a custom target type status change Pub/Sub notification. + */ + export interface Schema$CustomTargetTypeNotificationEvent { + /** + * The name of the `CustomTargetType`. + */ + customTargetType?: string | null; + /** + * Unique identifier of the `CustomTargetType`. + */ + customTargetTypeUid?: string | null; + /** + * Debug message for when a notification fails to send. + */ + message?: string | null; + /** + * Type of this notification, e.g. for a Pub/Sub failure. + */ + type?: string | null; + } /** * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp */ @@ -966,6 +987,27 @@ export namespace clouddeploy_v1 { */ values?: {[key: string]: string} | null; } + /** + * Payload proto for "clouddeploy.googleapis.com/deploypolicy_notification". Platform Log event that describes the failure to send a pub/sub notification when there is a DeployPolicy status change. + */ + export interface Schema$DeployPolicyNotificationEvent { + /** + * The name of the `DeployPolicy`. + */ + deployPolicy?: string | null; + /** + * Unique identifier of the deploy policy. + */ + deployPolicyUid?: string | null; + /** + * Debug message for when a deploy policy fails to send a pub/sub notification. + */ + message?: string | null; + /** + * Type of this notification, e.g. for a Pub/Sub failure. + */ + type?: string | null; + } /** * 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); \} */ @@ -1040,6 +1082,10 @@ export namespace clouddeploy_v1 { * Required. Name of the Gateway API HTTPRoute. */ httpRoute?: string | null; + /** + * Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. + */ + podSelectorLabel?: string | null; /** * Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. */ @@ -1753,7 +1799,7 @@ export namespace clouddeploy_v1 { wait?: string | null; } /** - * `PromoteRelease` rule will automatically promote a release from the current target to a specified target. + * The `PromoteRelease` rule will automatically promote a release from the current target to a specified target. */ export interface Schema$PromoteReleaseRule { /** @@ -1765,7 +1811,7 @@ export namespace clouddeploy_v1 { */ destinationPhase?: string | null; /** - * Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine if the target is one of the stages in the promotion sequence defined in the pipeline. * "@next", the next target in the promotion sequence. + * Optional. The ID of the stage in the pipeline to which this `Release` is deploying. If unspecified, default it to the next stage in the promotion flow. The value of this field could be one of the following: * The last segment of a target name * "@next", the next target in the promotion sequence */ destinationTargetId?: string | null; /** @@ -2334,6 +2380,10 @@ export namespace clouddeploy_v1 { * Optional. Whether to disable Pod overprovisioning. If Pod overprovisioning is disabled then Cloud Deploy will limit the number of total Pods used for the deployment strategy to the number of Pods the Deployment has on the cluster. */ disablePodOverprovisioning?: boolean | null; + /** + * Optional. The label to use when selecting Pods for the Deployment resource. This label must already be present in the Deployment. + */ + podSelectorLabel?: string | null; /** * Required. Name of the Kubernetes Service. */ @@ -2629,7 +2679,7 @@ export namespace clouddeploy_v1 { */ export interface Schema$TargetAttribute { /** - * ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name. It only needs the ID to determine which target is being referred to * "*", all targets in a location. + * ID of the `Target`. The value of this field could be one of the following: * The last segment of a target name * "*", all targets in a location */ id?: string | null; /** @@ -3726,7 +3776,7 @@ export namespace clouddeploy_v1 { */ customTargetTypeId?: string; /** - * Required. The parent collection in which the `CustomTargetType` should be created. Format should be `projects/{project_id\}/locations/{location_name\}`. + * Required. The parent collection in which the `CustomTargetType` must be created. The format is `projects/{project_id\}/locations/{location_name\}`. */ parent?: string; /** @@ -3822,7 +3872,7 @@ export namespace clouddeploy_v1 { */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the `CustomTargetType` 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's in the mask. If the user doesn't provide a mask then all fields are overwritten. + * Required. Field mask is used to specify the fields to be overwritten by the update in the `CustomTargetType` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten. */ updateMask?: string; /** @@ -4691,7 +4741,7 @@ export namespace clouddeploy_v1 { */ deliveryPipelineId?: string; /** - * Required. The parent collection in which the `DeliveryPipeline` should be created. Format should be `projects/{project_id\}/locations/{location_name\}`. + * Required. The parent collection in which the `DeliveryPipeline` must be created. The format is `projects/{project_id\}/locations/{location_name\}`. */ parent?: string; /** @@ -4723,7 +4773,7 @@ export namespace clouddeploy_v1 { */ force?: boolean; /** - * Required. The name of the `DeliveryPipeline` to delete. Format should be `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. + * Required. The name of the `DeliveryPipeline` to delete. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. */ name?: string; /** @@ -4791,7 +4841,7 @@ export namespace clouddeploy_v1 { */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the `DeliveryPipeline` 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's in the mask. If the user doesn't provide a mask then all fields are overwritten. + * Required. Field mask is used to specify the fields to be overwritten by the update in the `DeliveryPipeline` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten. */ updateMask?: string; /** @@ -4807,7 +4857,7 @@ export namespace clouddeploy_v1 { export interface Params$Resource$Projects$Locations$Deliverypipelines$Rollbacktarget extends StandardParameters { /** - * Required. The `DeliveryPipeline` for which the rollback `Rollout` should be created. Format should be `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. + * Required. The `DeliveryPipeline` for which the rollback `Rollout` must be created. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. */ name?: string; @@ -5621,7 +5671,7 @@ export namespace clouddeploy_v1 { */ automationId?: string; /** - * Required. The parent collection in which the `Automation` should be created. Format should be `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. + * Required. The parent collection in which the `Automation` must be created. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. */ parent?: string; /** @@ -5649,7 +5699,7 @@ export namespace clouddeploy_v1 { */ etag?: string; /** - * Required. The name of the `Automation` to delete. Format should be `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}/automations/{automation_name\}`. + * Required. The name of the `Automation` to delete. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}/automations/{automation_name\}`. */ name?: string; /** @@ -5706,7 +5756,7 @@ export namespace clouddeploy_v1 { */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the `Automation` 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's in the mask. If the user doesn't provide a mask then all fields are overwritten. + * Required. Field mask is used to specify the fields to be overwritten by the update in the `Automation` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten. */ updateMask?: string; /** @@ -6112,7 +6162,7 @@ export namespace clouddeploy_v1 { export interface Params$Resource$Projects$Locations$Deliverypipelines$Releases$Create extends StandardParameters { /** - * Required. The parent collection in which the `Release` should be created. Format should be `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. + * Required. The parent collection in which the `Release` is created. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}`. */ parent?: string; /** @@ -6948,7 +6998,7 @@ export namespace clouddeploy_v1 { export interface Params$Resource$Projects$Locations$Deliverypipelines$Releases$Rollouts$Create extends StandardParameters { /** - * Required. The parent collection in which the `Rollout` should be created. Format should be `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}/releases/{release_name\}`. + * Required. The parent collection in which the `Rollout` must be created. The format is `projects/{project_id\}/locations/{location_name\}/deliveryPipelines/{pipeline_name\}/releases/{release_name\}`. */ parent?: string; /** @@ -8469,7 +8519,7 @@ export namespace clouddeploy_v1 { export interface Params$Resource$Projects$Locations$Targets$Create extends StandardParameters { /** - * Required. The parent collection in which the `Target` should be created. Format should be `projects/{project_id\}/locations/{location_name\}`. + * Required. The parent collection in which the `Target` must be created. The format is `projects/{project_id\}/locations/{location_name\}`. */ parent?: string; /** @@ -8501,7 +8551,7 @@ export namespace clouddeploy_v1 { */ etag?: string; /** - * Required. The name of the `Target` to delete. Format should be `projects/{project_id\}/locations/{location_name\}/targets/{target_name\}`. + * Required. The name of the `Target` to delete. The format is `projects/{project_id\}/locations/{location_name\}/targets/{target_name\}`. */ name?: string; /** @@ -8569,7 +8619,7 @@ export namespace clouddeploy_v1 { */ requestId?: string; /** - * Required. Field mask is used to specify the fields to be overwritten in the Target 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's in the mask. If the user doesn't provide a mask then all fields are overwritten. + * Required. Field mask is used to specify the fields to be overwritten by the update in the `Target` resource. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten. */ updateMask?: string; /** diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index 431b27fa29..ddb1bb8dbc 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -179,7 +179,7 @@ export namespace clouderrorreporting_v1beta1 { */ groupId?: string | null; /** - * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ name?: string | null; /** @@ -308,7 +308,7 @@ export namespace clouderrorreporting_v1beta1 { */ eventTime?: string | null; /** - * Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). + * Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack). */ message?: string | null; /** @@ -399,11 +399,13 @@ export namespace clouderrorreporting_v1beta1 { events: Resource$Projects$Events; groups: Resource$Projects$Groups; groupStats: Resource$Projects$Groupstats; + locations: Resource$Projects$Locations; constructor(context: APIRequestContext) { this.context = context; this.events = new Resource$Projects$Events(this.context); this.groups = new Resource$Projects$Groups(this.context); this.groupStats = new Resource$Projects$Groupstats(this.context); + this.locations = new Resource$Projects$Locations(this.context); } /** @@ -506,7 +508,7 @@ export namespace clouderrorreporting_v1beta1 { export interface Params$Resource$Projects$Deleteevents extends StandardParameters { /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ projectName?: string; } @@ -610,7 +612,7 @@ export namespace clouderrorreporting_v1beta1 { } /** - * Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName\}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and can analyze log entries when all of the following are true: * The log entries are stored in a log bucket in the `global` location. * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns. + * Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an [API key](https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName\}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a service built on Cloud Logging and can analyze log entries when all of the following are true: * Customer-managed encryption keys (CMEK) are disabled on the log bucket. * The log bucket satisfies one of the following: * The log bucket is stored in the same project where the logs originated. * The logs were routed to a project, and then that project stored those logs in a log bucket that it owns. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -721,7 +723,7 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ projectName?: string; /** @@ -939,14 +941,14 @@ export namespace clouderrorreporting_v1beta1 { export interface Params$Resource$Projects$Groups$Get extends StandardParameters { /** - * Required. The group resource name. Written as `projects/{projectID\}/groups/{group_id\}`. Call groupStats.list to return a list of groups belonging to this project. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + * Required. The group resource name. Written as either `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ groupName?: string; } export interface Params$Resource$Projects$Groups$Update extends StandardParameters { /** - * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. */ name?: string; @@ -1084,7 +1086,616 @@ export namespace clouderrorreporting_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectNumber\}`, where `{projectID\}` and `{projectNumber\}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). Examples: `projects/my-project-123`, `projects/5551234`. + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectNumber\}`, where `{projectID\}` and `{projectNumber\}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID\}/locations/{location\}` where `{location\}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions. + */ + projectName?: string; + /** + * Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + */ + 'serviceFilter.resourceType'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + */ + 'serviceFilter.service'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + */ + 'serviceFilter.version'?: string; + /** + * Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned. + */ + timedCountDuration?: string; + /** + * Restricts the query to the specified time range. + */ + 'timeRange.period'?: string; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + events: Resource$Projects$Locations$Events; + groups: Resource$Projects$Locations$Groups; + groupStats: Resource$Projects$Locations$Groupstats; + constructor(context: APIRequestContext) { + this.context = context; + this.events = new Resource$Projects$Locations$Events(this.context); + this.groups = new Resource$Projects$Locations$Groups(this.context); + this.groupStats = new Resource$Projects$Locations$Groupstats( + this.context + ); + } + + /** + * Deletes all error events of a given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + options: StreamMethodOptions + ): GaxiosPromise; + deleteEvents( + params?: Params$Resource$Projects$Locations$Deleteevents, + options?: MethodOptions + ): GaxiosPromise; + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteEvents( + params: Params$Resource$Projects$Locations$Deleteevents, + callback: BodyResponseCallback + ): void; + deleteEvents( + callback: BodyResponseCallback + ): void; + deleteEvents( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Deleteevents + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Deleteevents; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Deleteevents; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+projectName}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectName'], + pathParams: ['projectName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Deleteevents + extends StandardParameters { + /** + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + projectName?: string; + } + + export class Resource$Projects$Locations$Events { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the specified events. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Events$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Events$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Events$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Events$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Events$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Events$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Events$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Events$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+projectName}/events').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectName'], + pathParams: ['projectName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Events$List + extends StandardParameters { + /** + * Required. The group for which events shall be returned. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). + */ + groupId?: string; + /** + * Optional. The maximum number of results to return per response. + */ + pageSize?: number; + /** + * Optional. A `next_page_token` provided by a previous response. + */ + pageToken?: string; + /** + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectID\}/locations/{location\}`, where `{projectID\}` is the [Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840) and `{location\}` is a Cloud region. Examples: `projects/my-project-123`, `projects/my-project-123/locations/global`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + projectName?: string; + /** + * Optional. The exact value to match against [`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type). + */ + 'serviceFilter.resourceType'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service). + */ + 'serviceFilter.service'?: string; + /** + * Optional. The exact value to match against [`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version). + */ + 'serviceFilter.version'?: string; + /** + * Restricts the query to the specified time range. + */ + 'timeRange.period'?: string; + } + + export class Resource$Projects$Locations$Groups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Get the specified group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Groups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Groups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Groups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Groups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Groups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Groups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Groups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Groups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+groupName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['groupName'], + pathParams: ['groupName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Replace the data for the specified group. Fails if the group does not exist. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Projects$Locations$Groups$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Projects$Locations$Groups$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Groups$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Groups$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Projects$Locations$Groups$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Groups$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Groups$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Groups$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Groups$Get + extends StandardParameters { + /** + * Required. The group resource name. Written as either `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}`. Call groupStats.list to return a list of groups belonging to this project. Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/global/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + groupName?: string; + } + export interface Params$Resource$Projects$Locations$Groups$Update + extends StandardParameters { + /** + * The group resource name. Written as `projects/{projectID\}/groups/{group_id\}` or `projects/{projectID\}/locations/{location\}/groups/{group_id\}` Examples: `projects/my-project-123/groups/my-group`, `projects/my-project-123/locations/us-central1/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ErrorGroup; + } + + export class Resource$Projects$Locations$Groupstats { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the specified groups. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Groupstats$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Groupstats$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Groupstats$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Groupstats$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Groupstats$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://clouderrorreporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+projectName}/groupStats').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['projectName'], + pathParams: ['projectName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Groupstats$List + extends StandardParameters { + /** + * Optional. The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`. + */ + alignment?: string; + /** + * Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC. + */ + alignmentTime?: string; + /** + * Optional. List all ErrorGroupStats with these IDs. The `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice] (https://cloud.google.com/terms/cloud-privacy-notice). + */ + groupId?: string[]; + /** + * Optional. The sort order in which the results are returned. Default is `COUNT_DESC`. + */ + order?: string; + /** + * Optional. The maximum number of results to return per response. Default is 20. + */ + pageSize?: number; + /** + * Optional. A next_page_token provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request. + */ + pageToken?: string; + /** + * Required. The resource name of the Google Cloud Platform project. Written as `projects/{projectID\}` or `projects/{projectNumber\}`, where `{projectID\}` and `{projectNumber\}` can be found in the [Google Cloud console](https://support.google.com/cloud/answer/6158840). It may also include a location, such as `projects/{projectID\}/locations/{location\}` where `{location\}` is a cloud region. Examples: `projects/my-project-123`, `projects/5551234`, `projects/my-project-123/locations/us-central1`, `projects/5551234/locations/us-central1`. For a list of supported locations, see [Supported Regions](https://cloud.google.com/logging/docs/region-support). `global` is the default when unspecified. Use `-` as a wildcard to request group stats from all regions. */ projectName?: string; /** diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index c046e8a43e..489648fb02 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -221,7 +221,7 @@ export namespace cloudfunctions_v1 { */ buildName?: string | null; /** - * Optional. A service account the user provides for use with Cloud Build. + * A service account the user provides for use with Cloud Build. The format of this field is `projects/{projectId\}/serviceAccounts/{serviceAccountEmail\}`. */ buildServiceAccount?: string | null; /** @@ -446,6 +446,10 @@ export namespace cloudfunctions_v1 { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -550,6 +554,10 @@ export namespace cloudfunctions_v1 { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -654,6 +662,10 @@ export namespace cloudfunctions_v1 { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -995,7 +1007,7 @@ export namespace cloudfunctions_v1 { */ deployedUrl?: string | null; /** - * The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x` You may omit `paths/x` if you want to use the main directory. + * The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/x/repos/x/moveable-aliases/x/paths/x` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/x/repos/x/fixed-aliases/x/paths/x` You may omit `paths/x` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. */ url?: string | null; } diff --git a/src/apis/cloudfunctions/v2.ts b/src/apis/cloudfunctions/v2.ts index c083dad9c3..51ffe77182 100644 --- a/src/apis/cloudfunctions/v2.ts +++ b/src/apis/cloudfunctions/v2.ts @@ -206,7 +206,7 @@ export namespace cloudfunctions_v2 { */ runtime?: string | null; /** - * [Preview] Service account to be used for building the container + * Service account to be used for building the container. The format of this field is `projects/{projectId\}/serviceAccounts/{serviceAccountEmail\}`. */ serviceAccount?: string | null; /** @@ -447,6 +447,10 @@ export namespace cloudfunctions_v2 { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -551,6 +555,10 @@ export namespace cloudfunctions_v2 { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -655,6 +663,10 @@ export namespace cloudfunctions_v2 { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -2883,7 +2895,7 @@ export namespace cloudfunctions_v2 { */ name?: string; /** - * The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated. + * The list of fields to be updated. If no field mask is provided, all fields will be updated. */ updateMask?: string; diff --git a/src/apis/cloudfunctions/v2alpha.ts b/src/apis/cloudfunctions/v2alpha.ts index f9972fdc41..d22c9dcc7d 100644 --- a/src/apis/cloudfunctions/v2alpha.ts +++ b/src/apis/cloudfunctions/v2alpha.ts @@ -206,7 +206,7 @@ export namespace cloudfunctions_v2alpha { */ runtime?: string | null; /** - * [Preview] Service account to be used for building the container + * Service account to be used for building the container. The format of this field is `projects/{projectId\}/serviceAccounts/{serviceAccountEmail\}`. */ serviceAccount?: string | null; /** @@ -447,6 +447,10 @@ export namespace cloudfunctions_v2alpha { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -551,6 +555,10 @@ export namespace cloudfunctions_v2alpha { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -655,6 +663,10 @@ export namespace cloudfunctions_v2alpha { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -2882,7 +2894,7 @@ export namespace cloudfunctions_v2alpha { */ name?: string; /** - * The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated. + * The list of fields to be updated. If no field mask is provided, all fields will be updated. */ updateMask?: string; diff --git a/src/apis/cloudfunctions/v2beta.ts b/src/apis/cloudfunctions/v2beta.ts index 92b20d90a0..91ffa948d8 100644 --- a/src/apis/cloudfunctions/v2beta.ts +++ b/src/apis/cloudfunctions/v2beta.ts @@ -206,7 +206,7 @@ export namespace cloudfunctions_v2beta { */ runtime?: string | null; /** - * [Preview] Service account to be used for building the container + * Service account to be used for building the container. The format of this field is `projects/{projectId\}/serviceAccounts/{serviceAccountEmail\}`. */ serviceAccount?: string | null; /** @@ -447,6 +447,10 @@ export namespace cloudfunctions_v2beta { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -551,6 +555,10 @@ export namespace cloudfunctions_v2beta { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -655,6 +663,10 @@ export namespace cloudfunctions_v2beta { * API version used to start the operation. */ apiVersion?: string | null; + /** + * The build name of the function for create and update operations. + */ + buildName?: string | null; /** * Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */ @@ -2882,7 +2894,7 @@ export namespace cloudfunctions_v2beta { */ name?: string; /** - * The list of fields to be updated. If no field mask is provided, all provided fields in the request will be updated. + * The list of fields to be updated. If no field mask is provided, all fields will be updated. */ updateMask?: string; diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 1d763ab7bf..1665e5cb20 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -337,7 +337,7 @@ export namespace cloudkms_v1 { */ cryptoKeyBackend?: string | null; /** - * Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. + * Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 30 days. */ destroyScheduledDuration?: string | null; /** diff --git a/src/apis/cloudtrace/v2beta1.ts b/src/apis/cloudtrace/v2beta1.ts index 56f35d0443..eb3d78cf6e 100644 --- a/src/apis/cloudtrace/v2beta1.ts +++ b/src/apis/cloudtrace/v2beta1.ts @@ -146,7 +146,7 @@ export namespace cloudtrace_v2beta1 { */ export interface Schema$OutputConfig { /** - * The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + * Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" */ destination?: string | null; } @@ -155,7 +155,7 @@ export namespace cloudtrace_v2beta1 { */ export interface Schema$TraceSink { /** - * Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + * Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. */ name?: string | null; /** diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index edb4ba999d..d265d97153 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -345,6 +345,10 @@ export namespace composer_v1 { * The resource name of the environment, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 1eed84f48d..8690c9689b 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -349,6 +349,10 @@ export namespace composer_v1beta1 { * The resource name of the environment, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. */ name?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * Output only. Reserved for future use. */ diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 5524f4e740..3bc110655c 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -146,6 +146,7 @@ export namespace compute_alpha { instances: Resource$Instances; instanceSettings: Resource$Instancesettings; instanceTemplates: Resource$Instancetemplates; + instantSnapshotGroups: Resource$Instantsnapshotgroups; instantSnapshots: Resource$Instantsnapshots; interconnectAttachments: Resource$Interconnectattachments; interconnectLocations: Resource$Interconnectlocations; @@ -178,12 +179,13 @@ export namespace compute_alpha { regionDiskTypes: Resource$Regiondisktypes; regionHealthChecks: Resource$Regionhealthchecks; regionHealthCheckServices: Resource$Regionhealthcheckservices; + regionInstanceGroupManagerResizeRequests: Resource$Regioninstancegroupmanagerresizerequests; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; regionInstances: Resource$Regioninstances; regionInstanceTemplates: Resource$Regioninstancetemplates; + regionInstantSnapshotGroups: Resource$Regioninstantsnapshotgroups; regionInstantSnapshots: Resource$Regioninstantsnapshots; - regionMultiMigs: Resource$Regionmultimigs; regionNetworkEndpointGroups: Resource$Regionnetworkendpointgroups; regionNetworkFirewallPolicies: Resource$Regionnetworkfirewallpolicies; regionNotificationEndpoints: Resource$Regionnotificationendpoints; @@ -271,6 +273,9 @@ export namespace compute_alpha { this.instances = new Resource$Instances(this.context); this.instanceSettings = new Resource$Instancesettings(this.context); this.instanceTemplates = new Resource$Instancetemplates(this.context); + this.instantSnapshotGroups = new Resource$Instantsnapshotgroups( + this.context + ); this.instantSnapshots = new Resource$Instantsnapshots(this.context); this.interconnectAttachments = new Resource$Interconnectattachments( this.context @@ -322,6 +327,8 @@ export namespace compute_alpha { this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( this.context ); + this.regionInstanceGroupManagerResizeRequests = + new Resource$Regioninstancegroupmanagerresizerequests(this.context); this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers(this.context); this.regionInstanceGroups = new Resource$Regioninstancegroups( @@ -331,10 +338,11 @@ export namespace compute_alpha { this.regionInstanceTemplates = new Resource$Regioninstancetemplates( this.context ); + this.regionInstantSnapshotGroups = + new Resource$Regioninstantsnapshotgroups(this.context); this.regionInstantSnapshots = new Resource$Regioninstantsnapshots( this.context ); - this.regionMultiMigs = new Resource$Regionmultimigs(this.context); this.regionNetworkEndpointGroups = new Resource$Regionnetworkendpointgroups(this.context); this.regionNetworkFirewallPolicies = @@ -786,7 +794,7 @@ export namespace compute_alpha { */ threadsPerCore?: number | null; /** - * Turbo mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the default turbo mode. + * Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. */ turboMode?: string | null; /** @@ -867,6 +875,10 @@ export namespace compute_alpha { * ID of the instance template used to populate reservation properties. */ sourceInstanceTemplateId?: string | null; + /** + * Per service utilization breakdown. The Key is the Google Cloud managed service name. + */ + utilizations?: {[key: string]: string} | null; } export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { /** @@ -1520,6 +1532,10 @@ export namespace compute_alpha { * A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. */ capacityScaler?: number | null; + /** + * List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + */ + customMetrics?: Schema$BackendCustomMetric[]; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -1625,6 +1641,10 @@ export namespace compute_alpha { * [Output Only] Server-defined URL for this resource with the resource id. */ selfLinkWithId?: string | null; + /** + * [Output Only] List of resources referencing that backend bucket. + */ + usedBy?: Schema$BackendBucketUsedBy[]; } /** * Message containing Cloud CDN configuration for a backend bucket. @@ -1747,6 +1767,59 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$BackendBucketListUsable { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of BackendBucket resources. + */ + items?: Schema$BackendBucket[]; + /** + * [Output Only] Type of resource. Always compute#usableBackendBucketList for lists of usable backend buckets. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$BackendBucketUsedBy { + /** + * [Output Only] Server-defined URL for UrlMaps referencing that BackendBucket. + */ + reference?: string | null; + } + /** + * Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + */ + export interface Schema$BackendCustomMetric { + /** + * If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing. + */ + dryRun?: boolean | null; + /** + * Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0]. + */ + maxUtilization?: number | null; + /** + * Name of a custom utilization signal. The name must be 1-64 characters long, and comply with relaxed RFC1035. Specifically, the name must be 1-64 characters long and match the regular expression [a-z]([-_.a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, period, underscore, lowercase letter, or digit, except the last character, which cannot be a dash, period, or underscore. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED. + */ + name?: string | null; + } /** * Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices) For more information, see Backend Services. */ @@ -1850,7 +1923,7 @@ export namespace compute_alpha { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. */ localityLbPolicy?: string | null; /** @@ -1934,6 +2007,13 @@ export namespace compute_alpha { * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. */ timeoutSec?: number | null; + /** + * Configuration for Backend Authenticated TLS and mTLS. May only be specified when the backend protocol is SSL, HTTPS or HTTP2. + */ + tlsSettings?: Schema$BackendServiceTlsSettings; + /** + * [Output Only] List of resources referencing given backend service. + */ usedBy?: Schema$BackendServiceUsedBy[]; /** * The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2339,7 +2419,37 @@ export namespace compute_alpha { message?: string; } | null; } + export interface Schema$BackendServiceTlsSettings { + /** + * Reference to the BackendAuthenticationConfig resource from the networksecurity.googleapis.com namespace. Can be used in authenticating TLS connections to the backend, as specified by the authenticationMode field. Can only be specified if authenticationMode is not NONE. + */ + authenticationConfig?: string | null; + /** + * Server Name Indication - see RFC3546 section 3.1. If set, the load balancer sends this string as the SNI hostname in the TLS connection to the backend, and requires that this string match a Subject Alternative Name (SAN) in the backend's server certificate. With a Regional Internet NEG backend, if the SNI is specified here, the load balancer uses it regardless of whether the Regional Internet NEG is specified with FQDN or IP address and port. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[]. + */ + sni?: string | null; + /** + * A list of Subject Alternative Names (SANs) that the Load Balancer verifies during a TLS handshake with the backend. When the server presents its X.509 certificate to the Load Balancer, the Load Balancer inspects the certificate's SAN field, and requires that at least one SAN match one of the subjectAltNames in the list. This field is limited to 5 entries. When both sni and subjectAltNames[] are specified, the load balancer matches the backend certificate's SAN only to subjectAltNames[]. + */ + subjectAltNames?: Schema$BackendServiceTlsSettingsSubjectAltName[]; + } + /** + * A Subject Alternative Name that the load balancer matches against the SAN field in the TLS certificate provided by the backend, specified as either a DNS name or a URI, in accordance with RFC 5280 4.2.1.6 + */ + export interface Schema$BackendServiceTlsSettingsSubjectAltName { + /** + * The SAN specified as a DNS Name. + */ + dnsName?: string | null; + /** + * The SAN specified as a URI. + */ + uniformResourceIdentifier?: string | null; + } export interface Schema$BackendServiceUsedBy { + /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + */ reference?: string | null; } export interface Schema$BfdPacket { @@ -2774,6 +2884,10 @@ export namespace compute_alpha { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; + /** + * [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. + */ + customEndTimestamp?: string | null; /** * An optional description of this resource. Provide this property when you create the resource. */ @@ -2930,6 +3044,10 @@ export namespace compute_alpha { * [Output Only] An optional, contains all the needed information of cancellation. */ cancellationInformation?: Schema$CommitmentResourceStatusCancellationInformation; + /** + * [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. + */ + customTermEligibilityEndTimestamp?: string | null; } export interface Schema$CommitmentResourceStatusCancellationInformation { /** @@ -4290,7 +4408,7 @@ export namespace compute_alpha { */ export interface Schema$FirewallPolicyRule { /** - * The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + * The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". */ action?: string | null; /** @@ -4310,7 +4428,7 @@ export namespace compute_alpha { */ enableLogging?: boolean | null; /** - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. */ kind?: string | null; /** @@ -4318,7 +4436,7 @@ export namespace compute_alpha { */ match?: Schema$FirewallPolicyRuleMatcher; /** - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. */ priority?: number | null; /** @@ -4330,7 +4448,7 @@ export namespace compute_alpha { */ ruleTupleCount?: number | null; /** - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. */ securityProfileGroup?: string | null; /** @@ -4898,6 +5016,10 @@ export namespace compute_alpha { * Fully qualified urls of the automatically created reservations at start_time. */ autoCreatedReservations?: string[] | null; + /** + * [Output Only] Represents the existing matching usage for the future reservation. + */ + existingMatchingUsageInfo?: Schema$FutureReservationStatusExistingMatchingUsageInfo; /** * This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. */ @@ -4916,6 +5038,19 @@ export namespace compute_alpha { procurementStatus?: string | null; specificSkuProperties?: Schema$FutureReservationStatusSpecificSKUProperties; } + /** + * [Output Only] Represents the existing matching usage for the future reservation. + */ + export interface Schema$FutureReservationStatusExistingMatchingUsageInfo { + /** + * Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances) + */ + count?: string | null; + /** + * Timestamp when the matching usage was calculated + */ + timestamp?: string | null; + } /** * The state that the future reservation will be reverted to should the amendment be declined. */ @@ -4924,6 +5059,10 @@ export namespace compute_alpha { * [Output Only] The description of the FutureReservation before an amendment was requested. */ description?: string | null; + /** + * [Output Only] Represents the matching usage for the future reservation before an amendment was requested. + */ + existingMatchingUsageInfo?: Schema$FutureReservationStatusExistingMatchingUsageInfo; futureReservationSpecs?: Schema$FutureReservationStatusLastKnownGoodStateFutureReservationSpecs; /** * [Output Only] The lock time of the FutureReservation before an amendment was requested. @@ -6814,7 +6953,7 @@ export namespace compute_alpha { */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57\})|([-a-z0-9]{0,51\}-#{1,10\}(\\[[0-9]{1,10\}\\])?)) */ baseInstanceName?: string | null; /** @@ -6885,6 +7024,10 @@ export namespace compute_alpha { * [Output Only] The URL of the region where the managed instance group resides (for regional resources). */ region?: string | null; + /** + * Resource policies for this managed instance group. + */ + resourcePolicies?: Schema$InstanceGroupManagerResourcePolicies; /** * [Output Only] Reserved for future use. */ @@ -6925,6 +7068,10 @@ export namespace compute_alpha { * The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. */ targetSize?: number | null; + /** + * Configures how target size of MIG is achieved. + */ + targetSizePolicy?: Schema$InstanceGroupManagerTargetSizePolicy; /** * The unit of measure for the target size. */ @@ -7216,12 +7363,16 @@ export namespace compute_alpha { * This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible. */ queuingPolicy?: Schema$QueuingPolicy; + /** + * [Output Only] The URL of a region where the resize request is located. Populated only for regional resize requests. + */ + region?: string | null; /** * Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted. */ requestedRunDuration?: Schema$Duration; /** - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. */ resizeBy?: number | null; /** @@ -7322,6 +7473,12 @@ export namespace compute_alpha { }>; } | null; } + export interface Schema$InstanceGroupManagerResourcePolicies { + /** + * The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + */ + workloadPolicy?: string | null; + } export interface Schema$InstanceGroupManagersAbandonInstancesRequest { /** * The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. @@ -7532,6 +7689,10 @@ export namespace compute_alpha { * [Output Only] The URL of the Autoscaler that targets this instance group manager. */ autoscaler?: string | null; + /** + * [Output Only] Status of bulk instance operation. + */ + bulkInstanceOperation?: Schema$InstanceGroupManagerStatusBulkInstanceOperation; /** * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ @@ -7555,6 +7716,38 @@ export namespace compute_alpha { */ effective?: boolean | null; } + export interface Schema$InstanceGroupManagerStatusBulkInstanceOperation { + /** + * [Output Only] Informs whether bulk instance operation is in progress. + */ + inProgress?: boolean | null; + /** + * [Output Only] Information from last progress check of bulk instance operation. + */ + lastProgressCheck?: Schema$InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck; + } + export interface Schema$InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck { + /** + * [Output Only] Contains errors encountered during bulk instance operation. + */ + error?: { + errors?: Array<{ + code?: string; + errorDetails?: Array<{ + errorInfo?: Schema$ErrorInfo; + help?: Schema$Help; + localizedMessage?: Schema$LocalizedMessage; + quotaInfo?: Schema$QuotaExceededInfo; + }>; + location?: string; + message?: string; + }>; + } | null; + /** + * [Output Only] Timestamp of the last progress check of bulk instance operation. Timestamp is in RFC3339 text format. + */ + timestamp?: string | null; + } export interface Schema$InstanceGroupManagerStatusStateful { /** * [Output Only] A bit indicating whether the managed instance group has stateful configuration, that is, if you have configured any items in a stateful policy or in per-instance configs. The group might report that it has no stateful configuration even when there is still some preserved state on a managed instance, for example, if you have deleted all PICs but not yet applied those deletions. @@ -7590,6 +7783,12 @@ export namespace compute_alpha { */ perInstanceConfigs?: Schema$PerInstanceConfig[]; } + export interface Schema$InstanceGroupManagerTargetSizePolicy { + /** + * Mode in which operations on size are processed. + */ + mode?: string | null; + } export interface Schema$InstanceGroupManagerUpdatePolicy { /** * The instance redistribution policy for regional managed instance groups. Valid values are: - PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. - NONE: For non-autoscaled groups, proactive redistribution is disabled. @@ -8384,6 +8583,14 @@ export namespace compute_alpha { * [Output Only] The ID value of the disk used to create this InstantSnapshot. This value may be used to determine whether the InstantSnapshot was taken from the current or a previous instance of a given disk name. */ sourceDiskId?: string | null; + /** + * [Output Only] URL of the source instant snapshot this instant snapshot is part of. Note that the source instant snapshot group must be in the same zone/region as the instant snapshot to be created. This can be a full or valid partial URL. + */ + sourceInstantSnapshotGroup?: string | null; + /** + * [Output Only] The ID value of the source instant snapshot group this InstantSnapshot is part of. This value may be used to determine whether the InstantSnapshot was created as part of an InstantSnapshotGroup creation. + */ + sourceInstantSnapshotGroupId?: string | null; /** * [Output Only] The status of the instantSnapshot. This can be CREATING, DELETING, FAILED, or READY. */ @@ -8427,6 +8634,67 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Represents an InstantSnapshotGroup resource. An instant snapshot group is a set of instant snapshots that represents a point in time state of a consistency group. + */ + export interface Schema$InstantSnapshotGroup { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * Optional. An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources. + */ + kind?: string | null; + /** + * Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + resourceStatus?: Schema$InstantSnapshotGroupResourceStatus; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource's resource id. + */ + selfLinkWithId?: string | null; + sourceConsistencyGroup?: string | null; + /** + * [Output Only] + */ + status?: string | null; + /** + * [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + zone?: string | null; + } + export interface Schema$InstantSnapshotGroupResourceStatus { + /** + * [Output Only] + */ + consistencyMembershipResolutionTime?: string | null; + /** + * [Output Only] + */ + sourceInfo?: Schema$InstantSnapshotGroupSourceInfo; + } + export interface Schema$InstantSnapshotGroupSourceInfo { + consistencyGroup?: string | null; + consistencyGroupId?: string | null; + } /** * Contains a list of InstantSnapshot resources. */ @@ -9787,6 +10055,44 @@ export namespace compute_alpha { message?: string; } | null; } + /** + * Contains a list of InstantSnapshotGroup resources. + */ + export interface Schema$ListInstantSnapshotGroups { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of InstantSnapshotGroup resources. + */ + items?: Schema$InstantSnapshotGroup[]; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$LocalDisk { /** * Specifies the number of such disks. @@ -10400,118 +10706,6 @@ export namespace compute_alpha { */ units?: string | null; } - /** - * MultiMIG represents a group of Managed Instance Groups. - */ - export interface Schema$MultiMig { - /** - * [Output Only] Creation timestamp in RFC3339 text format. - */ - creationTimestamp?: string | null; - /** - * An optional description of this resource. Provide this property when you create the resource. - */ - description?: string | null; - /** - * [Output Only] The unique identifier for the resource. This identifier is defined by the server. - */ - id?: string | null; - /** - * [Output Only] Type of the resource. Always compute#multiMig for MultiMIGs. - */ - kind?: string | null; - locationPolicy?: Schema$MultiMigLocationPolicy; - /** - * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - */ - name?: string | null; - /** - * User-provided names for Parts of MultiMIG and the Parts themselves. - */ - parts?: {[key: string]: Schema$MultiMigPart} | null; - /** - * [Output Only] URL of the region where the resource resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - */ - region?: string | null; - /** - * Policy for handling provisioning and other scheduling-related events. - */ - schedulingPolicy?: Schema$MultiMigSchedulingPolicy; - /** - * [Output only] Server-defined URL for the resource. - */ - selfLink?: string | null; - /** - * [Output Only] Server-defined URL for this resource with the resource id. - */ - selfLinkWithId?: string | null; - } - /** - * Policy regarding where to create MIGs Initially only zonal MIGs in the same zone are supported. - */ - export interface Schema$MultiMigLocationPolicy { - /** - * List of zones where MIGs will be provisioned. Should be valid RFC1035 name - */ - provisioningZones?: string[] | null; - } - /** - * Config for an MMIG part. - */ - export interface Schema$MultiMigPart { - /** - * Link to an existing InstanceGroupManager that will be adopted by a MultiMIG. - */ - instanceGroupManager?: string | null; - /** - * InstanceGroupManager to be created by the multiMig - */ - instanceGroupManagerProperties?: Schema$InstanceGroupManager; - } - /** - * Policy for handling provisioning and other scheduling-related events. - */ - export interface Schema$MultiMigSchedulingPolicy { - /** - * How provisioning of MIGs should be scheduled (coordinated or not) - */ - provisioning?: string | null; - } - export interface Schema$MultiMigsList { - etag?: string | null; - /** - * Unique identifier for the resource; defined by the server. - */ - id?: string | null; - /** - * A list of MultiMig resources. - */ - items?: Schema$MultiMig[]; - /** - * Type of resource. - */ - kind?: string | null; - /** - * This token allows you to get the next page of results for maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. - */ - nextPageToken?: string | null; - /** - * [Output only] Server-defined URL for this resource. - */ - selfLink?: string | null; - /** - * [Output only] Unreachable resources. - */ - unreachables?: string[] | null; - /** - * Informational warning message. - */ - warning?: { - code?: string; - data?: Array<{key?: string; value?: string}>; - message?: string; - } | null; - } /** * [Deprecated] Configuration for the mutual Tls mode for peer authentication. Configuration for the mutual Tls mode for peer authentication. */ @@ -10951,10 +11145,6 @@ export namespace compute_alpha { * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. */ clientDestinationPort?: number | null; - /** - * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. - */ - clientPort?: number | null; /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. */ @@ -10992,10 +11182,6 @@ export namespace compute_alpha { * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ appEngine?: Schema$NetworkEndpointGroupAppEngine; - /** - * Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. - */ - clientPortMappingMode?: string | null; /** * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ @@ -15060,6 +15246,7 @@ export namespace compute_alpha { * Resource policy applicable to VMs for infrastructure maintenance. */ vmMaintenancePolicy?: Schema$ResourcePolicyVmMaintenancePolicy; + workloadPolicy?: Schema$ResourcePolicyWorkloadPolicy; } /** * Contains a list of resourcePolicies. @@ -15356,6 +15543,12 @@ export namespace compute_alpha { */ startTime?: string | null; } + /** + * Represents the workload policy. + */ + export interface Schema$ResourcePolicyWorkloadPolicy { + type?: string | null; + } /** * Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. */ @@ -15389,7 +15582,7 @@ export namespace compute_alpha { } export interface Schema$ResourceStatusScheduling { /** - * Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. */ availabilityDomain?: number | null; /** @@ -16044,6 +16237,10 @@ export namespace compute_alpha { * Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035. */ name?: string | null; + /** + * List of Subnetwork resources whose traffic should be translated by NAT64 Gateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is selected for the SubnetworkIpRangeToNat64Option above. + */ + nat64Subnetworks?: Schema$RouterNatSubnetworkToNat64[]; /** * Specify the NatIpAllocateOption, which can take one of the following values: - MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty. */ @@ -16060,6 +16257,10 @@ export namespace compute_alpha { * Specify the Nat option, which can take one of the following values: - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there should not be any other Router.Nat section in any Router for this network in this region. */ sourceSubnetworkIpRangesToNat?: string | null; + /** + * Specify the Nat option for NAT64, which can take one of the following values: - ALL_IPV6_SUBNETWORKS: All of the IP ranges in every Subnetwork are allowed to Nat. - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field nat64_subnetwork below) The default is NAT64_OPTION_UNSPECIFIED. Note that if this field contains NAT64_ALL_V6_SUBNETWORKS no other Router.Nat section in this region can also enable NAT64 for any Subnetworks in this network. Other Router.Nat sections can still be present to enable NAT44 only. + */ + sourceSubnetworkIpRangesToNat64?: string | null; /** * A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above. */ @@ -16151,6 +16352,15 @@ export namespace compute_alpha { */ sourceIpRangesToNat?: string[] | null; } + /** + * Specifies a subnetwork to enable NAT64. + */ + export interface Schema$RouterNatSubnetworkToNat64 { + /** + * URL for the subnetwork resource that will use NAT64. + */ + name?: string | null; + } export interface Schema$RoutersGetNamedSetResponse { /** * end_interface: MixerGetResponseWithEtagBuilder @@ -16608,7 +16818,7 @@ export namespace compute_alpha { */ automaticRestart?: boolean | null; /** - * Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. */ availabilityDomain?: number | null; /** @@ -16677,10 +16887,6 @@ export namespace compute_alpha { * Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. */ terminationTime?: string | null; - /** - * Represents the Windows Server License Optimization Mode of the VM. If unspecified, the default mode is `OFF`. - */ - windowsLicenseOptimizationMode?: string | null; } /** * Configuration for gracefully shutting down the instance. @@ -19816,7 +20022,7 @@ export namespace compute_alpha { */ authorizationPolicy?: string | null; /** - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project \}/locations/{location\}/certificateMaps/{resourceName\}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project \}/locations/{location\}/certificateMaps/{resourceName\}. */ certificateMap?: string | null; /** @@ -19876,7 +20082,7 @@ export namespace compute_alpha { */ serverTlsPolicy?: string | null; /** - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project\}/locations/{ location\}/certificates/{resourceName\}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project \}/locations/{location\}/certificates/{resourceName\}. */ sslCertificates?: string[] | null; /** @@ -20871,7 +21077,7 @@ export namespace compute_alpha { */ defaultRouteAction?: Schema$HttpRouteAction; /** - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. */ defaultService?: string | null; /** @@ -21365,7 +21571,7 @@ export namespace compute_alpha { */ selfLink?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. */ stackType?: string | null; /** @@ -21572,7 +21778,7 @@ export namespace compute_alpha { */ labels?: {[key: string]: string} | null; /** - * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. */ localTrafficSelector?: string[] | null; /** @@ -21592,7 +21798,7 @@ export namespace compute_alpha { */ peerGcpGateway?: string | null; /** - * IP address of the peer VPN gateway. Only IPv4 is supported. + * IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. */ peerIp?: string | null; /** @@ -21600,7 +21806,7 @@ export namespace compute_alpha { */ region?: string | null; /** - * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. */ remoteTrafficSelector?: string[] | null; /** @@ -21624,7 +21830,7 @@ export namespace compute_alpha { */ status?: string | null; /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. */ targetVpnGateway?: string | null; /** @@ -24711,6 +24917,101 @@ export namespace compute_alpha { } } + /** + * Retrieves a list of all usable backend buckets in the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listUsable( + params: Params$Resource$Backendbuckets$Listusable, + options: StreamMethodOptions + ): GaxiosPromise; + listUsable( + params?: Params$Resource$Backendbuckets$Listusable, + options?: MethodOptions + ): GaxiosPromise; + listUsable( + params: Params$Resource$Backendbuckets$Listusable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Backendbuckets$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Backendbuckets$Listusable, + callback: BodyResponseCallback + ): void; + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( + paramsOrCallback?: + | Params$Resource$Backendbuckets$Listusable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendbuckets$Listusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendbuckets$Listusable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/global/backendBuckets/listUsable' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @@ -25284,6 +25585,33 @@ export namespace compute_alpha { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Backendbuckets$Listusable + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } export interface Params$Resource$Backendbuckets$Patch extends StandardParameters { /** @@ -38270,7 +38598,7 @@ export namespace compute_alpha { export interface Params$Resource$Globaloperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -38281,7 +38609,7 @@ export namespace compute_alpha { export interface Params$Resource$Globaloperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -38319,7 +38647,7 @@ export namespace compute_alpha { export interface Params$Resource$Globaloperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -38597,7 +38925,7 @@ export namespace compute_alpha { export interface Params$Resource$Globalorganizationoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -38608,7 +38936,7 @@ export namespace compute_alpha { export interface Params$Resource$Globalorganizationoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -55210,111 +55538,14 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Instantsnapshots { + export class Resource$Instantsnapshotgroups { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: StreamMethodOptions - ): GaxiosPromise; - aggregatedList( - params?: Params$Resource$Instantsnapshots$Aggregatedlist, - options?: MethodOptions - ): GaxiosPromise; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Instantsnapshots$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Instantsnapshots$Aggregatedlist - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/aggregated/instantSnapshots' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. + * deletes a Zonal InstantSnapshotGroup resource * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -55322,31 +55553,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Instantsnapshots$Delete, + params?: Params$Resource$Instantsnapshotgroups$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Instantsnapshots$Delete, + params: Params$Resource$Instantsnapshotgroups$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Delete + | Params$Resource$Instantsnapshotgroups$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -55359,12 +55590,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Delete; + {}) as Params$Resource$Instantsnapshotgroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Delete; + params = {} as Params$Resource$Instantsnapshotgroups$Delete; options = {}; } @@ -55379,7 +55610,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -55387,8 +55618,8 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'zone'], + requiredParams: ['project', 'zone', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'zone'], context: this.context, }; if (callback) { @@ -55402,7 +55633,7 @@ export namespace compute_alpha { } /** - * Returns the specified InstantSnapshot resource in the specified zone. + * returns the specified InstantSnapshotGroup resource in the specified zone. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -55410,137 +55641,54 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Instantsnapshots$Get, + params: Params$Resource$Instantsnapshotgroups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Instantsnapshots$Get, + params?: Params$Resource$Instantsnapshotgroups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Instantsnapshots$Get, + params: Params$Resource$Instantsnapshotgroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Instantsnapshots$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Instantsnapshotgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Instantsnapshots$Get, - callback: BodyResponseCallback + params: Params$Resource$Instantsnapshotgroups$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'instantSnapshot'], - pathParams: ['instantSnapshot', 'project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. May be empty if no such policy or resource exists. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Instantsnapshots$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Instantsnapshots$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Instantsnapshots$Getiampolicy - | BodyResponseCallback + | Params$Resource$Instantsnapshotgroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Getiampolicy; + {}) as Params$Resource$Instantsnapshotgroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Getiampolicy; + params = {} as Params$Resource$Instantsnapshotgroups$Get; options = {}; } @@ -55555,7 +55703,7 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy' + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -55563,22 +55711,22 @@ export namespace compute_alpha { options ), params, - requiredParams: ['project', 'zone', 'resource'], - pathParams: ['project', 'resource', 'zone'], + requiredParams: ['project', 'zone', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'zone'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates an instant snapshot in the specified zone. + * inserts a Zonal InstantSnapshotGroup resource * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -55586,31 +55734,31 @@ export namespace compute_alpha { * @returns A promise if used with async/await, or void if used with a callback. */ insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, options: StreamMethodOptions ): GaxiosPromise; insert( - params?: Params$Resource$Instantsnapshots$Insert, + params?: Params$Resource$Instantsnapshotgroups$Insert, options?: MethodOptions ): GaxiosPromise; insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; insert( - params: Params$Resource$Instantsnapshots$Insert, + params: Params$Resource$Instantsnapshotgroups$Insert, callback: BodyResponseCallback ): void; insert(callback: BodyResponseCallback): void; insert( paramsOrCallback?: - | Params$Resource$Instantsnapshots$Insert + | Params$Resource$Instantsnapshotgroups$Insert | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -55623,12 +55771,12 @@ export namespace compute_alpha { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instantsnapshots$Insert; + {}) as Params$Resource$Instantsnapshotgroups$Insert; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instantsnapshots$Insert; + params = {} as Params$Resource$Instantsnapshotgroups$Insert; options = {}; } @@ -55643,7 +55791,648 @@ export namespace compute_alpha { { url: ( rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * retrieves the list of InstantSnapshotGroup resources contained within the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Instantsnapshotgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshotgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Instantsnapshotgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Instantsnapshotgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshotgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshotgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Instantsnapshotgroups$Delete + extends StandardParameters { + /** + * Name of the InstantSnapshot resource to delete. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instantsnapshotgroups$Get + extends StandardParameters { + /** + * Name of the InstantSnapshotGroup resource to return. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Instantsnapshotgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * begin_interface: MixerMutationRequestBuilder + */ + sourceConsistencyGroup?: string; + /** + * Name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantSnapshotGroup; + } + export interface Params$Resource$Instantsnapshotgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Instantsnapshots { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of instantSnapshots. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Instantsnapshots$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Instantsnapshots$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/aggregated/instantSnapshots' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the specified InstantSnapshot resource. Keep in mind that deleting a single instantSnapshot might not necessarily delete all the data on that instantSnapshot. If any data on the instantSnapshot that is marked for deletion is needed for subsequent instantSnapshots, the data will be moved to the next corresponding instantSnapshot. For more information, see Deleting instantSnapshots. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Instantsnapshots$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshots$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Instantsnapshots$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns the specified InstantSnapshot resource in the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Instantsnapshots$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Instantsnapshots$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Instantsnapshots$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshots$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Instantsnapshots$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instantSnapshot'], + pathParams: ['instantSnapshot', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. May be empty if no such policy or resource exists. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Instantsnapshots$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Instantsnapshots$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'resource'], + pathParams: ['project', 'resource', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates an instant snapshot in the specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Instantsnapshots$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshots$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Instantsnapshots$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Instantsnapshots$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instantsnapshots$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instantsnapshots$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instantSnapshots' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -84356,6 +85145,254 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Regioninstancegroupmanagerresizerequests { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns all of the details about the specified resize request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [ + 'project', + 'region', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'region', + 'resizeRequest', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstancegroupmanagerresizerequests$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagerresizerequests$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Get + extends StandardParameters { + /** + * The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * The name of the resize request. Name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + } + export interface Params$Resource$Regioninstancegroupmanagerresizerequests$Insert + extends StandardParameters { + /** + * Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. Name should conform to RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagerResizeRequest; + } + export class Resource$Regioninstancegroupmanagers { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -88647,6 +89684,467 @@ export namespace compute_alpha { view?: string; } + export class Resource$Regioninstantsnapshotgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * deletes a Regional InstantSnapshotGroup resource + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Regioninstantsnapshotgroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regioninstantsnapshotgroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * returns the specified InstantSnapshotGroup resource in the specified region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Regioninstantsnapshotgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regioninstantsnapshotgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instantSnapshotGroup'], + pathParams: ['instantSnapshotGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * creates a Regional InstantSnapshotGroup resource + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Regioninstantsnapshotgroups$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regioninstantsnapshotgroups$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * retrieves the list of InstantSnapshotGroup resources contained within the specified region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Regioninstantsnapshotgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regioninstantsnapshotgroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Regioninstantsnapshotgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstantsnapshotgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstantsnapshotgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/instantSnapshotGroups' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regioninstantsnapshotgroups$Delete + extends StandardParameters { + /** + * Name of the InstantSnapshotGroup resource to delete. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regioninstantsnapshotgroups$Get + extends StandardParameters { + /** + * Name of the InstantSnapshotGroup resource to return. + */ + instantSnapshotGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Regioninstantsnapshotgroups$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region for this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * begin_interface: MixerMutationRequestBuilder + */ + sourceConsistencyGroup?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstantSnapshotGroup; + } + export interface Params$Resource$Regioninstantsnapshotgroups$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + } + export class Resource$Regioninstantsnapshots { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -89538,451 +91036,6 @@ export namespace compute_alpha { requestBody?: Schema$TestPermissionsRequest; } - export class Resource$Regionmultimigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Deletes a regional multiMIG in the specified project. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Regionmultimigs$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Regionmultimigs$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Regionmultimigs$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Regionmultimigs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Regionmultimigs$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Regionmultimigs$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'multiMig'], - pathParams: ['multiMig', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns the specified MultiMIG resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Regionmultimigs$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Regionmultimigs$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Regionmultimigs$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regionmultimigs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Regionmultimigs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Regionmultimigs$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs/{multiMig}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region', 'multiMig'], - pathParams: ['multiMig', 'project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Creates a regional multiMIG in the specified project. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - insert( - params: Params$Resource$Regionmultimigs$Insert, - options: StreamMethodOptions - ): GaxiosPromise; - insert( - params?: Params$Resource$Regionmultimigs$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Regionmultimigs$Insert, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Regionmultimigs$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Regionmultimigs$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Regionmultimigs$Insert - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Retrieves a list of MultiMIGs in a project and region. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Regionmultimigs$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Regionmultimigs$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Regionmultimigs$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionmultimigs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Regionmultimigs$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Regionmultimigs$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Regionmultimigs$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Regionmultimigs$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/regions/{region}/multiMigs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['project', 'region'], - pathParams: ['project', 'region'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Regionmultimigs$Delete - extends StandardParameters { - /** - * Name of the multiMIG to delete. - */ - multiMig?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Regionmultimigs$Get - extends StandardParameters { - /** - * Name of the MultiMig resource to return. - */ - multiMig?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - } - export interface Params$Resource$Regionmultimigs$Insert - extends StandardParameters { - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$MultiMig; - } - export interface Params$Resource$Regionmultimigs$List - extends StandardParameters { - /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. - */ - filter?: string; - /** - * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) - */ - maxResults?: number; - /** - * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. - */ - orderBy?: string; - /** - * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * Name of the region for this request. - */ - region?: string; - /** - * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. - */ - returnPartialSuccess?: boolean; - } - export class Resource$Regionnetworkendpointgroups { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -93900,7 +94953,7 @@ export namespace compute_alpha { export interface Params$Resource$Regionoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -93915,7 +94968,7 @@ export namespace compute_alpha { export interface Params$Resource$Regionoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -93961,7 +95014,7 @@ export namespace compute_alpha { export interface Params$Resource$Regionoperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -93981,7 +95034,7 @@ export namespace compute_alpha { } /** - * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -125657,7 +126710,7 @@ export namespace compute_alpha { export interface Params$Resource$Zoneoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -125672,7 +126725,7 @@ export namespace compute_alpha { export interface Params$Resource$Zoneoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -125718,7 +126771,7 @@ export namespace compute_alpha { export interface Params$Resource$Zoneoperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 3b6366009f..75185d32ca 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -743,6 +743,10 @@ export namespace compute_beta { * The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed. */ threadsPerCore?: number | null; + /** + * Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode. + */ + turboMode?: string | null; /** * The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance's nominal CPU count and the underlying platform's SMT width. */ @@ -798,6 +802,12 @@ export namespace compute_beta { */ acceleratorType?: string | null; } + export interface Schema$AllocationReservationSharingPolicy { + /** + * Sharing config for all Google Cloud services. + */ + serviceShareType?: string | null; + } /** * [Output Only] Contains output only fields. */ @@ -815,6 +825,10 @@ export namespace compute_beta { * ID of the instance template used to populate reservation properties. */ sourceInstanceTemplateId?: string | null; + /** + * Per service utilization breakdown. The Key is the Google Cloud managed service name. + */ + utilizations?: {[key: string]: string} | null; } export interface Schema$AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk { /** @@ -1699,6 +1713,14 @@ export namespace compute_beta { * If true, enables Cloud CDN for the backend service of a global external Application Load Balancer. */ enableCDN?: boolean | null; + /** + * Specifies the canary migration state. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using externalManagedMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + */ + externalManagedMigrationState?: string | null; + /** + * Determines the fraction of requests that should be processed by the Global external Application Load Balancer. The value of this field must be in the range [0, 100]. Session affinity options will slightly affect this routing behavior, for more details, see: Session Affinity. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. + */ + externalManagedMigrationTestingPercentage?: number | null; /** * Requires at least one backend instance group to be defined as a backup (failover) backend. For load balancers that have configurable failover: [Internal passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external passthrough Network Load Balancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). */ @@ -1736,7 +1758,7 @@ export namespace compute_beta { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. */ localityLbPolicy?: string | null; /** @@ -1803,11 +1825,18 @@ export namespace compute_beta { * Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). */ sessionAffinity?: string | null; + /** + * Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + */ + strongSessionAffinityCookie?: Schema$BackendServiceHttpCookie; subsetting?: Schema$Subsetting; /** * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. */ timeoutSec?: number | null; + /** + * [Output Only] List of resources referencing given backend service. + */ usedBy?: Schema$BackendServiceUsedBy[]; } /** @@ -1974,6 +2003,23 @@ export namespace compute_beta { */ kind?: string | null; } + /** + * The HTTP cookie used for stateful session affinity. + */ + export interface Schema$BackendServiceHttpCookie { + /** + * Name of the cookie. + */ + name?: string | null; + /** + * Path to set for the cookie. + */ + path?: string | null; + /** + * Lifetime of the cookie. + */ + ttl?: Schema$Duration; + } /** * Identity-Aware Proxy */ @@ -2129,6 +2175,9 @@ export namespace compute_beta { } | null; } export interface Schema$BackendServiceUsedBy { + /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + */ reference?: string | null; } export interface Schema$BfdPacket { @@ -3822,6 +3871,10 @@ export namespace compute_beta { * Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. */ name?: string | null; + /** + * A list of packet mirroring rules that belong to this policy. + */ + packetMirroringRules?: Schema$FirewallPolicyRule[]; /** * [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. */ @@ -3904,7 +3957,7 @@ export namespace compute_beta { */ export interface Schema$FirewallPolicyRule { /** - * The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + * The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". */ action?: string | null; /** @@ -3924,7 +3977,7 @@ export namespace compute_beta { */ enableLogging?: boolean | null; /** - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. */ kind?: string | null; /** @@ -3932,7 +3985,7 @@ export namespace compute_beta { */ match?: Schema$FirewallPolicyRuleMatcher; /** - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. */ priority?: number | null; /** @@ -3944,7 +3997,7 @@ export namespace compute_beta { */ ruleTupleCount?: number | null; /** - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. */ securityProfileGroup?: string | null; /** @@ -4090,6 +4143,14 @@ export namespace compute_beta { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Specifies the canary migration state for the backend buckets attached to this forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC. To begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be changed to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before the loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets attached to this forwarding rule by percentage using externalManagedBackendBucketMigrationTestingPercentage. Rolling back a migration requires the states to be set in reverse order. So changing the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to be set to TEST_ALL_TRAFFIC at the same time. Optionally, the TEST_BY_PERCENTAGE state can be used to migrate some traffic back to EXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL. + */ + externalManagedBackendBucketMigrationState?: string | null; + /** + * Determines the fraction of requests to backend buckets that should be processed by the global external Application Load Balancer. The value of this field must be in the range [0, 100]. This value can only be set if the loadBalancingScheme in the BackendService is set to EXTERNAL (when using the classic Application Load Balancer) and the migration state is TEST_BY_PERCENTAGE. + */ + externalManagedBackendBucketMigrationTestingPercentage?: number | null; /** * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. */ @@ -4354,6 +4415,10 @@ export namespace compute_beta { * List of Projects/Folders to share with. */ shareSettings?: Schema$ShareSettings; + /** + * Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. + */ + specificReservationRequired?: boolean | null; /** * Future Reservation configuration to indicate instance properties and total count. */ @@ -4484,6 +4549,10 @@ export namespace compute_beta { * Fully qualified urls of the automatically created reservations at start_time. */ autoCreatedReservations?: string[] | null; + /** + * [Output Only] Represents the existing matching usage for the future reservation. + */ + existingMatchingUsageInfo?: Schema$FutureReservationStatusExistingMatchingUsageInfo; /** * This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. */ @@ -4502,6 +4571,19 @@ export namespace compute_beta { procurementStatus?: string | null; specificSkuProperties?: Schema$FutureReservationStatusSpecificSKUProperties; } + /** + * [Output Only] Represents the existing matching usage for the future reservation. + */ + export interface Schema$FutureReservationStatusExistingMatchingUsageInfo { + /** + * Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances) + */ + count?: string | null; + /** + * Timestamp when the matching usage was calculated + */ + timestamp?: string | null; + } /** * The state that the future reservation will be reverted to should the amendment be declined. */ @@ -4510,6 +4592,10 @@ export namespace compute_beta { * [Output Only] The description of the FutureReservation before an amendment was requested. */ description?: string | null; + /** + * [Output Only] Represents the matching usage for the future reservation before an amendment was requested. + */ + existingMatchingUsageInfo?: Schema$FutureReservationStatusExistingMatchingUsageInfo; futureReservationSpecs?: Schema$FutureReservationStatusLastKnownGoodStateFutureReservationSpecs; /** * [Output Only] The lock time of the FutureReservation before an amendment was requested. @@ -6252,7 +6338,7 @@ export namespace compute_beta { */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57\})|([-a-z0-9]{0,51\}-#{1,10\}(\\[[0-9]{1,10\}\\])?)) */ baseInstanceName?: string | null; /** @@ -6485,14 +6571,6 @@ export namespace compute_beta { initialDelaySec?: number | null; } export interface Schema$InstanceGroupManagerInstanceFlexibilityPolicy { - /** - * Named instance selections configuring properties that the group will use when creating new VMs. - */ - instanceSelectionLists?: { - [ - key: string - ]: Schema$InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection; - } | null; /** * Named instance selections configuring properties that the group will use when creating new VMs. */ @@ -6611,7 +6689,7 @@ export namespace compute_beta { */ requestedRunDuration?: Schema$Duration; /** - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. */ resizeBy?: number | null; /** @@ -7400,6 +7478,10 @@ export namespace compute_beta { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * The rules that apply to the network. */ @@ -9173,6 +9255,10 @@ export namespace compute_beta { guestAcceleratorCount?: number; guestAcceleratorType?: string; }> | null; + /** + * [Output Only] The architecture of the machine type. + */ + architecture?: string | null; /** * [Output Only] The configuration of bundled local SSD for the machine type. */ @@ -9331,10 +9417,6 @@ export namespace compute_beta { * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ instance?: string | null; - /** - * [Output Only] The overrides to instance properties resulting from InstanceFlexibilityPolicy. - */ - instanceFlexibilityOverride?: Schema$ManagedInstanceInstanceFlexibilityOverride; /** * [Output Only] Health state of the instance per health-check. */ @@ -9378,12 +9460,6 @@ export namespace compute_beta { */ revision?: string | null; } - export interface Schema$ManagedInstanceInstanceFlexibilityOverride { - /** - * The machine type to be used for this instance. - */ - machineType?: string | null; - } export interface Schema$ManagedInstanceInstanceHealth { /** * [Output Only] The current detailed instance health state. @@ -9875,10 +9951,6 @@ export namespace compute_beta { * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. */ clientDestinationPort?: number | null; - /** - * Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. - */ - clientPort?: number | null; /** * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. */ @@ -9912,10 +9984,6 @@ export namespace compute_beta { * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ appEngine?: Schema$NetworkEndpointGroupAppEngine; - /** - * Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. - */ - clientPortMappingMode?: string | null; /** * Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. */ @@ -10397,6 +10465,18 @@ export namespace compute_beta { * A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. */ export interface Schema$NetworkRoutingConfig { + /** + * Enable comparison of Multi-Exit Discriminators (MED) across routes with different neighbor ASNs when using the STANDARD BGP best path selection algorithm. + */ + bgpAlwaysCompareMed?: boolean | null; + /** + * The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD. + */ + bgpBestPathSelectionMode?: string | null; + /** + * Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED. + */ + bgpInterRegionCost?: string | null; /** * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ @@ -10443,6 +10523,10 @@ export namespace compute_beta { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * The rules that apply to the network. */ @@ -12843,6 +12927,10 @@ export namespace compute_beta { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * The rules that apply to the network. */ @@ -12937,6 +13025,10 @@ export namespace compute_beta { * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. + */ + reservationSharingPolicy?: Schema$AllocationReservationSharingPolicy; /** * Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. */ @@ -13449,6 +13541,10 @@ export namespace compute_beta { upcomingMaintenance?: Schema$UpcomingMaintenance; } export interface Schema$ResourceStatusScheduling { + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + */ + availabilityDomain?: number | null; /** * Time in future when the instance will be terminated in RFC3339 text format. */ @@ -13523,14 +13619,26 @@ export namespace compute_beta { * [Output Only] The URL to an InterconnectAttachment which is the next hop for the route. This field will only be populated for the dynamic routes generated by Cloud Router with a linked interconnectAttachment. */ nextHopInterconnectAttachment?: string | null; + /** + * [Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions. + */ + nextHopInterRegionCost?: number | null; /** * The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. */ nextHopIp?: string | null; + /** + * [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network. + */ + nextHopMed?: number | null; /** * The URL of the local network if it should handle matching packets. */ nextHopNetwork?: string | null; + /** + * [Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. + */ + nextHopOrigin?: string | null; /** * [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. */ @@ -14538,6 +14646,10 @@ export namespace compute_beta { * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. */ automaticRestart?: boolean | null; + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + */ + availabilityDomain?: number | null; /** * Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. */ @@ -17393,7 +17505,7 @@ export namespace compute_beta { */ authorizationPolicy?: string | null; /** - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project \}/locations/{location\}/certificateMaps/{resourceName\}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project \}/locations/{location\}/certificateMaps/{resourceName\}. */ certificateMap?: string | null; /** @@ -17449,7 +17561,7 @@ export namespace compute_beta { */ serverTlsPolicy?: string | null; /** - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project\}/locations/{ location\}/certificates/{resourceName\}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project \}/locations/{location\}/certificates/{resourceName\}. */ sslCertificates?: string[] | null; /** @@ -18339,7 +18451,7 @@ export namespace compute_beta { */ defaultRouteAction?: Schema$HttpRouteAction; /** - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. */ defaultService?: string | null; /** @@ -18817,7 +18929,7 @@ export namespace compute_beta { */ selfLink?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. */ stackType?: string | null; /** @@ -19024,7 +19136,7 @@ export namespace compute_beta { */ labels?: {[key: string]: string} | null; /** - * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. + * Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. */ localTrafficSelector?: string[] | null; /** @@ -19044,7 +19156,7 @@ export namespace compute_beta { */ peerGcpGateway?: string | null; /** - * IP address of the peer VPN gateway. Only IPv4 is supported. + * IP address of the peer VPN gateway. Only IPv4 is supported. This field can be set only for Classic VPN tunnels. */ peerIp?: string | null; /** @@ -19052,7 +19164,7 @@ export namespace compute_beta { */ region?: string | null; /** - * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. + * Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported for Classic VPN tunnels. This field is output only for HA VPN tunnels. */ remoteTrafficSelector?: string[] | null; /** @@ -19076,7 +19188,7 @@ export namespace compute_beta { */ status?: string | null; /** - * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. + * URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This field can be set only for Classic VPN tunnels. */ targetVpnGateway?: string | null; /** @@ -27707,6 +27819,96 @@ export namespace compute_beta { } } + /** + * Inserts a packet mirroring rule into a firewall policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Addpacketmirroringrule, + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Addpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Addpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewallpolicies$Addpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Inserts a rule into a firewall policy. * @@ -28242,6 +28444,99 @@ export namespace compute_beta { } } + /** + * Gets a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Getpacketmirroringrule, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Getpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Getpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewallpolicies$Getpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a rule of the specified priority. * @@ -28784,39 +29079,41 @@ export namespace compute_beta { } /** - * Patches a rule of the specified priority. + * Patches a packet mirroring rule of the specified priority. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patchRule( - params: Params$Resource$Firewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, options: StreamMethodOptions ): GaxiosPromise; - patchRule( - params?: Params$Resource$Firewallpolicies$Patchrule, + patchPacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, options?: MethodOptions ): GaxiosPromise; - patchRule( - params: Params$Resource$Firewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Firewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patchRule( - params: Params$Resource$Firewallpolicies$Patchrule, + patchPacketMirroringRule( + params: Params$Resource$Firewallpolicies$Patchpacketmirroringrule, callback: BodyResponseCallback ): void; - patchRule(callback: BodyResponseCallback): void; - patchRule( + patchPacketMirroringRule( + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( paramsOrCallback?: - | Params$Resource$Firewallpolicies$Patchrule + | Params$Resource$Firewallpolicies$Patchpacketmirroringrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28829,12 +29126,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Firewallpolicies$Patchrule; + {}) as Params$Resource$Firewallpolicies$Patchpacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Firewallpolicies$Patchrule; + params = + {} as Params$Resource$Firewallpolicies$Patchpacketmirroringrule; options = {}; } @@ -28849,7 +29147,95 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/patchRule' + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Patches a rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patchRule( + params: Params$Resource$Firewallpolicies$Patchrule, + options: StreamMethodOptions + ): GaxiosPromise; + patchRule( + params?: Params$Resource$Firewallpolicies$Patchrule, + options?: MethodOptions + ): GaxiosPromise; + patchRule( + params: Params$Resource$Firewallpolicies$Patchrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Firewallpolicies$Patchrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Firewallpolicies$Patchrule, + callback: BodyResponseCallback + ): void; + patchRule(callback: BodyResponseCallback): void; + patchRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Patchrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Patchrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firewallpolicies$Patchrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/patchRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -28959,6 +29345,97 @@ export namespace compute_beta { } } + /** + * Deletes a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params?: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Firewallpolicies$Removepacketmirroringrule, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Firewallpolicies$Removepacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firewallpolicies$Removepacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Firewallpolicies$Removepacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['firewallPolicy'], + pathParams: ['firewallPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes a rule of the specified priority. * @@ -29251,6 +29728,22 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicyAssociation; } + export interface Params$Resource$Firewallpolicies$Addpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Firewallpolicies$Addrule extends StandardParameters { /** @@ -29322,6 +29815,17 @@ export namespace compute_beta { */ resource?: string; } + export interface Params$Resource$Firewallpolicies$Getpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + } export interface Params$Resource$Firewallpolicies$Getrule extends StandardParameters { /** @@ -29414,6 +29918,26 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicy; } + export interface Params$Resource$Firewallpolicies$Patchpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Firewallpolicies$Patchrule extends StandardParameters { /** @@ -29449,6 +29973,21 @@ export namespace compute_beta { */ requestId?: string; } + export interface Params$Resource$Firewallpolicies$Removepacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } export interface Params$Resource$Firewallpolicies$Removerule extends StandardParameters { /** @@ -34965,7 +35504,7 @@ export namespace compute_beta { export interface Params$Resource$Globaloperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -34976,7 +35515,7 @@ export namespace compute_beta { export interface Params$Resource$Globaloperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -35014,7 +35553,7 @@ export namespace compute_beta { export interface Params$Resource$Globaloperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -35292,7 +35831,7 @@ export namespace compute_beta { export interface Params$Resource$Globalorganizationoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -35303,7 +35842,7 @@ export namespace compute_beta { export interface Params$Resource$Globalorganizationoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -59903,39 +60442,41 @@ export namespace compute_beta { } /** - * Inserts a rule into a firewall policy. + * Inserts a packet mirroring rule into a firewall policy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options: StreamMethodOptions ): GaxiosPromise; - addRule( - params?: Params$Resource$Networkfirewallpolicies$Addrule, + addPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options?: MethodOptions ): GaxiosPromise; - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - addRule( - params: Params$Resource$Networkfirewallpolicies$Addrule, + addPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule, callback: BodyResponseCallback ): void; - addRule(callback: BodyResponseCallback): void; - addRule( + addPacketMirroringRule( + callback: BodyResponseCallback + ): void; + addPacketMirroringRule( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Addrule + | Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -59948,12 +60489,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Addrule; + {}) as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Addrule; + params = + {} as Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule; options = {}; } @@ -59968,7 +60510,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule' + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -59991,39 +60533,39 @@ export namespace compute_beta { } /** - * Copies rules to the specified firewall policy. + * Inserts a rule into a firewall policy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, options: StreamMethodOptions ): GaxiosPromise; - cloneRules( - params?: Params$Resource$Networkfirewallpolicies$Clonerules, + addRule( + params?: Params$Resource$Networkfirewallpolicies$Addrule, options?: MethodOptions ): GaxiosPromise; - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cloneRules( - params: Params$Resource$Networkfirewallpolicies$Clonerules, + addRule( + params: Params$Resource$Networkfirewallpolicies$Addrule, callback: BodyResponseCallback ): void; - cloneRules(callback: BodyResponseCallback): void; - cloneRules( + addRule(callback: BodyResponseCallback): void; + addRule( paramsOrCallback?: - | Params$Resource$Networkfirewallpolicies$Clonerules + | Params$Resource$Networkfirewallpolicies$Addrule | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -60036,12 +60578,12 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Networkfirewallpolicies$Clonerules; + {}) as Params$Resource$Networkfirewallpolicies$Addrule; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Networkfirewallpolicies$Clonerules; + params = {} as Params$Resource$Networkfirewallpolicies$Addrule; options = {}; } @@ -60056,7 +60598,95 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules' + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Copies rules to the specified firewall policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, + options: StreamMethodOptions + ): GaxiosPromise; + cloneRules( + params?: Params$Resource$Networkfirewallpolicies$Clonerules, + options?: MethodOptions + ): GaxiosPromise; + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cloneRules( + params: Params$Resource$Networkfirewallpolicies$Clonerules, + callback: BodyResponseCallback + ): void; + cloneRules(callback: BodyResponseCallback): void; + cloneRules( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Clonerules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Clonerules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Networkfirewallpolicies$Clonerules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -60437,6 +61067,100 @@ export namespace compute_beta { } } + /** + * Gets a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule, + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + callback: BodyResponseCallback + ): void; + getPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a rule of the specified priority. * @@ -60795,6 +61519,97 @@ export namespace compute_beta { } } + /** + * Patches a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + patchPacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule, + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + callback: BodyResponseCallback + ): void; + patchPacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches a rule of the specified priority. * @@ -60972,6 +61787,97 @@ export namespace compute_beta { } } + /** + * Deletes a packet mirroring rule of the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params?: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options?: MethodOptions + ): GaxiosPromise; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + params: Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule, + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + callback: BodyResponseCallback + ): void; + removePacketMirroringRule( + paramsOrCallback?: + | Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'firewallPolicy'], + pathParams: ['firewallPolicy', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes a rule of the specified priority. * @@ -61269,6 +62175,34 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicyAssociation; } + export interface Params$Resource$Networkfirewallpolicies$Addpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + maxPriority?: number; + /** + * When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority\>. This field is exclusive with rule.priority. + */ + minPriority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Networkfirewallpolicies$Addrule extends StandardParameters { /** @@ -61372,6 +62306,21 @@ export namespace compute_beta { */ resource?: string; } + export interface Params$Resource$Networkfirewallpolicies$Getpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to which the queried rule belongs. + */ + firewallPolicy?: string; + /** + * The priority of the rule to get from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Networkfirewallpolicies$Getrule extends StandardParameters { /** @@ -61450,6 +62399,30 @@ export namespace compute_beta { */ requestBody?: Schema$FirewallPolicy; } + export interface Params$Resource$Networkfirewallpolicies$Patchpacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirewallPolicyRule; + } export interface Params$Resource$Networkfirewallpolicies$Patchrule extends StandardParameters { /** @@ -61493,6 +62466,25 @@ export namespace compute_beta { */ requestId?: string; } + export interface Params$Resource$Networkfirewallpolicies$Removepacketmirroringrule + extends StandardParameters { + /** + * Name of the firewall policy to update. + */ + firewallPolicy?: string; + /** + * The priority of the rule to remove from the firewall policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } export interface Params$Resource$Networkfirewallpolicies$Removerule extends StandardParameters { /** @@ -86839,7 +87831,7 @@ export namespace compute_beta { export interface Params$Resource$Regionoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -86854,7 +87846,7 @@ export namespace compute_beta { export interface Params$Resource$Regionoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -86900,7 +87892,7 @@ export namespace compute_beta { export interface Params$Resource$Regionoperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -86920,7 +87912,7 @@ export namespace compute_beta { } /** - * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -116544,7 +117536,7 @@ export namespace compute_beta { export interface Params$Resource$Zoneoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -116559,7 +117551,7 @@ export namespace compute_beta { export interface Params$Resource$Zoneoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -116605,7 +117597,7 @@ export namespace compute_beta { export interface Params$Resource$Zoneoperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index a5f20c9eab..e700e5c7f1 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -127,6 +127,7 @@ export namespace compute_v1 { firewallPolicies: Resource$Firewallpolicies; firewalls: Resource$Firewalls; forwardingRules: Resource$Forwardingrules; + futureReservations: Resource$Futurereservations; globalAddresses: Resource$Globaladdresses; globalForwardingRules: Resource$Globalforwardingrules; globalNetworkEndpointGroups: Resource$Globalnetworkendpointgroups; @@ -234,6 +235,7 @@ export namespace compute_v1 { this.firewallPolicies = new Resource$Firewallpolicies(this.context); this.firewalls = new Resource$Firewalls(this.context); this.forwardingRules = new Resource$Forwardingrules(this.context); + this.futureReservations = new Resource$Futurereservations(this.context); this.globalAddresses = new Resource$Globaladdresses(this.context); this.globalForwardingRules = new Resource$Globalforwardingrules( this.context @@ -1685,7 +1687,7 @@ export namespace compute_v1 { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not configured—that is, if session affinity remains at the default value of NONE—then the default value for localityLbPolicy is ROUND_ROBIN. If session affinity is set to a value other than NONE, then the default value for localityLbPolicy is MAGLEV. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. */ localityLbPolicy?: string | null; /** @@ -1757,6 +1759,9 @@ export namespace compute_v1 { * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. */ timeoutSec?: number | null; + /** + * [Output Only] List of resources referencing given backend service. + */ usedBy?: Schema$BackendServiceUsedBy[]; } /** @@ -2078,6 +2083,9 @@ export namespace compute_v1 { } | null; } export interface Schema$BackendServiceUsedBy { + /** + * [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + */ reference?: string | null; } export interface Schema$BfdPacket { @@ -3762,7 +3770,7 @@ export namespace compute_v1 { */ export interface Schema$FirewallPolicyRule { /** - * The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + * The Action to perform when the client connection triggers the rule. Valid actions for firewall rules are: "allow", "deny", "apply_security_profile_group" and "goto_next". Valid actions for packet mirroring rules are: "mirror", "do_not_mirror" and "goto_next". */ action?: string | null; /** @@ -3782,7 +3790,7 @@ export namespace compute_v1 { */ enableLogging?: boolean | null; /** - * [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + * [Output only] Type of the resource. Returns compute#firewallPolicyRule for firewall rules and compute#packetMirroringRule for packet mirroring rules. */ kind?: string | null; /** @@ -3790,7 +3798,7 @@ export namespace compute_v1 { */ match?: Schema$FirewallPolicyRuleMatcher; /** - * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + * An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. */ priority?: number | null; /** @@ -3802,7 +3810,7 @@ export namespace compute_v1 { */ ruleTupleCount?: number | null; /** - * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + * A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project\}/locations/{location\}/securityProfileGroups/my-security-profile-group Must be specified if action is one of 'apply_security_profile_group' or 'mirror'. Cannot be specified for other actions. */ securityProfileGroup?: string | null; /** @@ -4155,6 +4163,288 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$FutureReservation { + /** + * Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid href="https://www.ietf.org/rfc/rfc3339.txt"\>RFC3339 value. + */ + autoCreatedReservationsDeleteTime?: string | null; + /** + * Specifies the duration of auto-created reservations. It represents relative time to future reservation start_time when auto-created reservations will be automatically deleted by Compute Engine. Duration time unit is represented as a count of seconds and fractions of seconds at nanosecond resolution. + */ + autoCreatedReservationsDuration?: Schema$Duration; + /** + * Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. + */ + autoDeleteAutoCreatedReservations?: boolean | null; + /** + * [Output Only] The creation timestamp for this future reservation in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the future reservation. + */ + description?: string | null; + /** + * [Output Only] A unique identifier for this future reservation. The server defines this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#futureReservation for future reservations. + */ + kind?: string | null; + /** + * The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. + */ + namePrefix?: string | null; + /** + * Planning state before being submitted for evaluation + */ + planningStatus?: string | null; + /** + * [Output Only] Server-defined fully-qualified URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Server-defined URL for this resource with the resource id. + */ + selfLinkWithId?: string | null; + /** + * List of Projects/Folders to share with. + */ + shareSettings?: Schema$ShareSettings; + /** + * Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from the delivered reservation. If set to true,the delivered resevervation will have the same name as the future reservation. + */ + specificReservationRequired?: boolean | null; + /** + * Future Reservation configuration to indicate instance properties and total count. + */ + specificSkuProperties?: Schema$FutureReservationSpecificSKUProperties; + /** + * [Output only] Status of the Future Reservation + */ + status?: Schema$FutureReservationStatus; + /** + * Time window for this Future Reservation. + */ + timeWindow?: Schema$FutureReservationTimeWindow; + /** + * [Output Only] URL of the Zone where this future reservation resides. + */ + zone?: string | null; + } + /** + * Contains a list of future reservations. + */ + export interface Schema$FutureReservationsAggregatedListResponse { + etag?: string | null; + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of Future reservation resources. + */ + items?: {[key: string]: Schema$FutureReservationsScopedList} | null; + /** + * [Output Only] Type of resource. Always compute#futureReservationsAggregatedListResponse for future resevation aggregated list response. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$FutureReservationsListResponse { + etag?: string | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] A list of future reservation resources. + */ + items?: Schema$FutureReservation[]; + /** + * [Output Only] Type of resource.Always compute#FutureReservationsListResponse for lists of reservations + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Unreachable resources. + */ + unreachables?: string[] | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$FutureReservationSpecificSKUProperties { + /** + * Properties of the SKU instances being reserved. + */ + instanceProperties?: Schema$AllocationSpecificSKUAllocationReservedInstanceProperties; + /** + * The instance template that will be used to populate the ReservedInstanceProperties of the future reservation + */ + sourceInstanceTemplate?: string | null; + /** + * Total number of instances for which capacity assurance is requested at a future time period. + */ + totalCount?: string | null; + } + export interface Schema$FutureReservationsScopedList { + /** + * A list of future reservations contained in this scope. + */ + futureReservations?: Schema$FutureReservation[]; + /** + * Informational warning which replaces the list of future reservations when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * [Output only] Represents status related to the future reservation. + */ + export interface Schema$FutureReservationStatus { + /** + * [Output Only] The current status of the requested amendment. + */ + amendmentStatus?: string | null; + /** + * Fully qualified urls of the automatically created reservations at start_time. + */ + autoCreatedReservations?: string[] | null; + /** + * [Output Only] Represents the existing matching usage for the future reservation. + */ + existingMatchingUsageInfo?: Schema$FutureReservationStatusExistingMatchingUsageInfo; + /** + * This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. + */ + fulfilledCount?: string | null; + /** + * [Output Only] This field represents the future reservation before an amendment was requested. If the amendment is declined, the Future Reservation will be reverted to the last known good state. The last known good state is not set when updating a future reservation whose Procurement Status is DRAFTING. + */ + lastKnownGoodState?: Schema$FutureReservationStatusLastKnownGoodState; + /** + * Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. + */ + lockTime?: string | null; + /** + * Current state of this Future Reservation + */ + procurementStatus?: string | null; + specificSkuProperties?: Schema$FutureReservationStatusSpecificSKUProperties; + } + /** + * [Output Only] Represents the existing matching usage for the future reservation. + */ + export interface Schema$FutureReservationStatusExistingMatchingUsageInfo { + /** + * Count to represent min(FR total_count, matching_reserved_capacity+matching_unreserved_instances) + */ + count?: string | null; + /** + * Timestamp when the matching usage was calculated + */ + timestamp?: string | null; + } + /** + * The state that the future reservation will be reverted to should the amendment be declined. + */ + export interface Schema$FutureReservationStatusLastKnownGoodState { + /** + * [Output Only] The description of the FutureReservation before an amendment was requested. + */ + description?: string | null; + /** + * [Output Only] Represents the matching usage for the future reservation before an amendment was requested. + */ + existingMatchingUsageInfo?: Schema$FutureReservationStatusExistingMatchingUsageInfo; + futureReservationSpecs?: Schema$FutureReservationStatusLastKnownGoodStateFutureReservationSpecs; + /** + * [Output Only] The lock time of the FutureReservation before an amendment was requested. + */ + lockTime?: string | null; + /** + * [Output Only] The name prefix of the Future Reservation before an amendment was requested. + */ + namePrefix?: string | null; + /** + * [Output Only] The status of the last known good state for the Future Reservation. + */ + procurementStatus?: string | null; + } + /** + * The properties of the last known good state for the Future Reservation. + */ + export interface Schema$FutureReservationStatusLastKnownGoodStateFutureReservationSpecs { + /** + * [Output Only] The previous share settings of the Future Reservation. + */ + shareSettings?: Schema$ShareSettings; + /** + * [Output Only] The previous instance related properties of the Future Reservation. + */ + specificSkuProperties?: Schema$FutureReservationSpecificSKUProperties; + /** + * [Output Only] The previous time window of the Future Reservation. + */ + timeWindow?: Schema$FutureReservationTimeWindow; + } + /** + * Properties to be set for the Future Reservation. + */ + export interface Schema$FutureReservationStatusSpecificSKUProperties { + /** + * ID of the instance template used to populate the Future Reservation properties. + */ + sourceInstanceTemplateId?: string | null; + } + export interface Schema$FutureReservationTimeWindow { + duration?: Schema$Duration; + endTime?: string | null; + /** + * Start time of the Future Reservation. The start_time is an RFC3339 string. + */ + startTime?: string | null; + } export interface Schema$GlobalAddressesMoveRequest { /** * An optional destination address description if intended to be different from the source. @@ -4342,6 +4632,10 @@ export namespace compute_v1 { * [Output Only] Server-defined URL for the resource. */ selfLink?: string | null; + /** + * The list of cloud regions from which health checks are performed. If any regions are specified, then exactly 3 regions should be specified. The region names must be valid names of Google Cloud regions. This can only be set for global health check. If this list is non-empty, then there are restrictions on what other health check fields are supported and what other resources can use this health check: - SSL, HTTP2, and GRPC protocols are not supported. - The TCP request field is not supported. - The proxyHeader field for HTTP, HTTPS, and TCP is not supported. - The checkIntervalSec field must be at least 30. - The health check cannot be used with BackendService nor with managed instance group auto-healing. + */ + sourceRegions?: string[] | null; sslHealthCheck?: Schema$SSLHealthCheck; tcpHealthCheck?: Schema$TCPHealthCheck; /** @@ -5775,7 +6069,7 @@ export namespace compute_v1 { */ autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; /** - * The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + * The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57\})|([-a-z0-9]{0,51\}-#{1,10\}(\\[[0-9]{1,10\}\\])?)) */ baseInstanceName?: string | null; /** @@ -6051,7 +6345,7 @@ export namespace compute_v1 { */ requestedRunDuration?: Schema$Duration; /** - * The number of instances to be created by this resize request. The group's target size will be increased by this number. + * The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'. */ resizeBy?: number | null; /** @@ -6757,6 +7051,10 @@ export namespace compute_v1 { * [Output Only] The name of the firewall policy. */ name?: string | null; + /** + * [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. + */ + priority?: number | null; /** * The rules that apply to the network. */ @@ -12551,8 +12849,15 @@ export namespace compute_v1 { * [Output Only] An opaque ID of the host on which the VM is running. */ physicalHost?: string | null; + scheduling?: Schema$ResourceStatusScheduling; upcomingMaintenance?: Schema$UpcomingMaintenance; } + export interface Schema$ResourceStatusScheduling { + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + */ + availabilityDomain?: number | null; + } /** * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. */ @@ -13518,6 +13823,10 @@ export namespace compute_v1 { * Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. */ automaticRestart?: boolean | null; + /** + * Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + */ + availabilityDomain?: number | null; /** * Specifies the termination action for the instance. */ @@ -16120,7 +16429,7 @@ export namespace compute_v1 { */ authorizationPolicy?: string | null; /** - * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project \}/locations/{location\}/certificateMaps/{resourceName\}. + * URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for Global external Application Load Balancer or Classic Application Load Balancer. For other products use Certificate Manager Certificates instead. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project \}/locations/{location\}/certificateMaps/{resourceName\}. */ certificateMap?: string | null; /** @@ -16172,7 +16481,7 @@ export namespace compute_v1 { */ serverTlsPolicy?: string | null; /** - * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. + * URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. SslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. The URLs should refer to a SSL Certificate resource or Certificate Manager Certificate resource. Mixing Classic Certificates and Certificate Manager Certificates is not allowed. Certificate Manager Certificates must include the certificatemanager API. Certificate Manager Certificates are not supported by Global external Application Load Balancer or Classic Application Load Balancer, use certificate_map instead. Currently, you may specify up to 15 Classic SSL Certificates. Certificate Manager Certificates accepted formats are: - //certificatemanager.googleapis.com/projects/{project\}/locations/{ location\}/certificates/{resourceName\}. - https://certificatemanager.googleapis.com/v1alpha1/projects/{project \}/locations/{location\}/certificates/{resourceName\}. */ sslCertificates?: string[] | null; /** @@ -17062,7 +17371,7 @@ export namespace compute_v1 { */ defaultRouteAction?: Schema$HttpRouteAction; /** - * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. + * The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any defaultRouteAction.weightedBackendServices. Conversely, if defaultRouteAction specifies any defaultRouteAction.weightedBackendServices, defaultService must not be specified. If defaultService is specified, then set either defaultUrlRedirect , or defaultRouteAction.weightedBackendService Don't set both. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. */ defaultService?: string | null; /** @@ -17540,7 +17849,7 @@ export namespace compute_v1 { */ selfLink?: string | null; /** - * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + * The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. */ stackType?: string | null; /** @@ -29525,6 +29834,818 @@ export namespace compute_v1 { requestBody?: Schema$TargetReference; } + export class Resource$Futurereservations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves an aggregated list of future reservations. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + aggregatedList( + params: Params$Resource$Futurereservations$Aggregatedlist, + options: StreamMethodOptions + ): GaxiosPromise; + aggregatedList( + params?: Params$Resource$Futurereservations$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Futurereservations$Aggregatedlist, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Futurereservations$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Futurereservations$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Futurereservations$Aggregatedlist + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/futureReservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Cancel the specified future reservation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Futurereservations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Futurereservations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Futurereservations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Futurereservations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Futurereservations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Futurereservations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'futureReservation'], + pathParams: ['futureReservation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified future reservation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Futurereservations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Futurereservations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Futurereservations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Futurereservations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Futurereservations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Futurereservations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/futureReservations/{futureReservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'futureReservation'], + pathParams: ['futureReservation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves information about the specified future reservation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Futurereservations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Futurereservations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Futurereservations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Futurereservations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Futurereservations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Futurereservations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/futureReservations/{futureReservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'futureReservation'], + pathParams: ['futureReservation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new Future Reservation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Futurereservations$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Futurereservations$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Futurereservations$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Futurereservations$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Futurereservations$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Futurereservations$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/futureReservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * A list of all the future reservations that have been configured for the specified project in specified zone. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Futurereservations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Futurereservations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Futurereservations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Futurereservations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Futurereservations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Futurereservations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/futureReservations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the specified future reservation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + update( + params: Params$Resource$Futurereservations$Update, + options: StreamMethodOptions + ): GaxiosPromise; + update( + params?: Params$Resource$Futurereservations$Update, + options?: MethodOptions + ): GaxiosPromise; + update( + params: Params$Resource$Futurereservations$Update, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Futurereservations$Update, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + update( + params: Params$Resource$Futurereservations$Update, + callback: BodyResponseCallback + ): void; + update(callback: BodyResponseCallback): void; + update( + paramsOrCallback?: + | Params$Resource$Futurereservations$Update + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Futurereservations$Update; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Futurereservations$Update; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/futureReservations/{futureReservation}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'futureReservation'], + pathParams: ['futureReservation', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Futurereservations$Aggregatedlist + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api. + */ + serviceProjectNumber?: string; + } + export interface Params$Resource$Futurereservations$Cancel + extends StandardParameters { + /** + * Name of the future reservation to retrieve. Name should conform to RFC1035. + */ + futureReservation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone for this request. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Futurereservations$Delete + extends StandardParameters { + /** + * Name of the future reservation to retrieve. Name should conform to RFC1035. + */ + futureReservation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone for this request. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Futurereservations$Get + extends StandardParameters { + /** + * Name of the future reservation to retrieve. Name should conform to RFC1035. + */ + futureReservation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the zone for this request. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Futurereservations$Insert + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Name of the zone for this request. Name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FutureReservation; + } + export interface Params$Resource$Futurereservations$List + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code. + */ + returnPartialSuccess?: boolean; + /** + * Name of the zone for this request. Name should conform to RFC1035. + */ + zone?: string; + } + export interface Params$Resource$Futurereservations$Update + extends StandardParameters { + /** + * Name of the reservation to update. Name should conform to RFC1035. + */ + futureReservation?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * update_mask indicates fields to be updated as part of this request. + */ + updateMask?: string; + /** + * Name of the zone for this request. Name should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FutureReservation; + } + export class Resource$Globaladdresses { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -32192,7 +33313,7 @@ export namespace compute_v1 { export interface Params$Resource$Globaloperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -32203,7 +33324,7 @@ export namespace compute_v1 { export interface Params$Resource$Globaloperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -32241,7 +33362,7 @@ export namespace compute_v1 { export interface Params$Resource$Globaloperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -32520,7 +33641,7 @@ export namespace compute_v1 { export interface Params$Resource$Globalorganizationoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -32531,7 +33652,7 @@ export namespace compute_v1 { export interface Params$Resource$Globalorganizationoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -78382,7 +79503,7 @@ export namespace compute_v1 { export interface Params$Resource$Regionoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -78397,7 +79518,7 @@ export namespace compute_v1 { export interface Params$Resource$Regionoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -78443,7 +79564,7 @@ export namespace compute_v1 { export interface Params$Resource$Regionoperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -78463,7 +79584,7 @@ export namespace compute_v1 { } /** - * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. + * Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -104952,7 +106073,7 @@ export namespace compute_v1 { export interface Params$Resource$Zoneoperations$Delete extends StandardParameters { /** - * Name of the Operations resource to delete. + * Name of the Operations resource to delete, or its unique numeric identifier. */ operation?: string; /** @@ -104967,7 +106088,7 @@ export namespace compute_v1 { export interface Params$Resource$Zoneoperations$Get extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** @@ -105013,7 +106134,7 @@ export namespace compute_v1 { export interface Params$Resource$Zoneoperations$Wait extends StandardParameters { /** - * Name of the Operations resource to return. + * Name of the Operations resource to return, or its unique numeric identifier. */ operation?: string; /** diff --git a/src/apis/config/v1.ts b/src/apis/config/v1.ts index b6218361cc..9575d30889 100644 --- a/src/apis/config/v1.ts +++ b/src/apis/config/v1.ts @@ -957,11 +957,11 @@ export namespace config_v1 { */ export interface Schema$TerraformBlueprint { /** - * Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket\}/{object\}` URI may also specify an object version for zipped objects. Format: `gs://{bucket\}/{object\}#{version\}` + * URI of an object in Google Cloud Storage. Format: `gs://{bucket\}/{object\}` URI may also specify an object version for zipped objects. Format: `gs://{bucket\}/{object\}#{version\}` */ gcsSource?: string | null; /** - * Required. URI of a public Git repo. + * URI of a public Git repo. */ gitSource?: Schema$GitSource; /** diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index 15d7b90c18..1c582cf198 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -227,7 +227,7 @@ export namespace connectors_v1 { /** * Optional. Omit query params from the redirect URI. */ - omitQueryParams?: string | null; + omitQueryParams?: boolean | null; /** * The scopes for which the user will authorize Google Cloud Connectors on the connector data source. */ @@ -365,6 +365,10 @@ export namespace connectors_v1 { * Connection represents an instance of connector. */ export interface Schema$Connection { + /** + * Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. + */ + asyncOperationsEnabled?: boolean | null; /** * Optional. Configuration for establishing the connection's authentication with an external system. */ @@ -609,6 +613,14 @@ export namespace connectors_v1 { * Max QPS supported for internal requests originating from Connd. */ internalclientRatelimitThreshold?: string | null; + /** + * Max Instance Request Conncurrency for Cloud Run service. + */ + maxInstanceRequestConcurrency?: number | null; + /** + * Indicate whether connector is being migrated to cloud run deployment model. + */ + migrateDeploymentModel?: boolean | null; /** * Max QPS supported by the connector version before throttling of requests. */ @@ -679,6 +691,14 @@ export namespace connectors_v1 { * Output only. Eventing configuration supported by the Connector. */ eventingConfigTemplate?: Schema$EventingConfigTemplate; + /** + * Output only. Is custom actions supported. + */ + isCustomActionsSupported?: boolean | null; + /** + * Output only. Is custom entities supported. + */ + isCustomEntitiesSupported?: boolean | null; /** * Output only. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources */ @@ -715,6 +735,14 @@ export namespace connectors_v1 { * Output only. Information about the runtime features supported by the Connector. */ supportedRuntimeFeatures?: Schema$SupportedRuntimeFeatures; + /** + * Output only. Supported standard actions. + */ + supportedStandardActions?: Schema$StandardAction[]; + /** + * Output only. Supported standard entities. + */ + supportedStandardEntities?: Schema$StandardEntity[]; /** * Output only. Unsupported connection types. */ @@ -736,6 +764,10 @@ export namespace connectors_v1 { * Optional. Indicates whether connector is deployed on GKE/CloudRun */ deploymentModel?: string | null; + /** + * Output only. Status of the deployment model migration. + */ + deploymentModelMigrationState?: string | null; /** * Output only. HPA autoscaling config. */ @@ -744,6 +776,10 @@ export namespace connectors_v1 { * Output only. Max QPS supported for internal requests originating from Connd. */ internalclientRatelimitThreshold?: string | null; + /** + * Output only. Max instance request concurrency. + */ + maxInstanceRequestConcurrency?: number | null; /** * Output only. Max QPS supported by the connector version before throttling of requests. */ @@ -2134,7 +2170,7 @@ export namespace connectors_v1 { */ multipleSelectOptions?: Schema$MultipleSelectOption[]; /** - * Required. Value separator. + * Required. Value separator. Only "," can be used for OAuth auth code flow scope field. */ valueSeparator?: string | null; } @@ -2496,6 +2532,10 @@ export namespace connectors_v1 { * The data type of the field. */ dataType?: string | null; + /** + * The following field specifies the default value of the Parameter provided by the external system if a value is not provided. + */ + defaultValue?: any | null; /** * A brief description of the field. */ @@ -2508,6 +2548,10 @@ export namespace connectors_v1 { * JsonSchema representation of this action's result */ jsonSchema?: Schema$JsonSchema; + /** + * Specifies whether a null value is allowed. + */ + nullable?: boolean | null; } /** * Request message for ConnectorsService.RefreshEventSubscription @@ -2874,6 +2918,24 @@ export namespace connectors_v1 { */ sslType?: string | null; } + /** + * Standard action + */ + export interface Schema$StandardAction { + /** + * Name of the standard action. + */ + name?: string | null; + } + /** + * Standard entity + */ + export interface Schema$StandardEntity { + /** + * Name of the standard entity. + */ + name?: string | null; + } /** * 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). */ diff --git a/src/apis/connectors/v2.ts b/src/apis/connectors/v2.ts index fdd3293a54..281b6028cf 100644 --- a/src/apis/connectors/v2.ts +++ b/src/apis/connectors/v2.ts @@ -174,6 +174,23 @@ export namespace connectors_v2 { */ resultMetadata?: Schema$ResultMetadata[]; } + /** + * AuthCodeData contains the data the runtime plane will give the connector backend in exchange for access and refresh tokens. + */ + export interface Schema$AuthCodeData { + /** + * OAuth authorization code. + */ + authCode?: string | null; + /** + * OAuth PKCE verifier, needed if PKCE is enabled for this particular connection. + */ + pkceVerifier?: string | null; + /** + * OAuth redirect URI passed in during the auth code flow, required by some OAuth backends. + */ + redirectUri?: string | null; + } /** * Response containing status of the connector for readiness prober. */ @@ -276,9 +293,14 @@ export namespace connectors_v2 { operations?: string[] | null; } /** - * ExchangeAuthCodeRequest currently includes no fields. + * ExchangeAuthCodeRequest currently includes the auth code data. */ - export interface Schema$ExchangeAuthCodeRequest {} + export interface Schema$ExchangeAuthCodeRequest { + /** + * Optional. AuthCodeData contains the data the runtime requires to exchange for access and refresh tokens. If the data is not provided, the runtime will read the data from the secret manager. + */ + authCodeData?: Schema$AuthCodeData; + } /** * ExchangeAuthCodeResponse includes the returned access token and its associated credentials. */ @@ -737,9 +759,14 @@ export namespace connectors_v2 { type?: string | null; } /** - * RefreshAccessTokenRequest currently includes no fields. + * RefreshAccessTokenRequest includes the refresh token. */ - export interface Schema$RefreshAccessTokenRequest {} + export interface Schema$RefreshAccessTokenRequest { + /** + * Optional. Refresh Token String. If the Refresh Token is not provided, the runtime will read the data from the secret manager. + */ + refreshToken?: string | null; + } /** * RefreshAccessTokenResponse includes the returned access token and its associated credentials. */ @@ -754,6 +781,10 @@ export namespace connectors_v2 { * The data type of the metadata field */ dataType?: string | null; + /** + * The following field specifies the default value of the Parameter provided by the external system if a value is not provided. + */ + defaultValue?: any | null; /** * A brief description of the metadata field. */ @@ -766,6 +797,10 @@ export namespace connectors_v2 { * Name of the metadata field. */ name?: string | null; + /** + * Specifies whether a null value is allowed. + */ + nullable?: boolean | null; } /** * Configure the schedule. diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index 29293368f7..b965cbb507 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -949,6 +949,19 @@ export namespace contactcenterinsights_v1 { */ dialogflowConversation?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location. */ @@ -1324,6 +1337,40 @@ export namespace contactcenterinsights_v1 { * The response to an IngestConversations operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1IngestConversationsResponse {} + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata { + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Partial errors during initialising operation that might cause the operation output to be incomplete. + */ + partialErrors?: Schema$GoogleRpcStatus[]; + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec; + } + /** + * The response to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse {} /** * The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. */ @@ -1580,6 +1627,10 @@ export namespace contactcenterinsights_v1 { * Query text. Article Search uses this to store the input query used to generate the search results. */ query?: string | null; + /** + * Query source for the answer. + */ + querySource?: string | null; } /** * The data for a sentiment annotation. @@ -2626,6 +2677,19 @@ export namespace contactcenterinsights_v1 { */ dialogflowConversation?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudContactcenterinsightsV1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location. */ @@ -3010,6 +3074,40 @@ export namespace contactcenterinsights_v1 { * The response to an IngestConversations operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1IngestConversationsResponse {} + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata { + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Partial errors during initialising operation that might cause the operation output to be incomplete. + */ + partialErrors?: Schema$GoogleRpcStatus[]; + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudContactcenterinsightsV1EncryptionSpec; + } + /** + * The response to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse {} /** * The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE. */ @@ -3044,6 +3142,10 @@ export namespace contactcenterinsights_v1 { * Output only. The time at which this issue was created. */ createTime?: string | null; + /** + * Representative description of the issue. + */ + displayDescription?: string | null; /** * The representative name for the issue. */ @@ -3449,6 +3551,10 @@ export namespace contactcenterinsights_v1 { * Query text. Article Search uses this to store the input query used to generate the search results. */ query?: string | null; + /** + * Query source for the answer. + */ + querySource?: string | null; } /** * The data for a sentiment annotation. @@ -3753,6 +3859,7 @@ export namespace contactcenterinsights_v1 { export class Resource$Projects$Locations { context: APIRequestContext; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; insightsdata: Resource$Projects$Locations$Insightsdata; issueModels: Resource$Projects$Locations$Issuemodels; operations: Resource$Projects$Locations$Operations; @@ -3763,6 +3870,9 @@ export namespace contactcenterinsights_v1 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.insightsdata = new Resource$Projects$Locations$Insightsdata( this.context ); @@ -3778,6 +3888,101 @@ export namespace contactcenterinsights_v1 { this.views = new Resource$Projects$Locations$Views(this.context); } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets project-level settings. * @@ -3969,6 +4174,13 @@ export namespace contactcenterinsights_v1 { } } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Getsettings extends StandardParameters { /** @@ -5539,6 +5751,123 @@ export namespace contactcenterinsights_v1 { parent?: string; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenterinsights.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Insightsdata { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 7be0c5cdf0..75ecd657b2 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -167,15 +167,15 @@ export namespace container_v1 { */ export interface Schema$AdditionalPodNetworkConfig { /** - * The maximum number of pods per node which use this pod network + * The maximum number of pods per node which use this pod network. */ maxPodsPerNode?: Schema$MaxPodsConstraint; /** - * The name of the secondary range on the subnet which provides IP address for this pod range + * The name of the secondary range on the subnet which provides IP address for this pod range. */ secondaryPodRange?: string | null; /** - * Name of the subnetwork where the additional pod network belongs + * Name of the subnetwork where the additional pod network belongs. */ subnetwork?: string | null; } @@ -184,7 +184,7 @@ export namespace container_v1 { */ export interface Schema$AdditionalPodRangesConfig { /** - * Output only. [Output only] Information for additional pod range. + * Output only. Information for additional pod range. */ podRangeInfo?: Schema$RangeInfo[]; /** @@ -240,6 +240,10 @@ export namespace container_v1 { * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ networkPolicyConfig?: Schema$NetworkPolicyConfig; + /** + * Optional. Configuration for Ray Operator addon. + */ + rayOperatorConfig?: Schema$RayOperatorConfig; /** * Optional. Configuration for the StatefulHA add-on. */ @@ -384,11 +388,11 @@ export namespace container_v1 { */ export interface Schema$AutoUpgradeOptions { /** - * [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ autoUpgradeStartTime?: string | null; /** - * [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + * Output only. This field is set when upgrades are about to commence with the description of the upgrade. */ description?: string | null; } @@ -588,19 +592,19 @@ export namespace container_v1 { */ costManagementConfig?: Schema$CostManagementConfig; /** - * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ createTime?: string | null; /** - * [Output only] The current software version of the master endpoint. + * Output only. The current software version of the master endpoint. */ currentMasterVersion?: string | null; /** - * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + * Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ currentNodeCount?: number | null; /** - * [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + * Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string | null; /** @@ -628,7 +632,7 @@ export namespace container_v1 { */ enableTpu?: boolean | null; /** - * [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + * Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. */ endpoint?: string | null; /** @@ -640,7 +644,7 @@ export namespace container_v1 { */ etag?: string | null; /** - * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ expireTime?: string | null; /** @@ -664,7 +668,7 @@ export namespace container_v1 { */ initialNodeCount?: number | null; /** - * Deprecated. Use node_pools.instance_group_urls. + * Output only. Deprecated. Use node_pools.instance_group_urls. */ instanceGroupUrls?: string[] | null; /** @@ -680,7 +684,7 @@ export namespace container_v1 { */ legacyAbac?: Schema$LegacyAbac; /** - * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** @@ -740,7 +744,7 @@ export namespace container_v1 { */ nodeConfig?: Schema$NodeConfig; /** - * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + * Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. */ nodeIpv4CidrSize?: number | null; /** @@ -792,11 +796,11 @@ export namespace container_v1 { */ securityPostureConfig?: Schema$SecurityPostureConfig; /** - * [Output only] Server-defined URL for the resource. + * Output only. Server-defined URL for the resource. */ selfLink?: string | null; /** - * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + * Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ servicesIpv4Cidr?: string | null; /** @@ -804,11 +808,11 @@ export namespace container_v1 { */ shieldedNodes?: Schema$ShieldedNodes; /** - * [Output only] The current status of this cluster. + * Output only. The current status of this cluster. */ status?: string | null; /** - * [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + * Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. */ statusMessage?: string | null; /** @@ -816,7 +820,7 @@ export namespace container_v1 { */ subnetwork?: string | null; /** - * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + * Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string | null; /** @@ -828,7 +832,7 @@ export namespace container_v1 { */ workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** - * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string | null; } @@ -1220,7 +1224,7 @@ export namespace container_v1 { */ export interface Schema$DailyMaintenanceWindow { /** - * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + * Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". */ duration?: string | null; /** @@ -1301,7 +1305,7 @@ export namespace container_v1 { */ export interface Schema$EnterpriseConfig { /** - * Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + * Output only. cluster_tier indicates the effective tier of the cluster. */ clusterTier?: string | null; } @@ -1337,11 +1341,11 @@ export namespace container_v1 { */ export interface Schema$Fleet { /** - * [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/x/locations/x/memberships/x`. + * Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/x/locations/x/memberships/x`. */ membership?: string | null; /** - * [Output only] Whether the cluster has been registered through the fleet API. + * Output only. Whether the cluster has been registered through the fleet API. */ preRegistered?: boolean | null; /** @@ -1564,7 +1568,7 @@ export namespace container_v1 { */ export interface Schema$IPAllocationPolicy { /** - * Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + * Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. */ additionalPodRangesConfig?: Schema$AdditionalPodRangesConfig; /** @@ -1584,7 +1588,7 @@ export namespace container_v1 { */ createSubnetwork?: boolean | null; /** - * Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + * Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. */ defaultPodIpv4RangeUtilization?: number | null; /** @@ -1612,7 +1616,7 @@ export namespace container_v1 { */ servicesIpv4CidrBlock?: string | null; /** - * Output only. [Output only] The services IPv6 CIDR block for the cluster. + * Output only. The services IPv6 CIDR block for the cluster. */ servicesIpv6CidrBlock?: string | null; /** @@ -1624,7 +1628,7 @@ export namespace container_v1 { */ stackType?: string | null; /** - * Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + * Output only. The subnet's IPv6 CIDR block used by nodes and pods. */ subnetIpv6CidrBlock?: string | null; /** @@ -1866,7 +1870,7 @@ export namespace container_v1 { */ export interface Schema$MasterAuth { /** - * [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + * Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. */ clientCertificate?: string | null; /** @@ -1874,11 +1878,11 @@ export namespace container_v1 { */ clientCertificateConfig?: Schema$ClientCertificateConfig; /** - * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. + * Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ clientKey?: string | null; /** - * [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + * Output only. Base64-encoded public certificate that is the root of trust for the cluster. */ clusterCaCertificate?: string | null; /** @@ -2360,7 +2364,7 @@ export namespace container_v1 { */ podIpv4CidrBlock?: string | null; /** - * Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + * Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. */ podIpv4RangeUtilization?: number | null; /** @@ -2397,7 +2401,7 @@ export namespace container_v1 { */ initialNodeCount?: number | null; /** - * [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + * Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. */ instanceGroupUrls?: string[] | null; /** @@ -2425,7 +2429,7 @@ export namespace container_v1 { */ placementPolicy?: Schema$PlacementPolicy; /** - * [Output only] The pod CIDR block size per node in this node pool. + * Output only. The pod CIDR block size per node in this node pool. */ podIpv4CidrSize?: number | null; /** @@ -2433,19 +2437,19 @@ export namespace container_v1 { */ queuedProvisioning?: Schema$QueuedProvisioning; /** - * [Output only] Server-defined URL for the resource. + * Output only. Server-defined URL for the resource. */ selfLink?: string | null; /** - * [Output only] The status of the nodes in this pool instance. + * Output only. The status of the nodes in this pool instance. */ status?: string | null; /** - * [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + * Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. */ statusMessage?: string | null; /** - * Output only. [Output only] Update info contains relevant information during a node pool update. + * Output only. Update info contains relevant information during a node pool update. */ updateInfo?: Schema$UpdateInfo; /** @@ -2569,11 +2573,11 @@ export namespace container_v1 { */ clusterConditions?: Schema$StatusCondition[]; /** - * Detailed operation progress, if available. + * Output only. Detailed operation progress, if available. */ detail?: string | null; /** - * [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ endTime?: string | null; /** @@ -2581,11 +2585,11 @@ export namespace container_v1 { */ error?: Schema$Status; /** - * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** - * The server-assigned ID for the operation. + * Output only. The server-assigned ID for the operation. */ name?: string | null; /** @@ -2593,23 +2597,23 @@ export namespace container_v1 { */ nodepoolConditions?: Schema$StatusCondition[]; /** - * The operation type. + * Output only. The operation type. */ operationType?: string | null; /** - * Output only. [Output only] Progress information for an operation. + * Output only. Progress information for an operation. */ progress?: Schema$OperationProgress; /** - * Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + * Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. */ selfLink?: string | null; /** - * [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ startTime?: string | null; /** - * The current status of the operation. + * Output only. The current status of the operation. */ status?: string | null; /** @@ -2617,11 +2621,11 @@ export namespace container_v1 { */ statusMessage?: string | null; /** - * Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + * Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` */ targetLink?: string | null; /** - * The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ zone?: string | null; } @@ -2792,14 +2796,49 @@ export namespace container_v1 { */ export interface Schema$RangeInfo { /** - * Output only. [Output only] Name of a range. + * Output only. Name of a range. */ rangeName?: string | null; /** - * Output only. [Output only] The utilization of the range. + * Output only. The utilization of the range. */ utilization?: number | null; } + /** + * RayClusterLoggingConfig specifies configuration of Ray logging. + */ + export interface Schema$RayClusterLoggingConfig { + /** + * Enable log collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. + */ + export interface Schema$RayClusterMonitoringConfig { + /** + * Enable metrics collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * Configuration options for the Ray Operator add-on. + */ + export interface Schema$RayOperatorConfig { + /** + * Whether the Ray Operator addon is enabled for this cluster. + */ + enabled?: boolean | null; + /** + * Optional. Logging configuration for Ray clusters. + */ + rayClusterLoggingConfig?: Schema$RayClusterLoggingConfig; + /** + * Optional. Monitoring configuration for Ray clusters. + */ + rayClusterMonitoringConfig?: Schema$RayClusterMonitoringConfig; + } /** * Represents an arbitrary window of time that recurs. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 36d273378a..df1b6dda8a 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -188,7 +188,7 @@ export namespace container_v1beta1 { */ export interface Schema$AdditionalPodRangesConfig { /** - * Output only. [Output only] Information for additional pod range. + * Output only. Information for additional pod range. */ podRangeInfo?: Schema$RangeInfo[]; /** @@ -252,6 +252,10 @@ export namespace container_v1beta1 { * Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes. */ networkPolicyConfig?: Schema$NetworkPolicyConfig; + /** + * Optional. Configuration for Ray Operator addon. + */ + rayOperatorConfig?: Schema$RayOperatorConfig; /** * Optional. Configuration for the StatefulHA add-on. */ @@ -413,11 +417,11 @@ export namespace container_v1beta1 { */ export interface Schema$AutoUpgradeOptions { /** - * [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ autoUpgradeStartTime?: string | null; /** - * [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + * Output only. This field is set when upgrades are about to commence with the description of the upgrade. */ description?: string | null; } @@ -646,19 +650,19 @@ export namespace container_v1beta1 { */ costManagementConfig?: Schema$CostManagementConfig; /** - * [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ createTime?: string | null; /** - * [Output only] The current software version of the master endpoint. + * Output only. The current software version of the master endpoint. */ currentMasterVersion?: string | null; /** - * [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + * Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. */ currentNodeCount?: number | null; /** - * [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + * Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. */ currentNodeVersion?: string | null; /** @@ -686,7 +690,7 @@ export namespace container_v1beta1 { */ enableTpu?: boolean | null; /** - * [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + * Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. */ endpoint?: string | null; /** @@ -698,7 +702,7 @@ export namespace container_v1beta1 { */ etag?: string | null; /** - * [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ expireTime?: string | null; /** @@ -722,7 +726,7 @@ export namespace container_v1beta1 { */ initialNodeCount?: number | null; /** - * Deprecated. Use node_pools.instance_group_urls. + * Output only. Deprecated. Use node_pools.instance_group_urls. */ instanceGroupUrls?: string[] | null; /** @@ -738,7 +742,7 @@ export namespace container_v1beta1 { */ legacyAbac?: Schema$LegacyAbac; /** - * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** @@ -806,7 +810,7 @@ export namespace container_v1beta1 { */ nodeConfig?: Schema$NodeConfig; /** - * [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + * Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. */ nodeIpv4CidrSize?: number | null; /** @@ -874,11 +878,11 @@ export namespace container_v1beta1 { */ securityPostureConfig?: Schema$SecurityPostureConfig; /** - * [Output only] Server-defined URL for the resource. + * Output only. Server-defined URL for the resource. */ selfLink?: string | null; /** - * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + * Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ servicesIpv4Cidr?: string | null; /** @@ -886,11 +890,11 @@ export namespace container_v1beta1 { */ shieldedNodes?: Schema$ShieldedNodes; /** - * [Output only] The current status of this cluster. + * Output only. The current status of this cluster. */ status?: string | null; /** - * [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + * Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. */ statusMessage?: string | null; /** @@ -902,7 +906,7 @@ export namespace container_v1beta1 { */ tpuConfig?: Schema$TpuConfig; /** - * [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + * Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). */ tpuIpv4CidrBlock?: string | null; /** @@ -922,7 +926,7 @@ export namespace container_v1beta1 { */ workloadIdentityConfig?: Schema$WorkloadIdentityConfig; /** - * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. */ zone?: string | null; } @@ -1385,7 +1389,7 @@ export namespace container_v1beta1 { */ export interface Schema$DailyMaintenanceWindow { /** - * [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + * Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. */ duration?: string | null; /** @@ -1483,7 +1487,7 @@ export namespace container_v1beta1 { */ export interface Schema$EnterpriseConfig { /** - * Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + * Output only. cluster_tier indicates the effective tier of the cluster. */ clusterTier?: string | null; } @@ -1528,11 +1532,11 @@ export namespace container_v1beta1 { */ export interface Schema$Fleet { /** - * [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/x/locations/x/memberships/x`. + * Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/x/locations/x/memberships/x`. */ membership?: string | null; /** - * [Output only] Whether the cluster has been registered through the fleet API. + * Output only. Whether the cluster has been registered through the fleet API. */ preRegistered?: boolean | null; /** @@ -1768,7 +1772,7 @@ export namespace container_v1beta1 { */ export interface Schema$IPAllocationPolicy { /** - * Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + * Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. */ additionalPodRangesConfig?: Schema$AdditionalPodRangesConfig; /** @@ -1792,7 +1796,7 @@ export namespace container_v1beta1 { */ createSubnetwork?: boolean | null; /** - * Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + * Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. */ defaultPodIpv4RangeUtilization?: number | null; /** @@ -1820,7 +1824,7 @@ export namespace container_v1beta1 { */ servicesIpv4CidrBlock?: string | null; /** - * Output only. [Output only] The services IPv6 CIDR block for the cluster. + * Output only. The services IPv6 CIDR block for the cluster. */ servicesIpv6CidrBlock?: string | null; /** @@ -1832,7 +1836,7 @@ export namespace container_v1beta1 { */ stackType?: string | null; /** - * Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + * Output only. The subnet's IPv6 CIDR block used by nodes and pods. */ subnetIpv6CidrBlock?: string | null; /** @@ -2130,7 +2134,7 @@ export namespace container_v1beta1 { */ export interface Schema$MasterAuth { /** - * [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + * Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. */ clientCertificate?: string | null; /** @@ -2138,9 +2142,12 @@ export namespace container_v1beta1 { */ clientCertificateConfig?: Schema$ClientCertificateConfig; /** - * [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. + * Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. */ clientKey?: string | null; + /** + * Output only. Base64-encoded public certificate that is the root of trust for the cluster. + */ clusterCaCertificate?: string | null; /** * The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication @@ -2511,6 +2518,10 @@ export namespace container_v1beta1 { * Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. */ spot?: boolean | null; + /** + * List of Storage Pools where boot disks are provisioned. + */ + storagePools?: string[] | null; /** * The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. */ @@ -2637,7 +2648,7 @@ export namespace container_v1beta1 { */ podIpv4CidrBlock?: string | null; /** - * Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + * Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. */ podIpv4RangeUtilization?: number | null; /** @@ -2674,7 +2685,7 @@ export namespace container_v1beta1 { */ initialNodeCount?: number | null; /** - * [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + * Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. */ instanceGroupUrls?: string[] | null; /** @@ -2702,7 +2713,7 @@ export namespace container_v1beta1 { */ placementPolicy?: Schema$PlacementPolicy; /** - * [Output only] The pod CIDR block size per node in this node pool. + * Output only. The pod CIDR block size per node in this node pool. */ podIpv4CidrSize?: number | null; /** @@ -2710,19 +2721,19 @@ export namespace container_v1beta1 { */ queuedProvisioning?: Schema$QueuedProvisioning; /** - * [Output only] Server-defined URL for the resource. + * Output only. Server-defined URL for the resource. */ selfLink?: string | null; /** - * [Output only] The status of the nodes in this pool instance. + * Output only. The status of the nodes in this pool instance. */ status?: string | null; /** - * [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + * Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. */ statusMessage?: string | null; /** - * Output only. [Output only] Update info contains relevant information during a node pool update. + * Output only. Update info contains relevant information during a node pool update. */ updateInfo?: Schema$UpdateInfo; /** @@ -2846,11 +2857,11 @@ export namespace container_v1beta1 { */ clusterConditions?: Schema$StatusCondition[]; /** - * Detailed operation progress, if available. + * Output only. Detailed operation progress, if available. */ detail?: string | null; /** - * [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ endTime?: string | null; /** @@ -2858,11 +2869,11 @@ export namespace container_v1beta1 { */ error?: Schema$Status; /** - * [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. */ location?: string | null; /** - * The server-assigned ID for the operation. + * Output only. The server-assigned ID for the operation. */ name?: string | null; /** @@ -2870,23 +2881,23 @@ export namespace container_v1beta1 { */ nodepoolConditions?: Schema$StatusCondition[]; /** - * The operation type. + * Output only. The operation type. */ operationType?: string | null; /** - * Output only. [Output only] Progress information for an operation. + * Output only. Progress information for an operation. */ progress?: Schema$OperationProgress; /** - * Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + * Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. */ selfLink?: string | null; /** - * [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + * Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. */ startTime?: string | null; /** - * The current status of the operation. + * Output only. The current status of the operation. */ status?: string | null; /** @@ -2894,11 +2905,11 @@ export namespace container_v1beta1 { */ statusMessage?: string | null; /** - * Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + * Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` */ targetLink?: string | null; /** - * The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + * Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. */ zone?: string | null; } @@ -3117,14 +3128,49 @@ export namespace container_v1beta1 { */ export interface Schema$RangeInfo { /** - * Output only. [Output only] Name of a range. + * Output only. Name of a range. */ rangeName?: string | null; /** - * Output only. [Output only] The utilization of the range. + * Output only. The utilization of the range. */ utilization?: number | null; } + /** + * RayClusterLoggingConfig specifies logging configuration for Ray clusters. + */ + export interface Schema$RayClusterLoggingConfig { + /** + * Enable log collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. + */ + export interface Schema$RayClusterMonitoringConfig { + /** + * Enable metrics collection for Ray clusters. + */ + enabled?: boolean | null; + } + /** + * Configuration options for the Ray Operator add-on. + */ + export interface Schema$RayOperatorConfig { + /** + * Whether the Ray addon is enabled for this cluster. + */ + enabled?: boolean | null; + /** + * Optional. Logging configuration for Ray clusters. + */ + rayClusterLoggingConfig?: Schema$RayClusterLoggingConfig; + /** + * Optional. Monitoring configuration for Ray clusters. + */ + rayClusterMonitoringConfig?: Schema$RayClusterMonitoringConfig; + } /** * Represents an arbitrary window of time that recurs. */ @@ -3301,7 +3347,7 @@ export namespace container_v1beta1 { */ export interface Schema$SecretManagerConfig { /** - * Whether the cluster is configured to use secret manager CSI component. + * Enable/Disable Secret Manager Config. */ enabled?: boolean | null; } @@ -4038,6 +4084,10 @@ export namespace container_v1beta1 { * Desired resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Existing tags will be replaced with new values. */ resourceManagerTags?: Schema$ResourceManagerTags; + /** + * List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools. + */ + storagePools?: string[] | null; /** * The desired network tags to be applied to all nodes in the node pool. If this field is not present, the tags will not be changed. Otherwise, the existing network tags will be *replaced* with the provided tags. */ diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index aecfcb2902..99da63a95c 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -1113,23 +1113,6 @@ export namespace containeranalysis_v1 { */ fileHash?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1144,13 +1127,9 @@ export namespace containeranalysis_v1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation; } /** * Location of the source in any accessible Git repository. @@ -1696,10 +1675,6 @@ export namespace containeranalysis_v1 { * The status of an SBOM generation. */ sbomStatus?: Schema$SBOMStatus; - /** - * The status of an vulnerability attestation generation. - */ - vulnerabilityAttestation?: Schema$VulnerabilityAttestation; } /** * This represents a particular channel of distribution for a given package. E.g., Debian's jessie-backports dpkg mirror. @@ -3175,23 +3150,6 @@ export namespace containeranalysis_v1 { */ title?: string | null; } - /** - * The status of an vulnerability attestation generation. - */ - export interface Schema$VulnerabilityAttestation { - /** - * If failure, the error reason for why the attestation generation failed. - */ - error?: string | null; - /** - * The last time we attempted to generate an attestation. - */ - lastAttemptTime?: string | null; - /** - * The success/failure state of the latest attestation attempt. - */ - state?: string | null; - } /** * A security vulnerability that can be found in resources. */ @@ -3389,57 +3347,64 @@ export namespace containeranalysis_v1 { } /** - * Gets the specified note. + * Creates new notes in batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notes$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Notes$Get, + batchCreate( + params?: Params$Resource$Projects$Locations$Notes$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Notes$Get, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notes$Get, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notes$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notes$Get; + {}) as Params$Resource$Projects$Locations$Notes$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notes$Get; + params = {} as Params$Resource$Projects$Locations$Notes$Batchcreate; options = {}; } @@ -3453,82 +3418,82 @@ export namespace containeranalysis_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/notes:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists notes for the specified project. + * Creates a new note. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notes$List, + create( + params: Params$Resource$Projects$Locations$Notes$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Notes$List, + create( + params?: Params$Resource$Projects$Locations$Notes$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Notes$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Notes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notes$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notes$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notes$List; + {}) as Params$Resource$Projects$Locations$Notes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notes$List; + params = {} as Params$Resource$Projects$Locations$Notes$Create; options = {}; } @@ -3546,7 +3511,7 @@ export namespace containeranalysis_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -3557,109 +3522,67 @@ export namespace containeranalysis_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Notes$Get - extends StandardParameters { - /** - * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notes$List - extends StandardParameters { - /** - * The filter expression. - */ - filter?: string; - /** - * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. - */ - pageSize?: number; - /** - * Token to provide to skip to a particular spot in the list. - */ - pageToken?: string; - /** - * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Notes$Occurrences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. + * Deletes the specified note. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Notes$Occurrences$List, + delete( + params?: Params$Resource$Projects$Locations$Notes$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notes$Occurrences$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notes$Occurrences$List; + {}) as Params$Resource$Projects$Locations$Notes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notes$Occurrences$List; + params = {} as Params$Resource$Projects$Locations$Notes$Delete; options = {}; } @@ -3673,11 +3596,8 @@ export namespace containeranalysis_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/occurrences').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -3688,40 +3608,760 @@ export namespace containeranalysis_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Notes$Occurrences$List - extends StandardParameters { - /** - * The filter expression. - */ - filter?: string; - /** - * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - */ - name?: string; - /** - * Number of occurrences to return in the list. - */ - pageSize?: number; /** - * Token to provide to skip to a particular spot in the list. + * Gets the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; - } + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Notes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists notes for the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/notes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Notes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Batchcreate + extends StandardParameters { + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchCreateNotesRequest; + } + export interface Params$Resource$Projects$Locations$Notes$Create + extends StandardParameters { + /** + * Required. The ID to use for this note. + */ + noteId?: string; + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Note; + } + export interface Params$Resource$Projects$Locations$Notes$Delete + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notes$Get + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notes$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + /** + * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Notes$Patch + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + /** + * The fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Note; + } + + export class Resource$Projects$Locations$Notes$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Occurrences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Occurrences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notes$Occurrences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Occurrences$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + /** + * Number of occurrences to return in the list. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates new occurrences in batch. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options: StreamMethodOptions + ): GaxiosPromise; + batchCreate( + params?: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options?: MethodOptions + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/occurrences:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Occurrences$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Create; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Occurrences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Occurrences$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** @@ -4087,8 +4727,125 @@ export namespace containeranalysis_v1 { return createAPIRequest(parameters); } } + + /** + * Updates the specified occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Occurrences$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Occurrences$Batchcreate + extends StandardParameters { + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchCreateOccurrencesRequest; } + export interface Params$Resource$Projects$Locations$Occurrences$Create + extends StandardParameters { + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. + */ + parent?: string; + /** + * Request body metadata + */ + requestBody?: Schema$Occurrence; + } + export interface Params$Resource$Projects$Locations$Occurrences$Delete + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Occurrences$Get extends StandardParameters { /** @@ -4133,6 +4890,22 @@ export namespace containeranalysis_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Occurrences$Patch + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + /** + * The fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Occurrence; + } export class Resource$Projects$Locations$Resources { context: APIRequestContext; diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 543aa56214..35b902ae01 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -1093,23 +1093,6 @@ export namespace containeranalysis_v1alpha1 { */ fileHash?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1124,13 +1107,9 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation; } /** * Location of the source in any accessible Git repository. diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index ab5692d094..be173548d1 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -1037,23 +1037,6 @@ export namespace containeranalysis_v1beta1 { */ fileHash?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1068,13 +1051,9 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$ContaineranalysisGoogleDevtoolsCloudbuildV1GCSLocation; } /** * Location of the source in any accessible Git repository. @@ -3419,57 +3398,64 @@ export namespace containeranalysis_v1beta1 { } /** - * Gets the specified note. + * Creates new notes in batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Notes$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Notes$Get, + batchCreate( + params?: Params$Resource$Projects$Locations$Notes$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Notes$Get, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Notes$Get, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Notes$Batchcreate, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notes$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notes$Get; + {}) as Params$Resource$Projects$Locations$Notes$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notes$Get; + params = {} as Params$Resource$Projects$Locations$Notes$Batchcreate; options = {}; } @@ -3483,82 +3469,82 @@ export namespace containeranalysis_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta1/{+parent}/notes:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists notes for the specified project. + * Creates a new note. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notes$List, + create( + params: Params$Resource$Projects$Locations$Notes$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Notes$List, + create( + params?: Params$Resource$Projects$Locations$Notes$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Notes$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Notes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notes$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Notes$Create, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notes$List; + {}) as Params$Resource$Projects$Locations$Notes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Notes$List; + params = {} as Params$Resource$Projects$Locations$Notes$Create; options = {}; } @@ -3576,7 +3562,7 @@ export namespace containeranalysis_v1beta1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -3587,109 +3573,67 @@ export namespace containeranalysis_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Notes$Get - extends StandardParameters { - /** - * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Notes$List - extends StandardParameters { - /** - * The filter expression. - */ - filter?: string; - /** - * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. - */ - pageSize?: number; - /** - * Token to provide to skip to a particular spot in the list. - */ - pageToken?: string; - /** - * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Notes$Occurrences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. + * Deletes the specified note. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Notes$Occurrences$List, + delete( + params?: Params$Resource$Projects$Locations$Notes$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Notes$Occurrences$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Notes$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Notes$Occurrences$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Notes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Notes$Occurrences$List; + {}) as Params$Resource$Projects$Locations$Notes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Notes$Occurrences$List; + params = {} as Params$Resource$Projects$Locations$Notes$Delete; options = {}; } @@ -3703,11 +3647,8 @@ export namespace containeranalysis_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/occurrences').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -3718,44 +3659,17 @@ export namespace containeranalysis_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Notes$Occurrences$List - extends StandardParameters { - /** - * The filter expression. - */ - filter?: string; - /** - * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. - */ - name?: string; - /** - * Number of occurrences to return in the list. - */ - pageSize?: number; - /** - * Token to provide to skip to a particular spot in the list. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Occurrences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets the specified occurrence. + * Gets the specified note. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3763,15 +3677,761 @@ export namespace containeranalysis_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Occurrences$Get, + params: Params$Resource$Projects$Locations$Notes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Occurrences$Get, + params?: Params$Resource$Projects$Locations$Notes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Occurrences$Get, + params: Params$Resource$Projects$Locations$Notes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Notes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists notes for the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/notes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Notes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Notes$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Notes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Batchcreate + extends StandardParameters { + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the notes are to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchCreateNotesRequest; + } + export interface Params$Resource$Projects$Locations$Notes$Create + extends StandardParameters { + /** + * Required. The ID to use for this note. + */ + noteId?: string; + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the note is to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Note; + } + export interface Params$Resource$Projects$Locations$Notes$Delete + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notes$Get + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Notes$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Number of notes to return in the list. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + /** + * Required. The name of the project to list notes for in the form of `projects/[PROJECT_ID]`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Notes$Patch + extends StandardParameters { + /** + * Required. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + /** + * The fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Note; + } + + export class Resource$Projects$Locations$Notes$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Notes$Occurrences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Notes$Occurrences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Notes$Occurrences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Notes$Occurrences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Notes$Occurrences$List + extends StandardParameters { + /** + * The filter expression. + */ + filter?: string; + /** + * Required. The name of the note to list occurrences for in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. + */ + name?: string; + /** + * Number of occurrences to return in the list. + */ + pageSize?: number; + /** + * Token to provide to skip to a particular spot in the list. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Occurrences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates new occurrences in batch. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options: StreamMethodOptions + ): GaxiosPromise; + batchCreate( + params?: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options?: MethodOptions + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Projects$Locations$Occurrences$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Occurrences$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+parent}/occurrences:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Occurrences$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Occurrences$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/occurrences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Occurrences$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Occurrences$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the specified occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Occurrences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Occurrences$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; @@ -4120,8 +4780,125 @@ export namespace containeranalysis_v1beta1 { return createAPIRequest(parameters); } } + + /** + * Updates the specified occurrence. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Occurrences$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Occurrences$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Occurrences$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Occurrences$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Occurrences$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://containeranalysis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Occurrences$Batchcreate + extends StandardParameters { + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrences are to be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchCreateOccurrencesRequest; } + export interface Params$Resource$Projects$Locations$Occurrences$Create + extends StandardParameters { + /** + * Required. The name of the project in the form of `projects/[PROJECT_ID]`, under which the occurrence is to be created. + */ + parent?: string; + /** + * Request body metadata + */ + requestBody?: Schema$Occurrence; + } + export interface Params$Resource$Projects$Locations$Occurrences$Delete + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Occurrences$Get extends StandardParameters { /** @@ -4166,6 +4943,22 @@ export namespace containeranalysis_v1beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Occurrences$Patch + extends StandardParameters { + /** + * Required. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. + */ + name?: string; + /** + * The fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Occurrence; + } export class Resource$Projects$Locations$Resources { context: APIRequestContext; diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index b7000388a4..882f1fe752 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -3437,6 +3437,10 @@ export namespace content_v2_1 { * Optional. The amount of loyalty points earned on a purchase. */ loyaltyPoints?: string | null; + /** + * Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + */ + memberPriceEffectiveDate?: string | null; /** * Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. */ @@ -6349,7 +6353,7 @@ export namespace content_v2_1 { */ sizeType?: string | null; /** - * The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + * Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" */ source?: string | null; /** diff --git a/src/apis/contentwarehouse/v1.ts b/src/apis/contentwarehouse/v1.ts index c5a5aa40f7..917ebee321 100644 --- a/src/apis/contentwarehouse/v1.ts +++ b/src/apis/contentwarehouse/v1.ts @@ -2153,10 +2153,18 @@ export namespace contentwarehouse_v1 { * Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality. */ export interface Schema$GoogleCloudDocumentaiV1Document { + /** + * Document chunked based on chunking config. + */ + chunkedDocument?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocument; /** * Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. */ content?: string | null; + /** + * Parsed layout of the document. + */ + documentLayout?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayout; /** * A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. */ @@ -2202,6 +2210,212 @@ export namespace contentwarehouse_v1 { */ uri?: string | null; } + /** + * Represents the chunks that the document is divided into. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocument { + /** + * List of chunks. + */ + chunks?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk[]; + } + /** + * Represents a chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk { + /** + * ID of the chunk. + */ + chunkId?: string | null; + /** + * Text content of the chunk. + */ + content?: string | null; + /** + * Page footers associated with the chunk. + */ + pageFooters?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter[]; + /** + * Page headers associated with the chunk. + */ + pageHeaders?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader[]; + /** + * Page span of the chunk. + */ + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + /** + * Unused. + */ + sourceBlockIds?: string[] | null; + } + /** + * Represents the page footer associated with the chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter { + /** + * Page span of the footer. + */ + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + /** + * Footer in text format. + */ + text?: string | null; + } + /** + * Represents the page header associated with the chunk. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader { + /** + * Page span of the header. + */ + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan; + /** + * Header in text format. + */ + text?: string | null; + } + /** + * Represents where the chunk starts and ends in the document. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan { + /** + * Page where chunk ends in the document. + */ + pageEnd?: number | null; + /** + * Page where chunk starts in the document. + */ + pageStart?: number | null; + } + /** + * Represents the parsed layout of a document as a collection of blocks that the document is divided into. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayout { + /** + * List of blocks in the document. + */ + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + } + /** + * Represents a block. A block could be one of the various types (text, table, list) supported. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock { + /** + * ID of the block. + */ + blockId?: string | null; + /** + * Block consisting of list content/structure. + */ + listBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock; + /** + * Page span of the block. + */ + pageSpan?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan; + /** + * Block consisting of table content/structure. + */ + tableBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock; + /** + * Block consisting of text content. + */ + textBlock?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock; + } + /** + * Represents a list type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock { + /** + * List entries that constitute a list block. + */ + listEntries?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry[]; + /** + * Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + */ + type?: string | null; + } + /** + * Represents an entry in the list. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry { + /** + * A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + */ + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + } + /** + * Represents where the block starts and ends in the document. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan { + /** + * Page where block ends in the document. + */ + pageEnd?: number | null; + /** + * Page where block starts in the document. + */ + pageStart?: number | null; + } + /** + * Represents a table type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock { + /** + * Body rows containing main table content. + */ + bodyRows?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; + /** + * Table caption/title. + */ + caption?: string | null; + /** + * Header rows at the top of the table. + */ + headerRows?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow[]; + } + /** + * Represents a cell in a table row. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell { + /** + * A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + */ + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + /** + * How many columns this cell spans. + */ + colSpan?: number | null; + /** + * How many rows this cell spans. + */ + rowSpan?: number | null; + } + /** + * Represents a row in a table. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow { + /** + * A table row is a list of table cells. + */ + cells?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell[]; + } + /** + * Represents a text type block. + */ + export interface Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock { + /** + * A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + */ + blocks?: Schema$GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock[]; + /** + * Text content stored in the block. + */ + text?: string | null; + /** + * Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + */ + type?: string | null; + } /** * An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. */ diff --git a/src/apis/css/README.md b/src/apis/css/README.md new file mode 100644 index 0000000000..3ee0d3d019 --- /dev/null +++ b/src/apis/css/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# css + +> Programmatically manage your Comparison Shopping Service (CSS) account data at scale. + +## Installation + +```sh +$ npm install @googleapis/css +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/css/classes/Css.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/css/index.ts b/src/apis/css/index.ts new file mode 100644 index 0000000000..839020f224 --- /dev/null +++ b/src/apis/css/index.ts @@ -0,0 +1,44 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {css_v1} from './v1'; + +export const VERSIONS = { + v1: css_v1.Css, +}; + +export function css(version: 'v1'): css_v1.Css; +export function css(options: css_v1.Options): css_v1.Css; +export function css( + this: GoogleConfigurable, + versionOrOptions: 'v1' | css_v1.Options +) { + return getAPI('css', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {css_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/css/package.json b/src/apis/css/package.json new file mode 100644 index 0000000000..8926e93759 --- /dev/null +++ b/src/apis/css/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/css", + "version": "0.1.0", + "description": "css", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/css/tsconfig.json b/src/apis/css/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/css/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/css/v1.ts b/src/apis/css/v1.ts new file mode 100644 index 0000000000..fd3e0159e9 --- /dev/null +++ b/src/apis/css/v1.ts @@ -0,0 +1,1844 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace css_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * CSS API + * + * Programmatically manage your Comparison Shopping Service (CSS) account data at scale. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const css = google.css('v1'); + * ``` + */ + export class Css { + context: APIRequestContext; + accounts: Resource$Accounts; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.accounts = new Resource$Accounts(this.context); + } + } + + /** + * Information about CSS/MC account. + */ + export interface Schema$Account { + /** + * Output only. The type of this account. + */ + accountType?: string | null; + /** + * Automatically created label IDs assigned to the MC account by CSS Center. + */ + automaticLabelIds?: string[] | null; + /** + * The CSS/MC account's short display name. + */ + displayName?: string | null; + /** + * Output only. Immutable. The CSS/MC account's full name. + */ + fullName?: string | null; + /** + * Output only. Immutable. The CSS/MC account's homepage. + */ + homepageUri?: string | null; + /** + * Manually created label IDs assigned to the CSS/MC account by a CSS parent account. + */ + labelIds?: string[] | null; + /** + * The label resource name. Format: accounts/{account\} + */ + name?: string | null; + /** + * The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. + */ + parent?: string | null; + } + /** + * Label assigned by CSS domain or CSS group to one of its sub-accounts. + */ + export interface Schema$AccountLabel { + /** + * Output only. The ID of account this label belongs to. + */ + accountId?: string | null; + /** + * The description of this label. + */ + description?: string | null; + /** + * The display name of this label. + */ + displayName?: string | null; + /** + * Output only. The ID of the label. + */ + labelId?: string | null; + /** + * Output only. The type of this label. + */ + labelType?: string | null; + /** + * The resource name of the label. Format: accounts/{account\}/labels/{label\} + */ + name?: string | null; + } + /** + * Attributes for CSS Product. + */ + export interface Schema$Attributes { + /** + * Additional URL of images of the item. + */ + additionalImageLinks?: string[] | null; + /** + * Set to true if the item is targeted towards adults. + */ + adult?: boolean | null; + /** + * Target age group of the item. + */ + ageGroup?: string | null; + /** + * Product Related Attributes.[14-36] Brand of the item. + */ + brand?: string | null; + /** + * A list of certificates claimed by the CSS for the given product. + */ + certifications?: Schema$Certification[]; + /** + * Color of the item. + */ + color?: string | null; + /** + * Allows advertisers to override the item URL when the product is shown within the context of Product Ads. + */ + cppAdsRedirect?: string | null; + /** + * URL directly linking to your the Product Detail Page of the CSS. + */ + cppLink?: string | null; + /** + * URL for the mobile-optimized version of the Product Detail Page of the CSS. + */ + cppMobileLink?: string | null; + /** + * Custom label 0 for custom grouping of items in a Shopping campaign. + */ + customLabel0?: string | null; + /** + * Custom label 1 for custom grouping of items in a Shopping campaign. + */ + customLabel1?: string | null; + /** + * Custom label 2 for custom grouping of items in a Shopping campaign. + */ + customLabel2?: string | null; + /** + * Custom label 3 for custom grouping of items in a Shopping campaign. + */ + customLabel3?: string | null; + /** + * Custom label 4 for custom grouping of items in a Shopping campaign. + */ + customLabel4?: string | null; + /** + * Description of the item. + */ + description?: string | null; + /** + * The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). + */ + excludedDestinations?: string[] | null; + /** + * Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted. + */ + expirationDate?: string | null; + /** + * Target gender of the item. + */ + gender?: string | null; + /** + * Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API. + */ + googleProductCategory?: string | null; + /** + * Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item. + */ + gtin?: string | null; + /** + * Condition of the headline offer. + */ + headlineOfferCondition?: string | null; + /** + * Link to the headline offer. + */ + headlineOfferLink?: string | null; + /** + * Mobile Link to the headline offer. + */ + headlineOfferMobileLink?: string | null; + /** + * Headline Price of the aggregate offer. + */ + headlineOfferPrice?: Schema$Price; + /** + * Headline Price of the aggregate offer. + */ + headlineOfferShippingPrice?: Schema$Price; + /** + * High Price of the aggregate offer. + */ + highPrice?: Schema$Price; + /** + * URL of an image of the item. + */ + imageLink?: string | null; + /** + * The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`. + */ + includedDestinations?: string[] | null; + /** + * Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. + */ + isBundle?: boolean | null; + /** + * Shared identifier for all variants of the same product. + */ + itemGroupId?: string | null; + /** + * Low Price of the aggregate offer. + */ + lowPrice?: Schema$Price; + /** + * The material of which the item is made. + */ + material?: string | null; + /** + * Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. + */ + mpn?: string | null; + /** + * The number of identical products in a merchant-defined multipack. + */ + multipack?: string | null; + /** + * The number of aggregate offers. + */ + numberOfOffers?: string | null; + /** + * The item's pattern (e.g. polka dots). + */ + pattern?: string | null; + /** + * Publication of this item will be temporarily paused. + */ + pause?: string | null; + /** + * Technical specification or additional product details. + */ + productDetails?: Schema$ProductDetail[]; + /** + * The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). + */ + productHeight?: Schema$ProductDimension; + /** + * Bullet points describing the most relevant highlights of a product. + */ + productHighlights?: string[] | null; + /** + * The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). + */ + productLength?: Schema$ProductDimension; + /** + * Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)). + */ + productTypes?: string[] | null; + /** + * The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive). + */ + productWeight?: Schema$ProductWeight; + /** + * The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive). + */ + productWidth?: Schema$ProductDimension; + /** + * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). + */ + size?: string | null; + /** + * System in which the size is specified. Recommended for apparel items. + */ + sizeSystem?: string | null; + /** + * The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)). + */ + sizeTypes?: string[] | null; + /** + * Title of the item. + */ + title?: string | null; + } + /** + * The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + */ + export interface Schema$Certification { + /** + * The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + */ + authority?: string | null; + /** + * The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + */ + code?: string | null; + /** + * The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. + */ + name?: string | null; + } + /** + * The processed CSS Product(a.k.a Aggregate Offer internally). + */ + export interface Schema$CssProduct { + /** + * Output only. A list of product attributes. + */ + attributes?: Schema$Attributes; + /** + * Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. + */ + contentLanguage?: string | null; + /** + * Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously. + */ + cssProductStatus?: Schema$CssProductStatus; + /** + * Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" \}`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. + */ + customAttributes?: Schema$CustomAttribute[]; + /** + * Output only. The feed label for the product. + */ + feedLabel?: string | null; + /** + * The name of the CSS Product. Format: `"accounts/{account\}/cssProducts/{css_product\}"` + */ + name?: string | null; + /** + * Output only. Your unique raw identifier for the product. + */ + rawProvidedId?: string | null; + } + /** + * This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces. + */ + export interface Schema$CssProductInput { + /** + * A list of CSS Product attributes. + */ + attributes?: Schema$Attributes; + /** + * Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product. + */ + contentLanguage?: string | null; + /** + * A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ "name": "size type", "value": "regular" \}`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google. + */ + customAttributes?: Schema$CustomAttribute[]; + /** + * Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. + */ + feedLabel?: string | null; + /** + * Output only. The name of the processed CSS Product. Format: `accounts/{account\}/cssProducts/{css_product\}` " + */ + finalName?: string | null; + /** + * Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. + */ + freshnessTime?: string | null; + /** + * The name of the CSS Product input. Format: `accounts/{account\}/cssProductInputs/{css_product_input\}` + */ + name?: string | null; + /** + * Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details. + */ + rawProvidedId?: string | null; + } + /** + * The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously. + */ + export interface Schema$CssProductStatus { + /** + * Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. + */ + creationDate?: string | null; + /** + * The intended destinations for the product. + */ + destinationStatuses?: Schema$DestinationStatus[]; + /** + * Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. + */ + googleExpirationDate?: string | null; + /** + * A list of all issues associated with the product. + */ + itemLevelIssues?: Schema$ItemLevelIssue[]; + /** + * Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. + */ + lastUpdateDate?: string | null; + } + /** + * A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. + */ + export interface Schema$CustomAttribute { + /** + * Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. + */ + groupValues?: Schema$CustomAttribute[]; + /** + * The name of the attribute. + */ + name?: string | null; + /** + * The value of the attribute. If `value` is not empty, `group_values` must be empty. + */ + value?: string | null; + } + /** + * The destination status of the product status. + */ + export interface Schema$DestinationStatus { + /** + * List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved. + */ + approvedCountries?: string[] | null; + /** + * The name of the destination + */ + destination?: string | null; + /** + * List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved. + */ + disapprovedCountries?: string[] | null; + /** + * List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval. + */ + pendingCountries?: string[] | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * The ItemLevelIssue of the product status. + */ + export interface Schema$ItemLevelIssue { + /** + * List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer. + */ + applicableCountries?: string[] | null; + /** + * The attribute's name, if the issue is caused by a single attribute. + */ + attribute?: string | null; + /** + * The error code of the issue. + */ + code?: string | null; + /** + * A short issue description in English. + */ + description?: string | null; + /** + * The destination the issue applies to. + */ + destination?: string | null; + /** + * A detailed issue description in English. + */ + detail?: string | null; + /** + * The URL of a web page to help with resolving this issue. + */ + documentation?: string | null; + /** + * Whether the issue can be resolved by the merchant. + */ + resolution?: string | null; + /** + * How this issue affects serving of the aggregate offer. + */ + servability?: string | null; + } + /** + * Response message for the `ListAccountLabels` method. + */ + export interface Schema$ListAccountLabelsResponse { + /** + * The labels from the specified account. + */ + accountLabels?: Schema$AccountLabel[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for the `ListChildAccounts` method. + */ + export interface Schema$ListChildAccountsResponse { + /** + * The CSS/MC accounts returned for the specified CSS parent account. + */ + accounts?: Schema$Account[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for the ListCssProducts method. + */ + export interface Schema$ListCssProductsResponse { + /** + * The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds. + */ + cssProducts?: Schema$CssProduct[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * The price represented as a number and currency. + */ + export interface Schema$Price { + /** + * The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). + */ + amountMicros?: string | null; + /** + * The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). + */ + currencyCode?: string | null; + } + /** + * The product details. + */ + export interface Schema$ProductDetail { + /** + * The name of the product detail. + */ + attributeName?: string | null; + /** + * The value of the product detail. + */ + attributeValue?: string | null; + /** + * The section header used to group a set of product details. + */ + sectionName?: string | null; + } + /** + * The dimension of the product. + */ + export interface Schema$ProductDimension { + /** + * Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" + */ + unit?: string | null; + /** + * Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. + */ + value?: number | null; + } + /** + * The weight of the product. + */ + export interface Schema$ProductWeight { + /** + * Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`" + */ + unit?: string | null; + /** + * Required. The weight represented as a number. The weight can have a maximum precision of four decimal places. + */ + value?: number | null; + } + /** + * The request message for the `UpdateLabels` method. + */ + export interface Schema$UpdateAccountLabelsRequest { + /** + * The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted. + */ + labelIds?: string[] | null; + /** + * Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account\} + */ + parent?: string | null; + } + + export class Resource$Accounts { + context: APIRequestContext; + cssProductInputs: Resource$Accounts$Cssproductinputs; + cssProducts: Resource$Accounts$Cssproducts; + labels: Resource$Accounts$Labels; + constructor(context: APIRequestContext) { + this.context = context; + this.cssProductInputs = new Resource$Accounts$Cssproductinputs( + this.context + ); + this.cssProducts = new Resource$Accounts$Cssproducts(this.context); + this.labels = new Resource$Accounts$Labels(this.context); + } + + /** + * Retrieves a single CSS/MC account by ID. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + options: StreamMethodOptions + ): GaxiosPromise; + listChildAccounts( + params?: Params$Resource$Accounts$Listchildaccounts, + options?: MethodOptions + ): GaxiosPromise; + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listChildAccounts( + params: Params$Resource$Accounts$Listchildaccounts, + callback: BodyResponseCallback + ): void; + listChildAccounts( + callback: BodyResponseCallback + ): void; + listChildAccounts( + paramsOrCallback?: + | Params$Resource$Accounts$Listchildaccounts + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Listchildaccounts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Listchildaccounts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:listChildAccounts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates labels assigned to CSS/MC accounts by a CSS domain. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + options: StreamMethodOptions + ): GaxiosPromise; + updateLabels( + params?: Params$Resource$Accounts$Updatelabels, + options?: MethodOptions + ): GaxiosPromise; + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLabels( + params: Params$Resource$Accounts$Updatelabels, + callback: BodyResponseCallback + ): void; + updateLabels(callback: BodyResponseCallback): void; + updateLabels( + paramsOrCallback?: + | Params$Resource$Accounts$Updatelabels + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Updatelabels; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Updatelabels; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:updateLabels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Required. The name of the managed CSS/MC account. Format: accounts/{account\} + */ + name?: string; + /** + * Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Listchildaccounts + extends StandardParameters { + /** + * If set, only the MC accounts with the given name (case sensitive) will be returned. + */ + fullName?: string; + /** + * If set, only the MC accounts with the given label ID will be returned. + */ + labelId?: string; + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent account. Must be a CSS group or domain. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Updatelabels + extends StandardParameters { + /** + * Required. The label resource name. Format: accounts/{account\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpdateAccountLabelsRequest; + } + + export class Resource$Accounts$Cssproductinputs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Accounts$Cssproductinputs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Cssproductinputs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproductinputs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproductinputs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproductinputs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + options: StreamMethodOptions + ): GaxiosPromise; + insert( + params?: Params$Resource$Accounts$Cssproductinputs$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Accounts$Cssproductinputs$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproductinputs$Insert + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproductinputs$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproductinputs$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cssProductInputs:insert').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Cssproductinputs$Delete + extends StandardParameters { + /** + * Required. The name of the CSS product input resource to delete. Format: accounts/{account\}/cssProductInputs/{css_product_input\} + */ + name?: string; + /** + * The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed. + */ + supplementalFeedId?: string; + } + export interface Params$Resource$Accounts$Cssproductinputs$Insert + extends StandardParameters { + /** + * Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet. + */ + feedId?: string; + /** + * Required. The account where this CSS Product will be inserted. Format: accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CssProductInput; + } + + export class Resource$Accounts$Cssproducts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Accounts$Cssproducts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Accounts$Cssproducts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Cssproducts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Cssproducts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Cssproducts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproducts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproducts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproducts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Cssproducts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Cssproducts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Cssproducts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Cssproducts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Cssproducts$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Cssproducts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Cssproducts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Cssproducts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/cssProducts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Cssproducts$Get + extends StandardParameters { + /** + * Required. The name of the CSS product to retrieve. + */ + name?: string; + } + export interface Params$Resource$Accounts$Cssproducts$List + extends StandardParameters { + /** + * The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The account/domain to list processed CSS Products for. Format: accounts/{account\} + */ + parent?: string; + } + + export class Resource$Accounts$Labels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new label, not assigned to any account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Accounts$Labels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Accounts$Labels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Accounts$Labels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Labels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Accounts$Labels$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/labels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a label and removes it from all accounts to which it was assigned. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Accounts$Labels$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Accounts$Labels$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Accounts$Labels$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Labels$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Accounts$Labels$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the labels assigned to an account. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Accounts$Labels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Accounts$Labels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$Labels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Labels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$Labels$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/labels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a label. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Accounts$Labels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Accounts$Labels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Labels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Labels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Accounts$Labels$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Accounts$Labels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Labels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Labels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://css.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Accounts$Labels$Create + extends StandardParameters { + /** + * Required. The parent account. Format: accounts/{account\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountLabel; + } + export interface Params$Resource$Accounts$Labels$Delete + extends StandardParameters { + /** + * Required. The name of the label to delete. Format: accounts/{account\}/labels/{label\} + */ + name?: string; + } + export interface Params$Resource$Accounts$Labels$List + extends StandardParameters { + /** + * The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent account. Format: accounts/{account\} + */ + parent?: string; + } + export interface Params$Resource$Accounts$Labels$Patch + extends StandardParameters { + /** + * The resource name of the label. Format: accounts/{account\}/labels/{label\} + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AccountLabel; + } +} diff --git a/src/apis/css/webpack.config.js b/src/apis/css/webpack.config.js new file mode 100644 index 0000000000..625b3a2497 --- /dev/null +++ b/src/apis/css/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Css', + filename: 'css.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/dataform/v1beta1.ts b/src/apis/dataform/v1beta1.ts index f80f6c9e40..f19b6be436 100644 --- a/src/apis/dataform/v1beta1.ts +++ b/src/apis/dataform/v1beta1.ts @@ -365,6 +365,10 @@ export namespace dataform_v1beta1 { * Output only. Errors encountered during project compilation. */ compilationErrors?: Schema$CompilationError[]; + /** + * Output only. The timestamp of when the compilation result was created. + */ + createTime?: string | null; /** * Output only. Only set if the repository has a KMS Key. */ @@ -1429,6 +1433,10 @@ export namespace dataform_v1beta1 { * Represents a Dataform workflow configuration. */ export interface Schema$WorkflowConfig { + /** + * Output only. The timestamp of when the WorkflowConfig was created. + */ + createTime?: string | null; /** * Optional. Optional schedule (in cron format) for automatic execution of this workflow config. */ @@ -1453,6 +1461,10 @@ export namespace dataform_v1beta1 { * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. */ timeZone?: string | null; + /** + * Output only. The timestamp of when the WorkflowConfig was last updated. + */ + updateTime?: string | null; } /** * Represents a single invocation of a compilation result. diff --git a/src/apis/datafusion/v1.ts b/src/apis/datafusion/v1.ts index aa1bb6667c..de8f95523d 100644 --- a/src/apis/datafusion/v1.ts +++ b/src/apis/datafusion/v1.ts @@ -137,6 +137,27 @@ export namespace datafusion_v1 { */ state?: string | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. */ @@ -180,10 +201,23 @@ export namespace datafusion_v1 { */ role?: string | null; } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. */ @@ -193,6 +227,9 @@ export namespace datafusion_v1 { */ keyReference?: string | null; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. */ @@ -256,6 +293,15 @@ export namespace datafusion_v1 { */ title?: string | null; } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * Represents a Data Fusion instance. */ @@ -401,6 +447,21 @@ export namespace datafusion_v1 { */ zone?: string | null; } + export interface Schema$IsolationExpectations { + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response message for the list available versions request. */ @@ -495,6 +556,18 @@ export namespace datafusion_v1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * Maintenance policy of the instance. */ @@ -600,6 +673,15 @@ export namespace datafusion_v1 { */ verb?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } /** * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ @@ -651,6 +733,19 @@ export namespace datafusion_v1 { */ window?: Schema$TimeWindow; } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } /** * Request message for restarting a Data Fusion instance. */ @@ -668,6 +763,16 @@ export namespace datafusion_v1 { */ updateMask?: string | null; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * 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). */ @@ -685,6 +790,9 @@ export namespace datafusion_v1 { */ message?: string | null; } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Request message for `TestIamPermissions` method. */ @@ -737,6 +845,9 @@ export namespace datafusion_v1 { */ versionNumber?: string | null; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index 832e1b62af..68c644122e 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -137,6 +137,27 @@ export namespace datafusion_v1beta1 { */ state?: string | null; } + /** + * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. + */ + export interface Schema$AssetLocation { + /** + * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. + */ + expected?: Schema$IsolationExpectations; + /** + * Defines extra parameters required for specific asset types. + */ + extraParameters?: Schema$ExtraParameter[]; + /** + * Contains all kinds of physical location definitions for this asset. + */ + locationData?: Schema$LocationData[]; + /** + * Defines parents assets if any in order to allow later generation of child_asset_location data via child assets. + */ + parentAsset?: Schema$CloudAsset[]; + } /** * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] \}, { "log_type": "DATA_WRITE" \}, { "log_type": "ADMIN_READ" \} ] \}, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" \}, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] \} ] \} ] \} For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging. */ @@ -180,10 +201,23 @@ export namespace datafusion_v1beta1 { */ role?: string | null; } + /** + * Policy ID that identified data placement in Blobstore as per go/blobstore-user-guide#data-metadata-placement-and-failure-domains + */ + export interface Schema$BlobstoreLocation { + policyId?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + export interface Schema$CloudAsset { + assetName?: string | null; + assetType?: string | null; + } + export interface Schema$CloudAssetComposition { + childAsset?: Schema$CloudAsset[]; + } /** * The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. */ @@ -193,6 +227,9 @@ export namespace datafusion_v1beta1 { */ keyReference?: string | null; } + export interface Schema$DirectLocationAssignment { + location?: Schema$LocationAssignment[]; + } /** * DNS peering configuration. These configurations are used to create DNS peering with the customer Cloud DNS. */ @@ -256,6 +293,15 @@ export namespace datafusion_v1beta1 { */ title?: string | null; } + /** + * Defines parameters that should only be used for specific asset types. + */ + export interface Schema$ExtraParameter { + /** + * Details about zones used by regional compute.googleapis.com/InstanceGroupManager to create instances. + */ + regionalMigDistributionPolicy?: Schema$RegionalMigDistributionPolicy; + } /** * IAMPolicy encapsulates the IAM policy name, definition and status of policy fetching. */ @@ -414,6 +460,21 @@ export namespace datafusion_v1beta1 { */ zone?: string | null; } + export interface Schema$IsolationExpectations { + ziOrgPolicy?: string | null; + ziRegionPolicy?: string | null; + ziRegionState?: string | null; + /** + * Deprecated: use zi_org_policy, zi_region_policy and zi_region_state instead for setting ZI expectations as per go/zicy-publish-physical-location. + */ + zoneIsolation?: string | null; + /** + * Deprecated: use zs_org_policy, and zs_region_stateinstead for setting Zs expectations as per go/zicy-publish-physical-location. + */ + zoneSeparation?: string | null; + zsOrgPolicy?: string | null; + zsRegionState?: string | null; + } /** * Response message for the list available versions request. */ @@ -521,6 +582,18 @@ export namespace datafusion_v1beta1 { */ name?: string | null; } + export interface Schema$LocationAssignment { + location?: string | null; + locationType?: string | null; + } + export interface Schema$LocationData { + blobstoreLocation?: Schema$BlobstoreLocation; + childAssetLocation?: Schema$CloudAssetComposition; + directLocation?: Schema$DirectLocationAssignment; + gcpProjectProxy?: Schema$TenantProjectProxy; + placerLocation?: Schema$PlacerLocation; + spannerLocation?: Schema$SpannerLocation; + } /** * Maintenance policy of the instance. */ @@ -639,6 +712,15 @@ export namespace datafusion_v1beta1 { */ verb?: string | null; } + /** + * Message describing that the location of the customer resource is tied to placer allocations + */ + export interface Schema$PlacerLocation { + /** + * Directory with a config related to it in placer (e.g. "/placer/prod/home/my-root/my-dir") + */ + placerConfig?: string | null; + } /** * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ @@ -690,6 +772,19 @@ export namespace datafusion_v1beta1 { */ window?: Schema$TimeWindow; } + /** + * To be used for specifying the intended distribution of regional compute.googleapis.com/InstanceGroupManager instances + */ + export interface Schema$RegionalMigDistributionPolicy { + /** + * The shape in which the group converges around distribution of resources. Instance of proto2 enum + */ + targetShape?: number | null; + /** + * Cloud zones used by regional MIG to create instances. + */ + zones?: Schema$ZoneConfiguration[]; + } /** * Request message for RemoveIamPolicy method. */ @@ -715,6 +810,16 @@ export namespace datafusion_v1beta1 { */ updateMask?: string | null; } + export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ + dbName?: string[] | null; + } /** * 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). */ @@ -732,6 +837,9 @@ export namespace datafusion_v1beta1 { */ message?: string | null; } + export interface Schema$TenantProjectProxy { + projectNumbers?: string[] | null; + } /** * Request message for `TestIamPermissions` method. */ @@ -788,6 +896,9 @@ export namespace datafusion_v1beta1 { */ versionNumber?: string | null; } + export interface Schema$ZoneConfiguration { + zone?: string | null; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/datamigration/v1.ts b/src/apis/datamigration/v1.ts index d4672b3713..e39158a665 100644 --- a/src/apis/datamigration/v1.ts +++ b/src/apis/datamigration/v1.ts @@ -1753,6 +1753,39 @@ export namespace datamigration_v1 { */ response?: {[key: string]: any} | null; } + /** + * Configuration for Oracle Automatic Storage Management (ASM) connection. + */ + export interface Schema$OracleAsmConfig { + /** + * Required. ASM service name for the Oracle ASM connection. + */ + asmService?: string | null; + /** + * Required. Hostname for the Oracle ASM connection. + */ + hostname?: string | null; + /** + * Required. Input only. Password for the Oracle ASM connection. + */ + password?: string | null; + /** + * Output only. Indicates whether a new password is included in the request. + */ + passwordSet?: boolean | null; + /** + * Required. Port for the Oracle ASM connection. + */ + port?: number | null; + /** + * Optional. SSL configuration for the Oracle connection. + */ + ssl?: Schema$SslConfig; + /** + * Required. Username for the Oracle ASM connection. + */ + username?: string | null; + } /** * Specifies connection parameters required specifically for Oracle databases. */ @@ -1769,6 +1802,10 @@ export namespace datamigration_v1 { * Required. The IP or hostname of the source Oracle database. */ host?: string | null; + /** + * Optional. Configuration for Oracle ASM connection. + */ + oracleAsmConfig?: Schema$OracleAsmConfig; /** * Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service. */ @@ -2455,6 +2492,10 @@ export namespace datamigration_v1 { * Required. Backup details per database in Cloud Storage. */ databaseBackups?: Schema$SqlServerDatabaseBackup[]; + /** + * Optional. Promote databases when ready. + */ + promoteWhenReady?: boolean | null; /** * Optional. Enable differential backups. */ @@ -6283,8 +6324,12 @@ export namespace datamigration_v1 { export class Resource$Projects$Locations$Migrationjobs { context: APIRequestContext; + objects: Resource$Projects$Locations$Migrationjobs$Objects; constructor(context: APIRequestContext) { this.context = context; + this.objects = new Resource$Projects$Locations$Migrationjobs$Objects( + this.context + ); } /** @@ -8030,6 +8075,326 @@ export namespace datamigration_v1 { requestBody?: Schema$VerifyMigrationJobRequest; } + export class Resource$Projects$Locations$Migrationjobs$Objects { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://datamigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://datamigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://datamigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Migrationjobs$Objects$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Migrationjobs$Objects$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Migrationjobs$Objects$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index bd2eca6908..cf8773e069 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -112,6 +112,7 @@ export namespace dataplex_v1 { */ export class Dataplex { context: APIRequestContext; + organizations: Resource$Organizations; projects: Resource$Projects; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace dataplex_v1 { google, }; + this.organizations = new Resource$Organizations(this.context); this.projects = new Resource$Projects(this.context); } } @@ -277,6 +279,9 @@ export namespace dataplex_v1 { * An aspect is a single piece of metadata describing an entry. */ export interface Schema$GoogleCloudDataplexV1Aspect { + /** + * Optional. Information related to the source system of the aspect. + */ aspectSource?: Schema$GoogleCloudDataplexV1AspectSource; /** * Output only. The resource name of the type used to create this Aspect. @@ -287,7 +292,7 @@ export namespace dataplex_v1 { */ createTime?: string | null; /** - * Required. The content of the aspect, according to its aspect type schema. This will replace content. The maximum size of the field is 120KB (encoded as UTF-8). + * Required. The content of the aspect, according to its aspect type schema. The maximum size of the field is 120KB (encoded as UTF-8). */ data?: {[key: string]: any} | null; /** @@ -300,24 +305,24 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * AspectSource contains source system related information for the aspect. + * Information related to the source system of the aspect. */ export interface Schema$GoogleCloudDataplexV1AspectSource { /** - * The create time of the aspect in the source system. + * The time the aspect was created in the source system. */ createTime?: string | null; /** - * The update time of the aspect in the source system. + * The time the aspect was last updated in the source system. */ updateTime?: string | null; } /** - * Aspect Type is a template for creating Aspects, and represents the JSON-schema for a given Entry, e.g., BigQuery Table Schema. + * AspectType is a template for creating Aspects, and represents the JSON-schema for a given Entry, for example, BigQuery Table Schema. */ export interface Schema$GoogleCloudDataplexV1AspectType { /** - * Immutable. Authorization defined for this type. + * Immutable. Defines the Authorization for this type. */ authorization?: Schema$GoogleCloudDataplexV1AspectTypeAuthorization; /** @@ -333,7 +338,7 @@ export namespace dataplex_v1 { */ displayName?: string | null; /** - * This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * The service computes this checksum. The client may send it on update and delete requests to ensure it has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -349,11 +354,7 @@ export namespace dataplex_v1 { */ name?: string | null; /** - * Output only. Denotes the transfer status of the Aspect Type. It is unspecified for Aspect Types created from Dataplex API. - */ - transferStatus?: string | null; - /** - * Output only. System generated globally unique ID for the AspectType. This ID will be different if the AspectType is deleted and re-created with the same name. + * Output only. System generated globally unique ID for the AspectType. If you delete and recreate the AspectType with the same name, then this ID will be different. */ uid?: string | null; /** @@ -362,16 +363,16 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * Autorization for an Aspect Type. + * Autorization for an AspectType. */ export interface Schema$GoogleCloudDataplexV1AspectTypeAuthorization { /** - * Immutable. The IAM permission grantable on the Entry Group to allow access to instantiate Aspects of Dataplex owned Aspect Types, only settable for Dataplex owned Types. + * Immutable. The IAM permission grantable on the EntryGroup to allow access to instantiate Aspects of Dataplex owned AspectTypes, only settable for Dataplex owned Types. */ alternateUsePermission?: string | null; } /** - * MetadataTemplate definition for AspectType + * MetadataTemplate definition for an AspectType. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate { /** @@ -379,7 +380,7 @@ export namespace dataplex_v1 { */ annotations?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations; /** - * Optional. array_items needs to be set if the type is array. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. + * Optional. If the type is array, set array_items. array_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload. */ arrayItems?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; /** @@ -387,7 +388,7 @@ export namespace dataplex_v1 { */ constraints?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints; /** - * Optional. The list of values for an enum type. Needs to be defined if the type is enum. + * Optional. The list of values for an enum type. You must define it if the type is enum. */ enumValues?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue[]; /** @@ -395,7 +396,7 @@ export namespace dataplex_v1 { */ index?: number | null; /** - * Optional. map_items needs to be set if the type is map. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, just name and type needs to be set in the nested MetadataTemplate. The recommended value for the name field is item, as this is not used in the actual payload. + * Optional. If the type is map, set map_items. map_items can refer to a primitive field or a complex (record only) field. To specify a primitive field, you only need to set name and type in the nested MetadataTemplate. The recommended value for the name field is item, as this isn't used in the actual payload. */ mapItems?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate; /** @@ -403,74 +404,74 @@ export namespace dataplex_v1 { */ name?: string | null; /** - * Optional. Field definition, needs to be specified if the type is record. Defines the nested fields. + * Optional. Field definition. You must specify it if the type is record. It defines the nested fields. */ recordFields?: Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplate[]; /** - * Required. The datatype of this field. The following values are supported: Primitive types (string, integer, boolean, double, datetime); datetime must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z"). Complex types (enum, array, map, record). + * Required. The datatype of this field. The following values are supported:Primitive types: string integer boolean double datetime. Must be of the format RFC3339 UTC "Zulu" (Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z").Complex types: enum array map record */ type?: string | null; /** - * Optional. Id can be used if this definition of the field needs to be reused later. Id needs to be unique across the entire template. Id can only be specified if the field type is record. + * Optional. You can use type id if this definition of the field needs to be reused later. The type id must be unique across the entire template. You can only specify it if the field type is record. */ typeId?: string | null; /** - * Optional. A reference to another field definition (instead of an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with type as record can refer to other fields. + * Optional. A reference to another field definition (not an inline definition). The value must be equal to the value of an id field defined elsewhere in the MetadataTemplate. Only fields with record type can refer to other fields. */ typeRef?: string | null; } /** - * Definition of the annotations of a field + * Definition of the annotations of a field. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateAnnotations { /** - * Optional. Marks a field as deprecated, a deprecation message can be included. + * Optional. Marks a field as deprecated. You can include a deprecation message. */ deprecated?: string | null; /** - * Optional. Specify a description for a field + * Optional. Description for a field. */ description?: string | null; /** - * Optional. Specify a displayname for a field. + * Optional. Display name for a field. */ displayName?: string | null; /** - * Optional. Specify a display order for a field. Display order can be used to reorder where a field is rendered + * Optional. Display order for a field. You can use this to reorder where a field is rendered. */ displayOrder?: number | null; /** - * Optional. String Type annotations can be used to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified url link. resource: A service qualified resource reference. + * Optional. You can use String Type annotations to specify special meaning to string fields. The following values are supported: richText: The field must be interpreted as a rich text field. url: A fully qualified URL link. resource: A service qualified resource reference. */ stringType?: string | null; /** - * Optional. Suggested hints for string fields. These can be used to suggest values to users, through an UI for example. + * Optional. Suggested hints for string fields. You can use them to suggest values to users through console. */ stringValues?: string[] | null; } /** - * Definition of the constraints of a field + * Definition of the constraints of a field. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateConstraints { /** - * Optional. Marks this as an optional/required field. + * Optional. Marks this field as optional or required. */ required?: boolean | null; } /** - * Definition of Enumvalue (to be used by enum fields) + * Definition of Enumvalue, to be used for enum fields. */ export interface Schema$GoogleCloudDataplexV1AspectTypeMetadataTemplateEnumValue { /** - * Optional. Optional deprecation message to be set if an enum value needs to be deprecated. + * Optional. You can set this message if you need to deprecate an enum value. */ deprecated?: string | null; /** - * Required. Index for the enum. Cannot be modified. + * Required. Index for the enum value. It can't be modified. */ index?: number | null; /** - * Required. Name of the enumvalue. This is the actual value that the aspect will contain. + * Required. Name of the enumvalue. This is the actual value that the aspect can contain. */ name?: string | null; } @@ -720,6 +721,10 @@ export namespace dataplex_v1 { * Cancel task jobs. */ export interface Schema$GoogleCloudDataplexV1CancelJobRequest {} + /** + * Cancel metadata job request. + */ + export interface Schema$GoogleCloudDataplexV1CancelMetadataJobRequest {} /** * Content represents a user-visible notebook or a sql script */ @@ -985,7 +990,7 @@ export namespace dataplex_v1 { */ export interface Schema$GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo { /** - * Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + * Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. */ distinctRatio?: number | null; /** @@ -1005,7 +1010,7 @@ export namespace dataplex_v1 { */ stringProfile?: Schema$GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo; /** - * The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + * The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. */ topNValues?: Schema$GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue[]; } @@ -1295,6 +1300,10 @@ export namespace dataplex_v1 { * Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range. */ statisticRangeExpectation?: Schema$GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation; + /** + * Optional. Whether the Rule is active or suspended. Default is false. + */ + suspended?: boolean | null; /** * Aggregate rule which evaluates whether the provided expression is true for a table. */ @@ -1853,6 +1862,10 @@ export namespace dataplex_v1 { * A DataScanJob represents an instance of DataScan execution. */ export interface Schema$GoogleCloudDataplexV1DataScanJob { + /** + * Output only. The time when the DataScanJob was created. + */ + createTime?: string | null; /** * Output only. The result of the data profile scan. */ @@ -2157,31 +2170,31 @@ export namespace dataplex_v1 { reason?: string | null; } /** - * An entry is a representation of a data asset which can be described by various metadata. + * An entry is a representation of a data resource that can be described by various metadata. */ export interface Schema$GoogleCloudDataplexV1Entry { /** - * Optional. The Aspects attached to the Entry. The format for the key can be one of the following: 1. {projectId\}.{locationId\}.{aspectTypeId\} (if the aspect is attached directly to the entry) 2. {projectId\}.{locationId\}.{aspectTypeId\}@{path\} (if the aspect is attached to an entry's path) + * Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number\}.{location_id\}.{aspect_type_id\} If the aspect is attached to an entry's path: {project_id_or_number\}.{location_id\}.{aspect_type_id\}@{path\} */ aspects?: {[key: string]: Schema$GoogleCloudDataplexV1Aspect} | null; /** - * Output only. The time when the Entry was created. + * Output only. The time when the entry was created in Dataplex. */ createTime?: string | null; /** - * Optional. Source system related information for an entry. + * Optional. Information related to the source system of the data resource that is represented by the entry. */ entrySource?: Schema$GoogleCloudDataplexV1EntrySource; /** - * Required. Immutable. The resource name of the EntryType used to create this Entry. + * Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. */ entryType?: string | null; /** - * Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. + * Optional. A name for the entry that can be referenced by an external system. For more information, see Fully qualified names (https://cloud.google.com/data-catalog/docs/fully-qualified-names). The maximum size of the field is 4000 characters. */ fullyQualifiedName?: string | null; /** - * Identifier. The relative resource name of the Entry, of the form: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. + * Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entries/{entry_id\}. */ name?: string | null; /** @@ -2189,7 +2202,7 @@ export namespace dataplex_v1 { */ parentEntry?: string | null; /** - * Output only. The time when the Entry was last updated. + * Output only. The time when the entry was last updated in Dataplex. */ updateTime?: string | null; } @@ -2210,7 +2223,7 @@ export namespace dataplex_v1 { */ displayName?: string | null; /** - * This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -2218,15 +2231,11 @@ export namespace dataplex_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + * Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. */ name?: string | null; /** - * Output only. Denotes the transfer status of the Entry Group. It is unspecified for Entry Group created from Dataplex API. - */ - transferStatus?: string | null; - /** - * Output only. System generated globally unique ID for the EntryGroup. This ID will be different if the EntryGroup is deleted and re-created with the same name. + * Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. */ uid?: string | null; /** @@ -2235,23 +2244,23 @@ export namespace dataplex_v1 { updateTime?: string | null; } /** - * EntrySource contains source system related information for the entry. + * Information related to the source system of the data resource that is represented by the entry. */ export interface Schema$GoogleCloudDataplexV1EntrySource { /** - * Immutable. The ancestors of the Entry in the source system. + * Immutable. The entries representing the ancestors of the data resource in the source system. */ ancestors?: Schema$GoogleCloudDataplexV1EntrySourceAncestor[]; /** - * The create time of the resource in the source system. + * The time when the resource was created in the source system. */ createTime?: string | null; /** - * Description of the Entry. The maximum size of the field is 2000 characters. + * A description of the data resource. Maximum length is 2,000 characters. */ description?: string | null; /** - * User friendly display name. The maximum size of the field is 500 characters. + * A user-friendly display name. Maximum length is 500 characters. */ displayName?: string | null; /** @@ -2259,28 +2268,28 @@ export namespace dataplex_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. Location of the resource in the source system. Entry will be searchable by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing source location for data external to GCP. + * Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. */ location?: string | null; /** - * The platform containing the source system. The maximum size of the field is 64 characters. + * The platform containing the source system. Maximum length is 64 characters. */ platform?: string | null; /** - * The name of the resource in the source system. The maximum size of the field is 4000 characters. + * The name of the resource in the source system. Maximum length is 4,000 characters. */ resource?: string | null; /** - * The name of the source system. The maximum size of the field is 64 characters. + * The name of the source system. Maximum length is 64 characters. */ system?: string | null; /** - * The update time of the resource in the source system. + * The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. */ updateTime?: string | null; } /** - * Ancestor contains information about individual items in the hierarchy of an Entry. + * Information about individual items in the hierarchy that is associated with the data resource. */ export interface Schema$GoogleCloudDataplexV1EntrySourceAncestor { /** @@ -2313,7 +2322,7 @@ export namespace dataplex_v1 { */ displayName?: string | null; /** - * Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. + * Optional. This checksum is computed by the service, and might be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */ etag?: string | null; /** @@ -2337,7 +2346,7 @@ export namespace dataplex_v1 { */ system?: string | null; /** - * Optional. Indicates the class this Entry Type belongs to, for example, TABLE, DATABASE, MODEL. + * Optional. Indicates the classes this Entry Type belongs to, for example, TABLE, DATABASE, MODEL. */ typeAliases?: string[] | null; /** @@ -2546,6 +2555,23 @@ export namespace dataplex_v1 { */ entityType?: string | null; } + /** + * An object that describes the values that you want to set for an entry and its attached aspects when you import metadata. Used when you run a metadata import job. See CreateMetadataJob.You provide a collection of import items in a metadata import file. For more information about how to create a metadata import file, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file). + */ + export interface Schema$GoogleCloudDataplexV1ImportItem { + /** + * The aspects to modify. Supports the following syntaxes: {aspect_type_reference\}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference\}@{path\}: matches aspects that belong to the specified aspect type and path. {aspect_type_reference\}@*: matches aspects that belong to the specified aspect type for all paths.Replace {aspect_type_reference\} with a reference to the aspect type, in the format {project_id_or_number\}.{location_id\}.{aspect_type_id\}.If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry. + */ + aspectKeys?: string[] | null; + /** + * Information about an entry and its attached aspects. + */ + entry?: Schema$GoogleCloudDataplexV1Entry; + /** + * The fields to update, in paths that are relative to the Entry resource. Separate each field with a comma.In FULL entry sync mode, Dataplex includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex replaces the existing entry with the entry in the metadata import file. All modifiable fields are updated, regardless of the fields that are listed in the update mask, and regardless of whether a field is present in the entry object.The update_mask field is ignored when an entry is created or re-created.Dataplex also determines which entries and aspects to modify by comparing the values and timestamps that you provide in the metadata import file with the values and timestamps that exist in your project. For more information, see Comparison logic (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic). + */ + updateMask?: string | null; + } /** * A job represents an instance of a task. */ @@ -2741,11 +2767,11 @@ export namespace dataplex_v1 { nextPageToken?: string | null; } /** - * List AspectTypes response + * List AspectTypes response. */ export interface Schema$GoogleCloudDataplexV1ListAspectTypesResponse { /** - * ListAspectTypes under the given parent location. + * AspectTypes under the given parent location. */ aspectTypes?: Schema$GoogleCloudDataplexV1AspectType[]; /** @@ -2753,7 +2779,7 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. */ unreachableLocations?: string[] | null; } @@ -2877,22 +2903,25 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; } + /** + * List Entries response. + */ export interface Schema$GoogleCloudDataplexV1ListEntriesResponse { /** - * The list of entries. + * The list of entries under the given parent location. */ entries?: Schema$GoogleCloudDataplexV1Entry[]; /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string | null; } /** - * List ListEntryGroups response. + * List entry groups response. */ export interface Schema$GoogleCloudDataplexV1ListEntryGroupsResponse { /** - * ListEntryGroups under the given parent location. + * Entry groups under the given parent location. */ entryGroups?: Schema$GoogleCloudDataplexV1EntryGroup[]; /** @@ -2900,16 +2929,16 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. */ unreachableLocations?: string[] | null; } /** - * List EntryTypes response + * List EntryTypes response. */ export interface Schema$GoogleCloudDataplexV1ListEntryTypesResponse { /** - * ListEntryTypes under the given parent location. + * EntryTypes under the given parent location. */ entryTypes?: Schema$GoogleCloudDataplexV1EntryType[]; /** @@ -2917,7 +2946,7 @@ export namespace dataplex_v1 { */ nextPageToken?: string | null; /** - * Locations that could not be reached. + * Locations that the service couldn't reach. */ unreachableLocations?: string[] | null; } @@ -2964,6 +2993,23 @@ export namespace dataplex_v1 { */ unreachableLocations?: string[] | null; } + /** + * List metadata jobs response. + */ + export interface Schema$GoogleCloudDataplexV1ListMetadataJobsResponse { + /** + * Metadata jobs under the specified parent location. + */ + metadataJobs?: Schema$GoogleCloudDataplexV1MetadataJob[]; + /** + * A token to retrieve the next page of results. If there are no more results in the list, the value is empty. + */ + nextPageToken?: string | null; + /** + * Locations that the service couldn't reach. + */ + unreachableLocations?: string[] | null; + } /** * List metadata partitions response. */ @@ -3020,6 +3066,143 @@ export namespace dataplex_v1 { */ zones?: Schema$GoogleCloudDataplexV1Zone[]; } + /** + * A metadata job resource. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJob { + /** + * Output only. The time when the metadata job was created. + */ + createTime?: string | null; + /** + * Output only. Import job result. + */ + importResult?: Schema$GoogleCloudDataplexV1MetadataJobImportJobResult; + /** + * Import job specification. + */ + importSpec?: Schema$GoogleCloudDataplexV1MetadataJobImportJobSpec; + /** + * Optional. User-defined labels. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Identifier. The name of the resource that the configuration is applied to, in the format projects/{project_number\}/locations/{location_id\}/metadataJobs/{metadata_job_id\}. + */ + name?: string | null; + /** + * Output only. Metadata job status. + */ + status?: Schema$GoogleCloudDataplexV1MetadataJobStatus; + /** + * Required. Metadata job type. + */ + type?: string | null; + /** + * Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different. + */ + uid?: string | null; + /** + * Output only. The time when the metadata job was updated. + */ + updateTime?: string | null; + } + /** + * Results from a metadata import job. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobImportJobResult { + /** + * Output only. The total number of entries that were created. + */ + createdEntries?: string | null; + /** + * Output only. The total number of entries that were deleted. + */ + deletedEntries?: string | null; + /** + * Output only. The total number of entries that were recreated. + */ + recreatedEntries?: string | null; + /** + * Output only. The total number of entries that were unchanged. + */ + unchangedEntries?: string | null; + /** + * Output only. The total number of entries that were updated. + */ + updatedEntries?: string | null; + /** + * Output only. The time when the status was updated. + */ + updateTime?: string | null; + } + /** + * Job specification for a metadata import job + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobImportJobSpec { + /** + * Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field. + */ + aspectSyncMode?: string | null; + /** + * Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job. + */ + entrySyncMode?: string | null; + /** + * Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO. + */ + logLevel?: string | null; + /** + * Required. A boundary on the scope of impact that the metadata import job can have. + */ + scope?: Schema$GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope; + /** + * Optional. The time when the process that created the metadata import files began. + */ + sourceCreateTime?: string | null; + /** + * Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted. + */ + sourceStorageUri?: string | null; + } + /** + * A boundary on the scope of impact that the metadata import job can have. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope { + /** + * Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global. + */ + aspectTypes?: string[] | null; + /** + * Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id\}/locations/{location_id\}/entryGroups/{entry_group_id\}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location. + */ + entryGroups?: string[] | null; + /** + * Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id\}/locations/{location_id\}/entryTypes/{entry_type_id\}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global. + */ + entryTypes?: string[] | null; + } + /** + * Metadata job status. + */ + export interface Schema$GoogleCloudDataplexV1MetadataJobStatus { + /** + * Output only. Progress tracking. + */ + completionPercent?: number | null; + /** + * Output only. Message relating to the progression of a metadata job. + */ + message?: string | null; + /** + * Output only. State of the metadata job. + */ + state?: string | null; + /** + * Output only. The time when the status was updated. + */ + updateTime?: string | null; + } /** * Represents the metadata of a long-running operation. */ @@ -3207,7 +3390,7 @@ export namespace dataplex_v1 { } export interface Schema$GoogleCloudDataplexV1SearchEntriesResponse { /** - * Pagination token. + * Token to retrieve the next page of results, or empty if there are no more results in the list. */ nextPageToken?: string | null; /** @@ -3215,11 +3398,11 @@ export namespace dataplex_v1 { */ results?: Schema$GoogleCloudDataplexV1SearchEntriesResult[]; /** - * The estimated total number of matching entries. Not guaranteed to be accurate. + * The estimated total number of matching entries. This number isn't guaranteed to be accurate. */ totalSize?: number | null; /** - * Unreachable locations. Search results don't include data from those locations. + * Locations that the service couldn't reach. Search results don't include data from these locations. */ unreachable?: string[] | null; } @@ -4021,111 +4204,89 @@ export namespace dataplex_v1 { title?: string | null; } - export class Resource$Projects { + export class Resource$Organizations { context: APIRequestContext; - locations: Resource$Projects$Locations; + locations: Resource$Organizations$Locations; constructor(context: APIRequestContext) { this.context = context; - this.locations = new Resource$Projects$Locations(this.context); + this.locations = new Resource$Organizations$Locations(this.context); } } - export class Resource$Projects$Locations { + export class Resource$Organizations$Locations { + context: APIRequestContext; + encryptionConfigs: Resource$Organizations$Locations$Encryptionconfigs; + constructor(context: APIRequestContext) { + this.context = context; + this.encryptionConfigs = + new Resource$Organizations$Locations$Encryptionconfigs(this.context); + } + } + + export class Resource$Organizations$Locations$Encryptionconfigs { context: APIRequestContext; - aspectTypes: Resource$Projects$Locations$Aspecttypes; - dataAttributeBindings: Resource$Projects$Locations$Dataattributebindings; - dataScans: Resource$Projects$Locations$Datascans; - dataTaxonomies: Resource$Projects$Locations$Datataxonomies; - entryGroups: Resource$Projects$Locations$Entrygroups; - entryTypes: Resource$Projects$Locations$Entrytypes; - governanceRules: Resource$Projects$Locations$Governancerules; - lakes: Resource$Projects$Locations$Lakes; - operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; - this.aspectTypes = new Resource$Projects$Locations$Aspecttypes( - this.context - ); - this.dataAttributeBindings = - new Resource$Projects$Locations$Dataattributebindings(this.context); - this.dataScans = new Resource$Projects$Locations$Datascans(this.context); - this.dataTaxonomies = new Resource$Projects$Locations$Datataxonomies( - this.context - ); - this.entryGroups = new Resource$Projects$Locations$Entrygroups( - this.context - ); - this.entryTypes = new Resource$Projects$Locations$Entrytypes( - this.context - ); - this.governanceRules = new Resource$Projects$Locations$Governancerules( - this.context - ); - this.lakes = new Resource$Projects$Locations$Lakes(this.context); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); } /** - * Gets information about a location. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Get, + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Get, + getIamPolicy( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - get( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Get - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Get; + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Get; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy; options = {}; } @@ -4138,86 +4299,88 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists information about the supported locations for this service. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$List, + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$List, + setIamPolicy( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$List, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - list( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$List - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$List; + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$List; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy; options = {}; } @@ -4230,91 +4393,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/locations').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Looks up a single entry. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - lookupEntry( - params: Params$Resource$Projects$Locations$Lookupentry, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - lookupEntry( - params?: Params$Resource$Projects$Locations$Lookupentry, + testIamPermissions( + params?: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - lookupEntry( - params: Params$Resource$Projects$Locations$Lookupentry, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - lookupEntry( - params: Params$Resource$Projects$Locations$Lookupentry, + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - lookupEntry( - params: Params$Resource$Projects$Locations$Lookupentry, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions, + callback: BodyResponseCallback ): void; - lookupEntry( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - lookupEntry( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lookupentry - | BodyResponseCallback + | Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lookupentry; + {}) as Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lookupentry; + params = + {} as Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions; options = {}; } @@ -4327,89 +4489,182 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:lookupEntry').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Organizations$Locations$Encryptionconfigs$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + aspectTypes: Resource$Projects$Locations$Aspecttypes; + dataAttributeBindings: Resource$Projects$Locations$Dataattributebindings; + dataScans: Resource$Projects$Locations$Datascans; + dataTaxonomies: Resource$Projects$Locations$Datataxonomies; + entryGroups: Resource$Projects$Locations$Entrygroups; + entryTypes: Resource$Projects$Locations$Entrytypes; + glossaries: Resource$Projects$Locations$Glossaries; + governanceRules: Resource$Projects$Locations$Governancerules; + lakes: Resource$Projects$Locations$Lakes; + metadataJobs: Resource$Projects$Locations$Metadatajobs; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.aspectTypes = new Resource$Projects$Locations$Aspecttypes( + this.context + ); + this.dataAttributeBindings = + new Resource$Projects$Locations$Dataattributebindings(this.context); + this.dataScans = new Resource$Projects$Locations$Datascans(this.context); + this.dataTaxonomies = new Resource$Projects$Locations$Datataxonomies( + this.context + ); + this.entryGroups = new Resource$Projects$Locations$Entrygroups( + this.context + ); + this.entryTypes = new Resource$Projects$Locations$Entrytypes( + this.context + ); + this.glossaries = new Resource$Projects$Locations$Glossaries( + this.context + ); + this.governanceRules = new Resource$Projects$Locations$Governancerules( + this.context + ); + this.lakes = new Resource$Projects$Locations$Lakes(this.context); + this.metadataJobs = new Resource$Projects$Locations$Metadatajobs( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } /** - * Searches for entries matching given query and scope. + * Gets information about a location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - searchEntries( - params: Params$Resource$Projects$Locations$Searchentries, + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions ): GaxiosPromise; - searchEntries( - params?: Params$Resource$Projects$Locations$Searchentries, + get( + params?: Params$Resource$Projects$Locations$Get, options?: MethodOptions - ): GaxiosPromise; - searchEntries( - params: Params$Resource$Projects$Locations$Searchentries, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - searchEntries( - params: Params$Resource$Projects$Locations$Searchentries, + get( + params: Params$Resource$Projects$Locations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - searchEntries( - params: Params$Resource$Projects$Locations$Searchentries, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback ): void; - searchEntries( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - searchEntries( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Searchentries - | BodyResponseCallback + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Searchentries; + {}) as Params$Resource$Projects$Locations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Searchentries; + params = {} as Params$Resource$Projects$Locations$Get; options = {}; } @@ -4422,11 +4677,8 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:searchEntries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -4437,160 +4689,74 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Projects$Locations$Get - extends StandardParameters { - /** - * Resource name for the location. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$List - extends StandardParameters { - /** - * 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). - */ - filter?: string; - /** - * The resource that owns the locations collection, if applicable. - */ - name?: string; /** - * The maximum number of results to return. If not set, the service selects a default. + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageSize?: number; - /** - * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. - */ - pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Lookupentry - extends StandardParameters { - /** - * Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. - */ - aspectTypes?: string[]; - /** - * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. - */ - entry?: string; - /** - * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/{location\}. - */ - name?: string; - /** - * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. - */ - paths?: string[]; - /** - * Optional. View for controlling which parts of an entry are to be returned. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Searchentries - extends StandardParameters { - /** - * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/{location\}. - */ - name?: string; - /** - * Optional. Ordering of the results. Supported options to be added later. - */ - orderBy?: string; - /** - * Optional. Pagination. - */ - pageSize?: number; - /** - * - */ - pageToken?: string; - /** - * Required. The query against which entries in scope should be matched. - */ - query?: string; - /** - * Optional. The scope under which the search should be operating. Should either be organizations/ or projects/. If left unspecified, it will default to the organization where the project provided in name is located. - */ - scope?: string; - } - - export class Resource$Projects$Locations$Aspecttypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates an AspectType - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Aspecttypes$Create, + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Aspecttypes$Create, + list( + params?: Params$Resource$Projects$Locations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Aspecttypes$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Aspecttypes$Create, + list( + params: Params$Resource$Projects$Locations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Aspecttypes$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Create; + {}) as Params$Resource$Projects$Locations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Aspecttypes$Create; + params = {} as Params$Resource$Projects$Locations$List; options = {}; } @@ -4603,89 +4769,91 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/aspectTypes').replace( + url: (rootUrl + '/v1/{+name}/locations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a AspectType resource. + * Looks up a single Entry by name using the permission on the source system. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Aspecttypes$Delete, + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Aspecttypes$Delete, + lookupEntry( + params?: Params$Resource$Projects$Locations$Lookupentry, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Aspecttypes$Delete, + ): GaxiosPromise; + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Aspecttypes$Delete, + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Aspecttypes$Delete, - callback: BodyResponseCallback + lookupEntry( + params: Params$Resource$Projects$Locations$Lookupentry, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + lookupEntry( + callback: BodyResponseCallback ): void; - delete( + lookupEntry( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lookupentry + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Delete; + {}) as Params$Resource$Projects$Locations$Lookupentry; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Aspecttypes$Delete; + params = {} as Params$Resource$Projects$Locations$Lookupentry; options = {}; } @@ -4698,8 +4866,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:lookupEntry').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -4710,74 +4881,74 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a AspectType resource. + * Searches for Entries matching the given query and scope. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Aspecttypes$Get, + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Aspecttypes$Get, + searchEntries( + params?: Params$Resource$Projects$Locations$Searchentries, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Aspecttypes$Get, + ): GaxiosPromise; + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Aspecttypes$Get, + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Aspecttypes$Get, - callback: BodyResponseCallback + searchEntries( + params: Params$Resource$Projects$Locations$Searchentries, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + searchEntries( + callback: BodyResponseCallback ): void; - get( + searchEntries( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Searchentries + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Get; + {}) as Params$Resource$Projects$Locations$Searchentries; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Aspecttypes$Get; + params = {} as Params$Resource$Projects$Locations$Searchentries; options = {}; } @@ -4790,8 +4961,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:searchEntries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -4802,75 +4976,160 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Resource name for the location. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Lookupentry + extends StandardParameters { + /** + * Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. + */ + aspectTypes?: string[]; + /** + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. + */ + entry?: string; + /** + * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/{location\}. + */ + name?: string; + /** + * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. + */ + paths?: string[]; + /** + * Optional. View to control which parts of an entry the service should return. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Searchentries + extends StandardParameters { + /** + * Required. The project to which the request should be attributed in the following form: projects/{project\}/locations/{location\}. + */ + name?: string; + /** + * Optional. Specifies the ordering of results. + */ + orderBy?: string; + /** + * Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for page_size is 1000. Throws an invalid argument for page_size \> 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous SearchEntries call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The query against which entries in scope should be matched. + */ + query?: string; + /** + * Optional. The scope under which the search should be operating. It must either be organizations/ or projects/. If it is unspecified, it defaults to the organization where the project provided in name is located. + */ + scope?: string; + } + + export class Resource$Projects$Locations$Aspecttypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates an AspectType. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Aspecttypes$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Aspecttypes$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Create; options = {}; } @@ -4883,89 +5142,89 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/aspectTypes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists AspectType resources in a project and location. + * Deletes an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Aspecttypes$List, + delete( + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Aspecttypes$List, + delete( + params?: Params$Resource$Projects$Locations$Aspecttypes$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Aspecttypes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Aspecttypes$List, + delete( + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Aspecttypes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Aspecttypes$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$List; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Aspecttypes$List; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Delete; options = {}; } @@ -4978,91 +5237,86 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/aspectTypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a AspectType resource. + * Gets an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Aspecttypes$Patch, + get( + params: Params$Resource$Projects$Locations$Aspecttypes$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Aspecttypes$Patch, + get( + params?: Params$Resource$Projects$Locations$Aspecttypes$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Aspecttypes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Aspecttypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Aspecttypes$Patch, + get( + params: Params$Resource$Projects$Locations$Aspecttypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Aspecttypes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Aspecttypes$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Patch; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Aspecttypes$Patch; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Get; options = {}; } @@ -5076,7 +5330,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -5087,51 +5341,53 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy + | Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5147,13 +5403,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; + {} as Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy; options = {}; } @@ -5166,11 +5422,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -5191,65 +5447,64 @@ export namespace dataplex_v1 { } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists AspectType resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Aspecttypes$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Aspecttypes$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Aspecttypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Aspecttypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Aspecttypes$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Aspecttypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$List; options = {}; } @@ -5262,194 +5517,70 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/aspectTypes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Aspecttypes$Create - extends StandardParameters { - /** - * Required. AspectType identifier. - */ - aspectTypeId?: string; - /** - * Required. The resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1AspectType; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Delete - extends StandardParameters { - /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response - */ - etag?: string; - /** - * Required. The resource name of the AspectType: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Get - extends StandardParameters { - /** - * Required. The resource name of the AspectType: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$List - extends StandardParameters { - /** - * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions. - */ - filter?: string; - /** - * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. - */ - orderBy?: string; - /** - * Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, at most 10 AspectTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAspectTypes must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the AspectType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1AspectType; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Dataattributebindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create a DataAttributeBinding resource. + * Updates an AspectType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + patch( + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Create, + patch( + params?: Params$Resource$Projects$Locations$Aspecttypes$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + patch( + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + patch( + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + patch( + params: Params$Resource$Projects$Locations$Aspecttypes$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Create + | Params$Resource$Projects$Locations$Aspecttypes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5465,109 +5596,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Create; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/dataAttributeBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Delete; + params = {} as Params$Resource$Projects$Locations$Aspecttypes$Patch; options = {}; } @@ -5581,7 +5615,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -5602,65 +5636,63 @@ export namespace dataplex_v1 { } /** - * Retrieves a DataAttributeBinding resource. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + setIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Get, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Dataattributebindings$Get, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - get( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Get; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Get; + {} as Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy; options = {}; } @@ -5673,87 +5705,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + testIamPermissions( + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - getIamPolicy( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; + {} as Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions; options = {}; } @@ -5766,11 +5801,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -5781,75 +5816,201 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Create + extends StandardParameters { /** - * Lists DataAttributeBinding resources in a project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. AspectType identifier. */ - list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Dataattributebindings$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + aspectTypeId?: string; + /** + * Required. The resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. + */ + parent?: string; + /** + * Optional. The service validates the request without performing any mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1AspectType; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value, the DeleteAspectTypeRequest method returns an ABORTED error response. + */ + etag?: string; + /** + * Required. The resource name of the AspectType: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Get + extends StandardParameters { + /** + * Required. The resource name of the AspectType: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$List + extends StandardParameters { + /** + * Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions. + */ + filter?: string; + /** + * Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined. + */ + orderBy?: string; + /** + * Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the AspectType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the AspectType, of the form: projects/{project_number\}/locations/{location_id\}/aspectTypes/{aspect_type_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1AspectType; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Aspecttypes$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Dataattributebindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a DataAttributeBinding resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Dataattributebindings$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Dataattributebindings$Create, + callback: BodyResponseCallback ): void; - list( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$List; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$List; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Create; options = {}; } @@ -5866,7 +6027,7 @@ export namespace dataplex_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -5877,55 +6038,53 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataAttributeBinding resource. + * Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + delete( + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + delete( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + delete( + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + delete( + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, + delete( + params: Params$Resource$Projects$Locations$Dataattributebindings$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Patch + | Params$Resource$Projects$Locations$Dataattributebindings$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5941,13 +6100,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Patch; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Patch; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Delete; options = {}; } @@ -5961,7 +6120,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -5982,63 +6141,65 @@ export namespace dataplex_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Retrieves a DataAttributeBinding resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Dataattributebindings$Get, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - setIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Get; options = {}; } @@ -6051,90 +6212,87 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + getIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - testIamPermissions( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy; options = {}; } @@ -6147,11 +6305,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -6162,202 +6320,75 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Dataattributebindings$Create - extends StandardParameters { - /** - * Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location. - */ - dataAttributeBindingId?: string; - /** - * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\} - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Delete - extends StandardParameters { - /** - * Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding. - */ - etag?: string; - /** - * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Get - extends StandardParameters { - /** - * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$List - extends StandardParameters { - /** - * Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name" - */ - filter?: string; - /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the Location: projects/{project_number\}/locations/{location_id\} - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number\}/locations/{location\}/dataAttributeBindings/{data_attribute_binding_id\} - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datascans { - context: APIRequestContext; - jobs: Resource$Projects$Locations$Datascans$Jobs; - constructor(context: APIRequestContext) { - this.context = context; - this.jobs = new Resource$Projects$Locations$Datascans$Jobs(this.context); - } /** - * Creates a DataScan resource. + * Lists DataAttributeBinding resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datascans$Create, + list( + params: Params$Resource$Projects$Locations$Dataattributebindings$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datascans$Create, + list( + params?: Params$Resource$Projects$Locations$Dataattributebindings$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datascans$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Dataattributebindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datascans$Create, + list( + params: Params$Resource$Projects$Locations$Dataattributebindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datascans$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Dataattributebindings$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Create; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Create; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$List; options = {}; } @@ -6370,11 +6401,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataScans').replace( + url: (rootUrl + '/v1/{+parent}/dataAttributeBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -6385,53 +6416,55 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a DataScan resource. + * Updates a DataAttributeBinding resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + patch( + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datascans$Delete, + patch( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + patch( + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + patch( + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datascans$Delete, + patch( + params: Params$Resource$Projects$Locations$Dataattributebindings$Patch, callback: BodyResponseCallback ): void; - delete( + patch( callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Delete + | Params$Resource$Projects$Locations$Dataattributebindings$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6447,12 +6480,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Delete; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Delete; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Patch; options = {}; } @@ -6466,7 +6500,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -6487,65 +6521,63 @@ export namespace dataplex_v1 { } /** - * Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - generateDataQualityRules( - params?: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy, + callback: BodyResponseCallback ): void; - generateDataQualityRules( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - generateDataQualityRules( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules; + {} as Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy; options = {}; } @@ -6558,7 +6590,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:generateDataQualityRules').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -6568,81 +6600,80 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a DataScan resource. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datascans$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datascans$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datascans$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datascans$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datascans$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - get( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Get; + {}) as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Get; + params = + {} as Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions; options = {}; } @@ -6655,182 +6686,217 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Create + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. DataAttributeBinding identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Location. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datascans$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datascans$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + dataAttributeBindingId?: string; + /** + * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\} + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Delete + extends StandardParameters { + /** + * Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding. + */ + etag?: string; + /** + * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Get + extends StandardParameters { + /** + * Required. The resource name of the DataAttributeBinding: projects/{project_number\}/locations/{location_id\}/dataAttributeBindings/{data_attribute_binding_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$List + extends StandardParameters { + /** + * Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name" + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location: projects/{project_number\}/locations/{location_id\} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number\}/locations/{location\}/dataAttributeBindings/{data_attribute_binding_id\} + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataAttributeBinding; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Dataattributebindings$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datascans { + context: APIRequestContext; + jobs: Resource$Projects$Locations$Datascans$Jobs; + constructor(context: APIRequestContext) { + this.context = context; + this.jobs = new Resource$Projects$Locations$Datascans$Jobs(this.context); } /** - * Lists DataScans. + * Creates a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datascans$List, + create( + params: Params$Resource$Projects$Locations$Datascans$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datascans$List, + create( + params?: Params$Resource$Projects$Locations$Datascans$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datascans$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datascans$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datascans$List, + create( + params: Params$Resource$Projects$Locations$Datascans$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datascans$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datascans$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$List; + {}) as Params$Resource$Projects$Locations$Datascans$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$List; + params = {} as Params$Resource$Projects$Locations$Datascans$Create; options = {}; } @@ -6847,7 +6913,7 @@ export namespace dataplex_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -6858,55 +6924,53 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataScan resource. + * Deletes a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datascans$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datascans$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datascans$Patch, + delete( + params: Params$Resource$Projects$Locations$Datascans$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Patch + | Params$Resource$Projects$Locations$Datascans$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6922,12 +6986,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Patch; + {}) as Params$Resource$Projects$Locations$Datascans$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Patch; + params = {} as Params$Resource$Projects$Locations$Datascans$Delete; options = {}; } @@ -6941,7 +7005,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -6962,64 +7026,65 @@ export namespace dataplex_v1 { } /** - * Runs an on-demand execution of a DataScan + * Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - run( - params: Params$Resource$Projects$Locations$Datascans$Run, + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options: StreamMethodOptions ): GaxiosPromise; - run( - params?: Params$Resource$Projects$Locations$Datascans$Run, + generateDataQualityRules( + params?: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Projects$Locations$Datascans$Run, + ): GaxiosPromise; + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Datascans$Run, + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Datascans$Run, - callback: BodyResponseCallback + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules, + callback: BodyResponseCallback ): void; - run( - callback: BodyResponseCallback + generateDataQualityRules( + callback: BodyResponseCallback ): void; - run( + generateDataQualityRules( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Run - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Run; + {}) as Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Run; + params = + {} as Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules; options = {}; } @@ -7032,7 +7097,10 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}:generateDataQualityRules').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -7044,53 +7112,147 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Gets a DataScan resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Datascans$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Datascans$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datascans$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datascans$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datascans$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datascans$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datascans$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datascans$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Setiampolicy + | Params$Resource$Projects$Locations$Datascans$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7106,13 +7268,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Datascans$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datascans$Setiampolicy; + {} as Params$Resource$Projects$Locations$Datascans$Getiampolicy; options = {}; } @@ -7125,11 +7287,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -7150,65 +7312,64 @@ export namespace dataplex_v1 { } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists DataScans. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datascans$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Datascans$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datascans$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Datascans$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datascans$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Datascans$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datascans$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Datascans$List; options = {}; } @@ -7221,240 +7382,91 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/dataScans').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datascans$Create - extends StandardParameters { - /** - * Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. - */ - dataScanId?: string; - /** - * Required. The resource name of the parent location: projects/{project\}/locations/{location_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1DataScan; - } - export interface Params$Resource$Projects$Locations$Datascans$Delete - extends StandardParameters { - /** - * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + * Updates a DataScan resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules - extends StandardParameters { - /** - * Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest; - } - export interface Params$Resource$Projects$Locations$Datascans$Get - extends StandardParameters { - /** - * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - name?: string; - /** - * Optional. Select the DataScan view to return. Defaults to BASIC. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datascans$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Datascans$List - extends StandardParameters { - /** - * Optional. Filter request. - */ - filter?: string; - /** - * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. - */ - orderBy?: string; - /** - * Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent location: projects/{project\}/locations/{location_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datascans$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the scan, of the form: projects/{project\}/locations/{location_id\}/dataScans/{datascan_id\}, where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1DataScan; - } - export interface Params$Resource$Projects$Locations$Datascans$Run - extends StandardParameters { - /** - * Required. The resource name of the DataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}. where project refers to a project_id or project_number and location_id refers to a GCP region.Only OnDemand data scans are allowed. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1RunDataScanRequest; - } - export interface Params$Resource$Projects$Locations$Datascans$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datascans$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datascans$Jobs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + patch( + params: Params$Resource$Projects$Locations$Datascans$Patch, options: StreamMethodOptions ): GaxiosPromise; - generateDataQualityRules( - params?: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + patch( + params?: Params$Resource$Projects$Locations$Datascans$Patch, options?: MethodOptions - ): GaxiosPromise; - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datascans$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + patch( + params: Params$Resource$Projects$Locations$Datascans$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - generateDataQualityRules( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datascans$Patch, + callback: BodyResponseCallback ): void; - generateDataQualityRules( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - generateDataQualityRules( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules; + {}) as Params$Resource$Projects$Locations$Datascans$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules; + params = {} as Params$Resource$Projects$Locations$Datascans$Patch; options = {}; } @@ -7467,11 +7479,8 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:generateDataQualityRules').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -7482,76 +7491,74 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a DataScanJob resource. + * Runs an on-demand execution of a DataScan * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + run( + params: Params$Resource$Projects$Locations$Datascans$Run, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + run( + params?: Params$Resource$Projects$Locations$Datascans$Run, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Datascans$Run, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + run( + params: Params$Resource$Projects$Locations$Datascans$Run, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, - callback: BodyResponseCallback + run( + params: Params$Resource$Projects$Locations$Datascans$Run, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + run( + callback: BodyResponseCallback ): void; - get( + run( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Jobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Run + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Get; + {}) as Params$Resource$Projects$Locations$Datascans$Run; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$Get; + params = {} as Params$Resource$Projects$Locations$Datascans$Run; options = {}; } @@ -7564,8 +7571,8 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -7576,76 +7583,75 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists DataScanJobs under the given DataScan. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + setIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datascans$Jobs$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datascans$Jobs$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Datascans$Setiampolicy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - list( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datascans$Jobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datascans$Jobs$List; + {}) as Params$Resource$Projects$Locations$Datascans$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$List; + params = + {} as Params$Resource$Projects$Locations$Datascans$Setiampolicy; options = {}; } @@ -7658,141 +7664,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules - extends StandardParameters { - /** - * Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest; - } - export interface Params$Resource$Projects$Locations$Datascans$Jobs$Get - extends StandardParameters { - /** - * Required. The resource name of the DataScanJob: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}/jobs/{data_scan_job_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - name?: string; - /** - * Optional. Select the DataScanJob view to return. Defaults to BASIC. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Datascans$Jobs$List - extends StandardParameters { - /** - * Optional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time \> 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times. - */ - filter?: string; - /** - * Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent environment: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datataxonomies { - context: APIRequestContext; - attributes: Resource$Projects$Locations$Datataxonomies$Attributes; - constructor(context: APIRequestContext) { - this.context = context; - this.attributes = - new Resource$Projects$Locations$Datataxonomies$Attributes(this.context); - } /** - * Create a DataTaxonomy resource. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, + testIamPermissions( + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datataxonomies$Create, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, + testIamPermissions( + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Create, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Datascans$Testiampermissions, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - create( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Create; + {}) as Params$Resource$Projects$Locations$Datascans$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Create; + params = + {} as Params$Resource$Projects$Locations$Datascans$Testiampermissions; options = {}; } @@ -7805,7 +7760,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), @@ -7815,93 +7770,247 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datascans$Create + extends StandardParameters { /** - * Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. DataScan identifier. Must contain only lowercase letters, numbers and hyphens. Must start with a letter. Must end with a number or a letter. Must be between 1-63 characters. Must be unique within the customer project / location. */ - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datataxonomies$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Delete, - callback: BodyResponseCallback - ): void; - delete( - callback: BodyResponseCallback - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + dataScanId?: string; + /** + * Required. The resource name of the parent location: projects/{project\}/locations/{location_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataScan; + } + export interface Params$Resource$Projects$Locations$Datascans$Delete + extends StandardParameters { + /** + * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$Generatedataqualityrules + extends StandardParameters { + /** + * Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest; + } + export interface Params$Resource$Projects$Locations$Datascans$Get + extends StandardParameters { + /** + * Required. The resource name of the dataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + name?: string; + /** + * Optional. Select the DataScan view to return. Defaults to BASIC. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. + */ + orderBy?: string; + /** + * Optional. Maximum number of dataScans to return. The service may return fewer than this value. If unspecified, at most 500 scans will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataScans call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScans must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent location: projects/{project\}/locations/{location_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the scan, of the form: projects/{project\}/locations/{location_id\}/dataScans/{datascan_id\}, where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataScan; + } + export interface Params$Resource$Projects$Locations$Datascans$Run + extends StandardParameters { + /** + * Required. The resource name of the DataScan: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}. where project refers to a project_id or project_number and location_id refers to a GCP region.Only OnDemand data scans are allowed. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1RunDataScanRequest; + } + export interface Params$Resource$Projects$Locations$Datascans$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datascans$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datascans$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Generates recommended data quality rules based on the results of a data profiling scan.Use the recommendations to build rules for a data quality scan. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + options: StreamMethodOptions + ): GaxiosPromise; + generateDataQualityRules( + params?: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + options?: MethodOptions + ): GaxiosPromise; + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDataQualityRules( + params: Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules, + callback: BodyResponseCallback + ): void; + generateDataQualityRules( + callback: BodyResponseCallback + ): void; + generateDataQualityRules( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:generateDataQualityRules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -7912,17 +8021,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Retrieves a DataTaxonomy resource. + * Gets a DataScanJob resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7930,56 +8041,2066 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datataxonomies$Get, + params?: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datataxonomies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datascans$Jobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datascans$Jobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datascans$Jobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists DataScanJobs under the given DataScan. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datascans$Jobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datascans$Jobs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datascans$Jobs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datascans$Jobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datascans$Jobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datascans$Jobs$Generatedataqualityrules + extends StandardParameters { + /** + * Required. The name must be one of the following: The name of a data scan with at least one successful, completed data profiling job The name of a successful, completed data profiling job (a data scan job where the job type is data profiling) + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1GenerateDataQualityRulesRequest; + } + export interface Params$Resource$Projects$Locations$Datascans$Jobs$Get + extends StandardParameters { + /** + * Required. The resource name of the DataScanJob: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\}/jobs/{data_scan_job_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + name?: string; + /** + * Optional. Select the DataScanJob view to return. Defaults to BASIC. + */ + view?: string; + } + export interface Params$Resource$Projects$Locations$Datascans$Jobs$List + extends StandardParameters { + /** + * Optional. An expression for filtering the results of the ListDataScanJobs request.If unspecified, all datascan jobs will be returned. Multiple filters can be applied (with AND, OR logical operators). Filters are case-sensitive.Allowed fields are: start_time end_timestart_time and end_time expect RFC-3339 formatted strings (e.g. 2018-10-08T18:30:00-07:00).For instance, 'start_time \> 2018-10-08T00:00:00.123456789Z AND end_time < 2018-10-09T00:00:00.123456789Z' limits results to DataScanJobs between specified start and end times. + */ + filter?: string; + /** + * Optional. Maximum number of DataScanJobs to return. The service may return fewer than this value. If unspecified, at most 10 DataScanJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataScanJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataScanJobs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent environment: projects/{project\}/locations/{location_id\}/dataScans/{data_scan_id\} where project refers to a project_id or project_number and location_id refers to a GCP region. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Datataxonomies { + context: APIRequestContext; + attributes: Resource$Projects$Locations$Datataxonomies$Attributes; + constructor(context: APIRequestContext) { + this.context = context; + this.attributes = + new Resource$Projects$Locations$Datataxonomies$Attributes(this.context); + } + + /** + * Create a DataTaxonomy resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datataxonomies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datataxonomies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a DataTaxonomy resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datataxonomies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists DataTaxonomy resources in a project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datataxonomies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a DataTaxonomy resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datataxonomies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datataxonomies$Create + extends StandardParameters { + /** + * Required. DataTaxonomy identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Project. + */ + dataTaxonomyId?: string; + /** + * Required. The resource name of the data taxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error. + */ + etag?: string; + /** + * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Get + extends StandardParameters { + /** + * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Datataxonomies$Attributes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a DataAttribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/attributes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Data Attribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a Data Attribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Data Attribute resources in a DataTaxonomy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/attributes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a DataAttribute resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create + extends StandardParameters { + /** + * Required. DataAttribute identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the DataTaxonomy. + */ + dataAttributeId?: string; + /** + * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response. + */ + etag?: string; + /** + * Required. The resource name of the DataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get + extends StandardParameters { + /** + * Required. The resource name of the dataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Entrygroups { + context: APIRequestContext; + entries: Resource$Projects$Locations$Entrygroups$Entries; + constructor(context: APIRequestContext) { + this.context = context; + this.entries = new Resource$Projects$Locations$Entrygroups$Entries( + this.context + ); + } + + /** + * Creates an EntryGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Entrygroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Get; + {}) as Params$Resource$Projects$Locations$Entrygroups$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Get; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Create; options = {}; } @@ -7992,87 +10113,89 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+parent}/entryGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Deletes an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Entrygroups$Delete, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Delete, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - getIamPolicy( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Entrygroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Delete; options = {}; } @@ -8085,89 +10208,86 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists DataTaxonomy resources in a project and location. + * Gets an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datataxonomies$List, + get( + params?: Params$Resource$Projects$Locations$Entrygroups$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Entrygroups$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$List; + {}) as Params$Resource$Projects$Locations$Entrygroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$List; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Get; options = {}; } @@ -8180,91 +10300,87 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/dataTaxonomies').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataTaxonomy resource. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datataxonomies$Patch, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Patch, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - patch( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Patch; + {}) as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datataxonomies$Patch; + params = + {} as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; options = {}; } @@ -8277,85 +10393,89 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Lists EntryGroup resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Entrygroups$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entrygroups$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Entrygroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Entrygroups$List; options = {}; } @@ -8368,90 +10488,91 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/entryGroups').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Entrygroups$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Entrygroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Patch; options = {}; } @@ -8464,216 +10585,85 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datataxonomies$Create - extends StandardParameters { - /** - * Required. DataTaxonomy identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the Project. - */ - dataTaxonomyId?: string; - /** - * Required. The resource name of the data taxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Delete - extends StandardParameters { - /** - * Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error. - */ - etag?: string; - /** - * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Get - extends StandardParameters { - /** - * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$List - extends StandardParameters { - /** - * Optional. Filter request. - */ - filter?: string; - /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\}. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1DataTaxonomy; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Datataxonomies$Attributes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Create a DataAttribute resource. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - create( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + {}) as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create; + {} as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; options = {}; } @@ -8686,7 +10676,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/attributes').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -8696,80 +10686,80 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a Data Attribute resource. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + {}) as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete; + {} as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; options = {}; } @@ -8782,180 +10772,216 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Entrygroups$Create + extends StandardParameters { /** - * Retrieves a Data Attribute resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. EntryGroup identifier. */ - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; + entryGroupId?: string; + /** + * Required. The resource name of the entryGroup, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + */ + parent?: string; + /** + * Optional. The service validates the request without performing any mutations. The default is false. + */ + validateOnly?: boolean; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EntryGroup; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Delete + extends StandardParameters { + /** + * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response. + */ + etag?: string; + /** + * Required. The resource name of the EntryGroup: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Get + extends StandardParameters { + /** + * Required. The resource name of the EntryGroup: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryGroups. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListEntryGroups must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the entryGroup location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. The service validates the request, without performing any mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1EntryGroup; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Projects$Locations$Entrygroups$Entries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates an Entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Entries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy; + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Create; options = {}; } @@ -8968,90 +10994,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/entries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Data Attribute resources in a DataTaxonomy. + * Deletes an Entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + delete( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Entries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$List; + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Delete; options = {}; } @@ -9064,92 +11090,87 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/attributes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataAttribute resource. + * Gets an Entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + get( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Entries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch; + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Get; options = {}; } @@ -9163,7 +11184,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -9174,73 +11195,75 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Lists Entries within an EntryGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Entries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy; + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$List; options = {}; } @@ -9253,90 +11276,92 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/entries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates an Entry. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - testIamPermissions( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrygroups$Entries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; options = {}; } @@ -9349,162 +11374,126 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Create + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Create extends StandardParameters { /** - * Required. DataAttribute identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the DataTaxonomy. + * Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. */ - dataAttributeId?: string; + entryId?: string; /** - * Required. The resource name of the parent data taxonomy projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. */ parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; + requestBody?: Schema$GoogleCloudDataplexV1Entry; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Delete + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response. - */ - etag?: string; - /** - * Required. The resource name of the DataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Get + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Get extends StandardParameters { /** - * Required. The resource name of the dataAttribute: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\} + * Optional. Limits the aspects returned to the provided aspect types. It only works for CUSTOM view. + */ + aspectTypes?: string[]; + /** + * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Getiampolicy - extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. It only works for CUSTOM view. */ - 'options.requestedPolicyVersion'?: number; + paths?: string[]; /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. View to control which parts of an entry the service should return. */ - resource?: string; + view?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$List + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$List extends StandardParameters { /** - * Optional. Filter request. + * Optional. A filter on the entries to return. Filters are case-sensitive. You can filter the request by the following fields: entry_type entry_source.display_nameThe comparison operators are =, !=, <, \>, <=, \>=. The service compares strings according to lexical order.You can use the logical operators AND, OR, NOT in the filter.You can use Wildcard "*", but for entry_type you need to provide the full project id or number.Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/x" "NOT entry_source.display_name=AnotherExampleDisplayName" */ filter?: string; /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Number of items to return per page. If there are remaining results, the service returns a next_page_token. If unspecified, the service returns at most 10 Entries. The maximum value is 100; values above 100 will be coerced to 100. */ pageSize?: number; /** - * Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token. + * Optional. Page token received from a previous ListEntries call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The resource name of the DataTaxonomy: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{data_taxonomy_id\} + * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Patch + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch extends StandardParameters { /** - * Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number\}/locations/{location_id\}/dataTaxonomies/{dataTaxonomy\}/attributes/{data_attribute_id\}. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. If set to true and the entry doesn't exist, the service will create it. */ - validateOnly?: boolean; - + allowMissing?: boolean; /** - * Request body metadata + * Optional. The map keys of the Aspects which the service should modify. It supports the following syntaxes: - matches an aspect of the given type and empty path. @path - matches an aspect of the given type and specified path. * - matches aspects of the given type for all paths. *@path - matches aspects of all types on the given path.The service will not remove existing aspects matching the syntax unless delete_missing_aspects is set to true.If this field is left empty, the service treats it as specifying exactly those Aspects present in the request. */ - requestBody?: Schema$GoogleCloudDataplexV1DataAttribute; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Setiampolicy - extends StandardParameters { + aspectKeys?: string[]; /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. If set to true and the aspect_keys specify aspect ranges, the service deletes any existing aspects from that range that weren't provided in the request. */ - resource?: string; - + deleteMissingAspects?: boolean; /** - * Request body metadata + * Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}/entries/{entry_id\}. */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Datataxonomies$Attributes$Testiampermissions - extends StandardParameters { + name?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, the service will update all modifiable fields present in the request. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + requestBody?: Schema$GoogleCloudDataplexV1Entry; } - export class Resource$Projects$Locations$Entrygroups { + export class Resource$Projects$Locations$Entrytypes { context: APIRequestContext; - entries: Resource$Projects$Locations$Entrygroups$Entries; constructor(context: APIRequestContext) { this.context = context; - this.entries = new Resource$Projects$Locations$Entrygroups$Entries( - this.context - ); } /** - * Creates an EntryGroup + * Creates an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9512,27 +11501,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Entrygroups$Create, + params: Params$Resource$Projects$Locations$Entrytypes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Entrygroups$Create, + params?: Params$Resource$Projects$Locations$Entrytypes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Entrygroups$Create, + params: Params$Resource$Projects$Locations$Entrytypes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Entrygroups$Create, + params: Params$Resource$Projects$Locations$Entrytypes$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Entrygroups$Create, + params: Params$Resource$Projects$Locations$Entrytypes$Create, callback: BodyResponseCallback ): void; create( @@ -9540,7 +11529,7 @@ export namespace dataplex_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Create + | Params$Resource$Projects$Locations$Entrytypes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9556,12 +11545,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Create; + {}) as Params$Resource$Projects$Locations$Entrytypes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$Create; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Create; options = {}; } @@ -9574,7 +11563,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entryGroups').replace( + url: (rootUrl + '/v1/{+parent}/entryTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -9599,7 +11588,7 @@ export namespace dataplex_v1 { } /** - * Deletes a EntryGroup resource. + * Deletes an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9607,27 +11596,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Entrygroups$Delete, + params: Params$Resource$Projects$Locations$Entrytypes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Entrygroups$Delete, + params?: Params$Resource$Projects$Locations$Entrytypes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Entrygroups$Delete, + params: Params$Resource$Projects$Locations$Entrytypes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Entrygroups$Delete, + params: Params$Resource$Projects$Locations$Entrytypes$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Entrygroups$Delete, + params: Params$Resource$Projects$Locations$Entrytypes$Delete, callback: BodyResponseCallback ): void; delete( @@ -9635,7 +11624,7 @@ export namespace dataplex_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Delete + | Params$Resource$Projects$Locations$Entrytypes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9651,12 +11640,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Delete; + {}) as Params$Resource$Projects$Locations$Entrytypes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$Delete; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Delete; options = {}; } @@ -9691,7 +11680,7 @@ export namespace dataplex_v1 { } /** - * Retrieves a EntryGroup resource. + * Gets an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9699,56 +11688,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Entrygroups$Get, + params: Params$Resource$Projects$Locations$Entrytypes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Entrygroups$Get, + params?: Params$Resource$Projects$Locations$Entrytypes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Entrygroups$Get, + params: Params$Resource$Projects$Locations$Entrytypes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Entrygroups$Get, + params: Params$Resource$Projects$Locations$Entrytypes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Entrygroups$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Entrytypes$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrytypes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Get; + {}) as Params$Resource$Projects$Locations$Entrytypes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$Get; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Get; options = {}; } @@ -9773,12 +11762,12 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -9793,25 +11782,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + params?: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Getiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -9819,7 +11808,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Getiampolicy + | Params$Resource$Projects$Locations$Entrytypes$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9835,13 +11824,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Getiampolicy; + {} as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; options = {}; } @@ -9879,7 +11868,7 @@ export namespace dataplex_v1 { } /** - * Lists EntryGroup resources in a project and location. + * Lists EntryType resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9887,56 +11876,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Entrygroups$List, + params: Params$Resource$Projects$Locations$Entrytypes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Entrygroups$List, + params?: Params$Resource$Projects$Locations$Entrytypes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Entrygroups$List, + params: Params$Resource$Projects$Locations$Entrytypes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Entrygroups$List, + params: Params$Resource$Projects$Locations$Entrytypes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Entrygroups$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Entrytypes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Entrytypes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$List; + {}) as Params$Resource$Projects$Locations$Entrytypes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$List; + params = {} as Params$Resource$Projects$Locations$Entrytypes$List; options = {}; } @@ -9949,7 +11938,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entryGroups').replace( + url: (rootUrl + '/v1/{+parent}/entryTypes').replace( /([^:]\/)\/+/g, '$1' ), @@ -9964,19 +11953,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a EntryGroup resource. + * Updates an EntryType. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9984,27 +11973,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Entrygroups$Patch, + params: Params$Resource$Projects$Locations$Entrytypes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Entrygroups$Patch, + params?: Params$Resource$Projects$Locations$Entrytypes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Entrygroups$Patch, + params: Params$Resource$Projects$Locations$Entrytypes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Entrygroups$Patch, + params: Params$Resource$Projects$Locations$Entrytypes$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Entrygroups$Patch, + params: Params$Resource$Projects$Locations$Entrytypes$Patch, callback: BodyResponseCallback ): void; patch( @@ -10012,7 +12001,7 @@ export namespace dataplex_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Patch + | Params$Resource$Projects$Locations$Entrytypes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10028,12 +12017,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Patch; + {}) as Params$Resource$Projects$Locations$Entrytypes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$Patch; + params = {} as Params$Resource$Projects$Locations$Entrytypes$Patch; options = {}; } @@ -10076,25 +12065,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + params?: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Setiampolicy, + params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy( @@ -10102,7 +12091,7 @@ export namespace dataplex_v1 { ): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + | Params$Resource$Projects$Locations$Entrytypes$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10118,13 +12107,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Entrytypes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Setiampolicy; + {} as Params$Resource$Projects$Locations$Entrytypes$Setiampolicy; options = {}; } @@ -10170,27 +12159,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + params?: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Entrygroups$Testiampermissions, + params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -10198,7 +12187,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Testiampermissions + | Params$Resource$Projects$Locations$Entrytypes$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10214,13 +12203,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Entrytypes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Testiampermissions; + {} as Params$Resource$Projects$Locations$Entrytypes$Testiampermissions; options = {}; } @@ -10260,45 +12249,45 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Entrygroups$Create + export interface Params$Resource$Projects$Locations$Entrytypes$Create extends StandardParameters { /** - * Required. EntryGroup identifier. + * Required. EntryType identifier. */ - entryGroupId?: string; + entryTypeId?: string; /** - * Required. The resource name of the entryGroup, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request without performing any mutations. The default is false. */ validateOnly?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1EntryGroup; + requestBody?: Schema$GoogleCloudDataplexV1EntryType; } - export interface Params$Resource$Projects$Locations$Entrygroups$Delete + export interface Params$Resource$Projects$Locations$Entrytypes$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryGroupRequest method returns an ABORTED error response + * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response. */ etag?: string; /** - * Required. The resource name of the EntryGroup: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + * Required. The resource name of the EntryType: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Entrygroups$Get + export interface Params$Resource$Projects$Locations$Entrytypes$Get extends StandardParameters { /** - * Required. The resource name of the EntryGroup: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + * Required. The resource name of the EntryType: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Entrygroups$Getiampolicy + export interface Params$Resource$Projects$Locations$Entrytypes$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -10309,33 +12298,33 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Entrygroups$List + export interface Params$Resource$Projects$Locations$Entrytypes$List extends StandardParameters { /** - * Optional. Filter request. + * Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"These restrictions can be conjoined with AND, OR, and NOT conjunctions. */ filter?: string; /** - * Optional. Order by fields for the result. + * Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined. */ orderBy?: string; /** - * Optional. Maximum number of EntryGroups to return. The service may return fewer than this value. If unspecified, at most 10 EntryGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 EntryTypes. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListEntryGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryGroups must match the call that provided the page token. + * Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provided to ListEntryTypes must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the entryGroup location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the EntryType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a Google Cloud region. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Entrygroups$Patch + export interface Params$Resource$Projects$Locations$Entrytypes$Patch extends StandardParameters { /** - * Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number\}/locations/{location_id\}/entryGroups/{entry_group_id\}. + * Output only. The relative resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. */ name?: string; /** @@ -10343,16 +12332,16 @@ export namespace dataplex_v1 { */ updateMask?: string; /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Optional. The service validates the request without performing any mutations. The default is false. */ validateOnly?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1EntryGroup; + requestBody?: Schema$GoogleCloudDataplexV1EntryType; } - export interface Params$Resource$Projects$Locations$Entrygroups$Setiampolicy + export interface Params$Resource$Projects$Locations$Entrytypes$Setiampolicy extends StandardParameters { /** * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -10364,7 +12353,7 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Entrygroups$Testiampermissions + export interface Params$Resource$Projects$Locations$Entrytypes$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -10377,72 +12366,164 @@ export namespace dataplex_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Entrygroups$Entries { + export class Resource$Projects$Locations$Glossaries { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates an Entry. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + getIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Glossaries$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, - options: + getIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Glossaries$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Glossaries$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Glossaries$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Glossaries$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Create, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Glossaries$Setiampolicy, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - create( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Glossaries$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Create; + {}) as Params$Resource$Projects$Locations$Glossaries$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Create; + {} as Params$Resource$Projects$Locations$Glossaries$Setiampolicy; options = {}; } @@ -10455,7 +12536,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entries').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -10465,80 +12546,80 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an Entry. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Glossaries$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Glossaries$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Glossaries$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Glossaries$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Glossaries$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Glossaries$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Delete; + {}) as Params$Resource$Projects$Locations$Glossaries$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Delete; + {} as Params$Resource$Projects$Locations$Glossaries$Testiampermissions; options = {}; } @@ -10551,87 +12632,133 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Glossaries$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Glossaries$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Glossaries$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Governancerules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets a single entry. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + getIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - get( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Governancerules$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Get; + {}) as Params$Resource$Projects$Locations$Governancerules$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Get; + {} as Params$Resource$Projects$Locations$Governancerules$Getiampolicy; options = {}; } @@ -10644,87 +12771,88 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists entries within an entry group. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + setIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - list( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Governancerules$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$List; + {}) as Params$Resource$Projects$Locations$Governancerules$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Entries$List; + {} as Params$Resource$Projects$Locations$Governancerules$Setiampolicy; options = {}; } @@ -10737,92 +12865,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entries').replace( + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an Entry. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + testIamPermissions( + params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + testIamPermissions( + params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - patch( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Governancerules$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; + {}) as Params$Resource$Projects$Locations$Governancerules$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; + {} as Params$Resource$Projects$Locations$Governancerules$Testiampermissions; options = {}; } @@ -10835,126 +12961,97 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Create - extends StandardParameters { - /** - * Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use Entry ID format based on Full Resource Names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a Full Resource Name of the resource without the prefix double slashes in the API Service Name part of Full Resource Name. This allows retrieval of entries using their associated resource name.For example if the Full Resource Name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from other providers or systems than Google Cloud.The maximum size of the field is 4000 characters. - */ - entryId?: string; - /** - * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Entry; - } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Delete - extends StandardParameters { - /** - * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Get + export interface Params$Resource$Projects$Locations$Governancerules$Getiampolicy extends StandardParameters { /** - * Optional. Limits the aspects returned to the provided aspect types. Only works if the CUSTOM view is selected. - */ - aspectTypes?: string[]; - /** - * Required. The resource name of the Entry: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. - */ - name?: string; - /** - * Optional. Limits the aspects returned to those associated with the provided paths within the Entry. Only works if the CUSTOM view is selected. + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). */ - paths?: string[]; + 'options.requestedPolicyVersion'?: number; /** - * Optional. View for controlling which parts of an entry are to be returned. + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - view?: string; + resource?: string; } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$List + export interface Params$Resource$Projects$Locations$Governancerules$Setiampolicy extends StandardParameters { /** - * Optional. A filter on the entries to return. Filters are case-sensitive. The request can be filtered by the following fields: entry_type, entry_source.display_name. The comparison operators are =, !=, <, \>, <=, \>= (strings are compared according to lexical order) The logical operators AND, OR, NOT can be used in the filter. Wildcard "*" can be used, but for entry_type the full project id or number needs to be provided. Example filter expressions: "entry_source.display_name=AnExampleDisplayName" "entry_type=projects/example-project/locations/global/entryTypes/example-entry_type" "entry_type=projects/example-project/locations/us/entryTypes/a* OR entry_type=projects/another-project/locations/x" "NOT entry_source.display_name=AnotherExampleDisplayName" - */ - filter?: string; - /** - * - */ - pageSize?: number; - /** - * Optional. The pagination token returned by a previous request. + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - pageToken?: string; + resource?: string; + /** - * Required. The resource name of the parent Entry Group: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}. + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch + export interface Params$Resource$Projects$Locations$Governancerules$Testiampermissions extends StandardParameters { /** - * Optional. If set to true and the entry does not exist, it will be created. - */ - allowMissing?: boolean; - /** - * Optional. The map keys of the Aspects which should be modified. Supports the following syntaxes: * - matches aspect on given type and empty path * @path - matches aspect on given type and specified path * * - matches aspects on given type for all paths * *@path - matches aspects of all types on the given pathExisting aspects matching the syntax will not be removed unless delete_missing_aspects is set to true.If this field is left empty, it will be treated as specifying exactly those Aspects present in the request. - */ - aspectKeys?: string[]; - /** - * Optional. If set to true and the aspect_keys specify aspect ranges, any existing aspects from that range not provided in the request will be deleted. - */ - deleteMissingAspects?: boolean; - /** - * Identifier. The relative resource name of the Entry, of the form: projects/{project\}/locations/{location\}/entryGroups/{entry_group\}/entries/{entry\}. - */ - name?: string; - /** - * Optional. Mask of fields to update. To update Aspects, the update_mask must contain the value "aspects".If the update_mask is empty, all modifiable fields present in the request will be updated. + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - updateMask?: string; + resource?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1Entry; + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Entrytypes { + export class Resource$Projects$Locations$Lakes { context: APIRequestContext; + actions: Resource$Projects$Locations$Lakes$Actions; + content: Resource$Projects$Locations$Lakes$Content; + contentitems: Resource$Projects$Locations$Lakes$Contentitems; + environments: Resource$Projects$Locations$Lakes$Environments; + tasks: Resource$Projects$Locations$Lakes$Tasks; + zones: Resource$Projects$Locations$Lakes$Zones; constructor(context: APIRequestContext) { this.context = context; + this.actions = new Resource$Projects$Locations$Lakes$Actions( + this.context + ); + this.content = new Resource$Projects$Locations$Lakes$Content( + this.context + ); + this.contentitems = new Resource$Projects$Locations$Lakes$Contentitems( + this.context + ); + this.environments = new Resource$Projects$Locations$Lakes$Environments( + this.context + ); + this.tasks = new Resource$Projects$Locations$Lakes$Tasks(this.context); + this.zones = new Resource$Projects$Locations$Lakes$Zones(this.context); } /** - * Creates an EntryType + * Creates a lake resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10962,27 +13059,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Entrytypes$Create, + params: Params$Resource$Projects$Locations$Lakes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Entrytypes$Create, + params?: Params$Resource$Projects$Locations$Lakes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Entrytypes$Create, + params: Params$Resource$Projects$Locations$Lakes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Entrytypes$Create, + params: Params$Resource$Projects$Locations$Lakes$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Entrytypes$Create, + params: Params$Resource$Projects$Locations$Lakes$Create, callback: BodyResponseCallback ): void; create( @@ -10990,7 +13087,7 @@ export namespace dataplex_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Create + | Params$Resource$Projects$Locations$Lakes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11006,12 +13103,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrytypes$Create; + params = {} as Params$Resource$Projects$Locations$Lakes$Create; options = {}; } @@ -11024,7 +13121,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entryTypes').replace( + url: (rootUrl + '/v1/{+parent}/lakes').replace( /([^:]\/)\/+/g, '$1' ), @@ -11049,7 +13146,7 @@ export namespace dataplex_v1 { } /** - * Deletes a EntryType resource. + * Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11057,27 +13154,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Entrytypes$Delete, + params: Params$Resource$Projects$Locations$Lakes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Entrytypes$Delete, + params?: Params$Resource$Projects$Locations$Lakes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Entrytypes$Delete, + params: Params$Resource$Projects$Locations$Lakes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Entrytypes$Delete, + params: Params$Resource$Projects$Locations$Lakes$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Entrytypes$Delete, + params: Params$Resource$Projects$Locations$Lakes$Delete, callback: BodyResponseCallback ): void; delete( @@ -11085,7 +13182,7 @@ export namespace dataplex_v1 { ): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Delete + | Params$Resource$Projects$Locations$Lakes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11101,12 +13198,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrytypes$Delete; + params = {} as Params$Resource$Projects$Locations$Lakes$Delete; options = {}; } @@ -11141,7 +13238,7 @@ export namespace dataplex_v1 { } /** - * Retrieves a EntryType resource. + * Retrieves a lake resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11149,56 +13246,54 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Entrytypes$Get, + params: Params$Resource$Projects$Locations$Lakes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Entrytypes$Get, + params?: Params$Resource$Projects$Locations$Lakes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Entrytypes$Get, + params: Params$Resource$Projects$Locations$Lakes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Entrytypes$Get, + params: Params$Resource$Projects$Locations$Lakes$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Entrytypes$Get, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Get, + callback: BodyResponseCallback ): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrytypes$Get; + params = {} as Params$Resource$Projects$Locations$Lakes$Get; options = {}; } @@ -11223,14 +13318,12 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } @@ -11243,25 +13336,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + params?: Params$Resource$Projects$Locations$Lakes$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -11269,7 +13362,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Getiampolicy + | Params$Resource$Projects$Locations$Lakes$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11285,13 +13378,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Entrytypes$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Lakes$Getiampolicy; options = {}; } @@ -11329,7 +13421,7 @@ export namespace dataplex_v1 { } /** - * Lists EntryType resources in a project and location. + * Lists lake resources in a project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11337,56 +13429,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Entrytypes$List, + params: Params$Resource$Projects$Locations$Lakes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Entrytypes$List, + params?: Params$Resource$Projects$Locations$Lakes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Entrytypes$List, + params: Params$Resource$Projects$Locations$Lakes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Entrytypes$List, + params: Params$Resource$Projects$Locations$Lakes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Entrytypes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$List; + {}) as Params$Resource$Projects$Locations$Lakes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrytypes$List; + params = {} as Params$Resource$Projects$Locations$Lakes$List; options = {}; } @@ -11399,7 +13491,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entryTypes').replace( + url: (rootUrl + '/v1/{+parent}/lakes').replace( /([^:]\/)\/+/g, '$1' ), @@ -11414,19 +13506,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a EntryType resource. + * Updates a lake resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11434,27 +13526,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Entrytypes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Entrytypes$Patch, + params?: Params$Resource$Projects$Locations$Lakes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Entrytypes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Entrytypes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Entrytypes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Patch, callback: BodyResponseCallback ): void; patch( @@ -11462,7 +13554,7 @@ export namespace dataplex_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Patch + | Params$Resource$Projects$Locations$Lakes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11478,12 +13570,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrytypes$Patch; + params = {} as Params$Resource$Projects$Locations$Lakes$Patch; options = {}; } @@ -11526,25 +13618,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, + params?: Params$Resource$Projects$Locations$Lakes$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Entrytypes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy( @@ -11552,7 +13644,7 @@ export namespace dataplex_v1 { ): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Setiampolicy + | Params$Resource$Projects$Locations$Lakes$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11568,13 +13660,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Entrytypes$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Lakes$Setiampolicy; options = {}; } @@ -11620,27 +13711,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, + params?: Params$Resource$Projects$Locations$Lakes$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Entrytypes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -11648,7 +13739,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrytypes$Testiampermissions + | Params$Resource$Projects$Locations$Lakes$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11664,13 +13755,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrytypes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Entrytypes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lakes$Testiampermissions; options = {}; } @@ -11710,14 +13801,14 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Entrytypes$Create + export interface Params$Resource$Projects$Locations$Lakes$Create extends StandardParameters { /** - * Required. EntryType identifier. + * Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location. */ - entryTypeId?: string; + lakeId?: string; /** - * Required. The resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the lake location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. */ parent?: string; /** @@ -11728,27 +13819,23 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1EntryType; + requestBody?: Schema$GoogleCloudDataplexV1Lake; } - export interface Params$Resource$Projects$Locations$Entrytypes$Delete + export interface Params$Resource$Projects$Locations$Lakes$Delete extends StandardParameters { /** - * Optional. If the client provided etag value does not match the current etag value, the DeleteEntryTypeRequest method returns an ABORTED error response - */ - etag?: string; - /** - * Required. The resource name of the EntryType: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + * Required. The resource name of the lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Entrytypes$Get + export interface Params$Resource$Projects$Locations$Lakes$Get extends StandardParameters { /** - * Required. The resource name of the EntryType: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + * Required. The resource name of the lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Entrytypes$Getiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -11759,33 +13846,33 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Entrytypes$List + export interface Params$Resource$Projects$Locations$Lakes$List extends StandardParameters { /** - * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 name = "value" These restrictions can be coinjoined with AND, OR and NOT conjunctions. + * Optional. Filter request. */ filter?: string; /** - * Optional. Order by fields (name or create_time) for the result. If not specified, the ordering is undefined. + * Optional. Order by fields for the result. */ orderBy?: string; /** - * Optional. Maximum number of EntryTypes to return. The service may return fewer than this value. If unspecified, at most 10 EntryTypes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListEntryTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntryTypes must match the call that provided the page token. + * Optional. Page token received from a previous ListLakes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakes must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the EntryType location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the lake location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Entrytypes$Patch + export interface Params$Resource$Projects$Locations$Lakes$Patch extends StandardParameters { /** - * Output only. The relative resource name of the EntryType, of the form: projects/{project_number\}/locations/{location_id\}/entryTypes/{entry_type_id\}. + * Output only. The relative resource name of the lake, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. */ name?: string; /** @@ -11800,287 +13887,98 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1EntryType; - } - export interface Params$Resource$Projects$Locations$Entrytypes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + requestBody?: Schema$GoogleCloudDataplexV1Lake; } - export interface Params$Resource$Projects$Locations$Entrytypes$Testiampermissions + export interface Params$Resource$Projects$Locations$Lakes$Setiampolicy extends StandardParameters { /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Governancerules { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Governancerules$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Governancerules$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Governancerules$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Governancerules$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Governancerules$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Governancerules$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; + resource?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Governancerules$Setiampolicy; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Lakes$Actions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists action resources in a lake. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Lakes$Actions$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Lakes$Actions$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lakes$Actions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Lakes$Actions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Governancerules$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Actions$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Governancerules$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Actions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Governancerules$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Actions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Governancerules$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Lakes$Actions$List; options = {}; } @@ -12093,97 +13991,57 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/actions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Governancerules$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Governancerules$Setiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Actions$List extends StandardParameters { /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Governancerules$Testiampermissions - extends StandardParameters { + pageSize?: number; /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token. */ - resource?: string; - + pageToken?: string; /** - * Request body metadata + * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + parent?: string; } - export class Resource$Projects$Locations$Lakes { + export class Resource$Projects$Locations$Lakes$Content { context: APIRequestContext; - actions: Resource$Projects$Locations$Lakes$Actions; - content: Resource$Projects$Locations$Lakes$Content; - contentitems: Resource$Projects$Locations$Lakes$Contentitems; - environments: Resource$Projects$Locations$Lakes$Environments; - tasks: Resource$Projects$Locations$Lakes$Tasks; - zones: Resource$Projects$Locations$Lakes$Zones; constructor(context: APIRequestContext) { this.context = context; - this.actions = new Resource$Projects$Locations$Lakes$Actions( - this.context - ); - this.content = new Resource$Projects$Locations$Lakes$Content( - this.context - ); - this.contentitems = new Resource$Projects$Locations$Lakes$Contentitems( - this.context - ); - this.environments = new Resource$Projects$Locations$Lakes$Environments( - this.context - ); - this.tasks = new Resource$Projects$Locations$Lakes$Tasks(this.context); - this.zones = new Resource$Projects$Locations$Lakes$Zones(this.context); } /** - * Creates a lake resource. + * Create a content. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12191,56 +14049,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lakes$Create, + params: Params$Resource$Projects$Locations$Lakes$Content$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lakes$Create, + params?: Params$Resource$Projects$Locations$Lakes$Content$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lakes$Create, + params: Params$Resource$Projects$Locations$Lakes$Content$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lakes$Create, + params: Params$Resource$Projects$Locations$Lakes$Content$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lakes$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Content$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Content$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Create; + params = {} as Params$Resource$Projects$Locations$Lakes$Content$Create; options = {}; } @@ -12253,7 +14111,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lakes').replace( + url: (rootUrl + '/v1/{+parent}/content').replace( /([^:]\/)\/+/g, '$1' ), @@ -12268,17 +14126,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted. + * Delete a content. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12286,56 +14146,49 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lakes$Delete, + params: Params$Resource$Projects$Locations$Lakes$Content$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lakes$Delete, + params?: Params$Resource$Projects$Locations$Lakes$Content$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lakes$Delete, + params: Params$Resource$Projects$Locations$Lakes$Content$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lakes$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Content$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Content$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Content$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Delete; + params = {} as Params$Resource$Projects$Locations$Lakes$Content$Delete; options = {}; } @@ -12360,17 +14213,17 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a lake resource. + * Get a content resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12378,54 +14231,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lakes$Get, + params: Params$Resource$Projects$Locations$Lakes$Content$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lakes$Get, + params?: Params$Resource$Projects$Locations$Lakes$Content$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lakes$Get, + params: Params$Resource$Projects$Locations$Lakes$Content$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Get, + params: Params$Resource$Projects$Locations$Lakes$Content$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Content$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Content$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Get; + params = {} as Params$Resource$Projects$Locations$Lakes$Content$Get; options = {}; } @@ -12450,17 +14305,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12468,25 +14325,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Getiampolicy, + params?: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -12494,7 +14351,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Getiampolicy + | Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12510,12 +14367,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy; options = {}; } @@ -12553,7 +14411,7 @@ export namespace dataplex_v1 { } /** - * Lists lake resources in a project and location. + * List content. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12561,56 +14419,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$List, + params: Params$Resource$Projects$Locations$Lakes$Content$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$List, + params?: Params$Resource$Projects$Locations$Lakes$Content$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$List, + params: Params$Resource$Projects$Locations$Lakes$Content$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$List, + params: Params$Resource$Projects$Locations$Lakes$Content$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Content$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Content$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$List; + {}) as Params$Resource$Projects$Locations$Lakes$Content$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$List; + params = {} as Params$Resource$Projects$Locations$Lakes$Content$List; options = {}; } @@ -12623,7 +14481,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lakes').replace( + url: (rootUrl + '/v1/{+parent}/content').replace( /([^:]\/)\/+/g, '$1' ), @@ -12638,19 +14496,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a lake resource. + * Update a content. Only supports full resource update. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12658,56 +14516,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lakes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Content$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lakes$Patch, + params?: Params$Resource$Projects$Locations$Lakes$Content$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lakes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Content$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lakes$Patch, + params: Params$Resource$Projects$Locations$Lakes$Content$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lakes$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Content$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Content$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Patch; + params = {} as Params$Resource$Projects$Locations$Lakes$Content$Patch; options = {}; } @@ -12732,17 +14590,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12750,25 +14610,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Setiampolicy, + params?: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy( @@ -12776,7 +14636,7 @@ export namespace dataplex_v1 { ): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Setiampolicy + | Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12792,12 +14652,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Setiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy; options = {}; } @@ -12835,7 +14696,7 @@ export namespace dataplex_v1 { } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12843,27 +14704,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Testiampermissions, + params?: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -12871,7 +14732,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Testiampermissions + | Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12887,13 +14748,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions; options = {}; } @@ -12933,14 +14794,10 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Lakes$Create + export interface Params$Resource$Projects$Locations$Lakes$Content$Create extends StandardParameters { /** - * Required. Lake identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the customer project / location. - */ - lakeId?: string; - /** - * Required. The resource name of the lake location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\} */ parent?: string; /** @@ -12951,23 +14808,27 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1Lake; + requestBody?: Schema$GoogleCloudDataplexV1Content; } - export interface Params$Resource$Projects$Locations$Lakes$Delete + export interface Params$Resource$Projects$Locations$Lakes$Content$Delete extends StandardParameters { /** - * Required. The resource name of the lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + * Required. The resource name of the content: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Get + export interface Params$Resource$Projects$Locations$Lakes$Content$Get extends StandardParameters { /** - * Required. The resource name of the lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + * Required. The resource name of the content: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} */ name?: string; + /** + * Optional. Specify content view to make a partial request. + */ + view?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Getiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -12978,33 +14839,29 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Lakes$List + export interface Params$Resource$Projects$Locations$Lakes$Content$List extends StandardParameters { /** - * Optional. Filter request. + * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT"These restrictions can be coinjoined with AND, OR and NOT conjunctions. */ filter?: string; /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of Lakes to return. The service may return fewer than this value. If unspecified, at most 10 lakes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListLakes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakes must match the call that provided the page token. + * Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the lake location, of the form: projects/{project_number\}/locations/{location_id\} where location_id refers to a GCP region. + * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\} */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Patch + export interface Params$Resource$Projects$Locations$Lakes$Content$Patch extends StandardParameters { /** - * Output only. The relative resource name of the lake, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + * Output only. The relative resource name of the content, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} */ name?: string; /** @@ -13019,9 +14876,9 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1Lake; + requestBody?: Schema$GoogleCloudDataplexV1Content; } - export interface Params$Resource$Projects$Locations$Lakes$Setiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy extends StandardParameters { /** * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -13033,7 +14890,7 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Lakes$Testiampermissions + export interface Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -13046,127 +14903,7 @@ export namespace dataplex_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } - export class Resource$Projects$Locations$Lakes$Actions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Lists action resources in a lake. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Lakes$Actions$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lakes$Actions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lakes$Actions$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Actions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Actions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Actions$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Actions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Actions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/actions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Lakes$Actions$List - extends StandardParameters { - /** - * Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListLakeActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListLakeActions must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Lakes$Content { + export class Resource$Projects$Locations$Lakes$Contentitems { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -13181,27 +14918,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lakes$Content$Create, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lakes$Content$Create, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lakes$Content$Create, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lakes$Content$Create, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lakes$Content$Create, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, callback: BodyResponseCallback ): void; create( @@ -13209,7 +14946,7 @@ export namespace dataplex_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Create + | Params$Resource$Projects$Locations$Lakes$Contentitems$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13225,12 +14962,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Content$Create; + params = + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Create; options = {}; } @@ -13243,7 +14981,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/content').replace( + url: (rootUrl + '/v1/{+parent}/contentitems').replace( /([^:]\/)\/+/g, '$1' ), @@ -13278,31 +15016,31 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lakes$Content$Delete, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lakes$Content$Delete, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lakes$Content$Delete, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lakes$Content$Delete, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lakes$Content$Delete, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Delete + | Params$Resource$Projects$Locations$Lakes$Contentitems$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13315,12 +15053,13 @@ export namespace dataplex_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Content$Delete; + params = + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Delete; options = {}; } @@ -13363,27 +15102,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lakes$Content$Get, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lakes$Content$Get, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lakes$Content$Get, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Content$Get, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Content$Get, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, callback: BodyResponseCallback ): void; get( @@ -13391,7 +15130,7 @@ export namespace dataplex_v1 { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Get + | Params$Resource$Projects$Locations$Lakes$Contentitems$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13407,12 +15146,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Content$Get; + params = + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Get; options = {}; } @@ -13457,25 +15197,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, options?: MethodOptions ): GaxiosPromise; getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, callback: BodyResponseCallback ): void; getIamPolicy( @@ -13483,7 +15223,7 @@ export namespace dataplex_v1 { ): void; getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy + | Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13499,13 +15239,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy; options = {}; } @@ -13551,27 +15291,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Content$List, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Content$List, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Content$List, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Content$List, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Content$List, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, callback: BodyResponseCallback ): void; list( @@ -13579,7 +15319,7 @@ export namespace dataplex_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$List + | Params$Resource$Projects$Locations$Lakes$Contentitems$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13595,12 +15335,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$List; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Content$List; + params = + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$List; options = {}; } @@ -13613,7 +15354,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/content').replace( + url: (rootUrl + '/v1/{+parent}/contentitems').replace( /([^:]\/)\/+/g, '$1' ), @@ -13648,27 +15389,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lakes$Content$Patch, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lakes$Content$Patch, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lakes$Content$Patch, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lakes$Content$Patch, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lakes$Content$Patch, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, callback: BodyResponseCallback ): void; patch( @@ -13676,7 +15417,7 @@ export namespace dataplex_v1 { ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Patch + | Params$Resource$Projects$Locations$Lakes$Contentitems$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13692,12 +15433,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Content$Patch; + params = + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Patch; options = {}; } @@ -13742,25 +15484,25 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, options?: MethodOptions ): GaxiosPromise; setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, callback: BodyResponseCallback ): void; setIamPolicy( @@ -13768,7 +15510,7 @@ export namespace dataplex_v1 { ): void; setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy + | Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13784,13 +15526,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy; options = {}; } @@ -13836,27 +15578,27 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, + params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, options?: MethodOptions ): GaxiosPromise; testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions, + params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, callback: BodyResponseCallback ): void; testIamPermissions( @@ -13864,7 +15606,7 @@ export namespace dataplex_v1 { ): void; testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions + | Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13880,13 +15622,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions; options = {}; } @@ -13926,7 +15668,7 @@ export namespace dataplex_v1 { } } - export interface Params$Resource$Projects$Locations$Lakes$Content$Create + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Create extends StandardParameters { /** * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\} @@ -13942,14 +15684,14 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleCloudDataplexV1Content; } - export interface Params$Resource$Projects$Locations$Lakes$Content$Delete + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Delete extends StandardParameters { /** * Required. The resource name of the content: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} */ name?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Content$Get + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Get extends StandardParameters { /** * Required. The resource name of the content: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} @@ -13960,7 +15702,7 @@ export namespace dataplex_v1 { */ view?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Content$Getiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy extends StandardParameters { /** * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). @@ -13971,7 +15713,7 @@ export namespace dataplex_v1 { */ resource?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Content$List + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$List extends StandardParameters { /** * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT"These restrictions can be coinjoined with AND, OR and NOT conjunctions. @@ -13990,7 +15732,7 @@ export namespace dataplex_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Content$Patch + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Patch extends StandardParameters { /** * Output only. The relative resource name of the content, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} @@ -14010,7 +15752,7 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleCloudDataplexV1Content; } - export interface Params$Resource$Projects$Locations$Lakes$Content$Setiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy extends StandardParameters { /** * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. @@ -14022,362 +15764,90 @@ export namespace dataplex_v1 { */ requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Lakes$Content$Testiampermissions + export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions extends StandardParameters { /** * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Lakes$Contentitems { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Create a content. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/contentitems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Delete a content. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } + */ + resource?: string; /** - * Get a content resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Request body metadata */ - get( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + export class Resource$Projects$Locations$Lakes$Environments { + context: APIRequestContext; + sessions: Resource$Projects$Locations$Lakes$Environments$Sessions; + constructor(context: APIRequestContext) { + this.context = context; + this.sessions = + new Resource$Projects$Locations$Lakes$Environments$Sessions( + this.context ); - } } /** - * Gets the access control policy for a contentitem resource. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.Caller must have Google IAM dataplex.content.getIamPolicy permission on the resource. + * Create an environment resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Lakes$Environments$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lakes$Environments$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Environments$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Environments$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Create; options = {}; } @@ -14390,90 +15860,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/environments').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * List content. + * Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, + delete( + params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$List, + delete( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, + delete( + params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$List; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$List; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Delete; options = {}; } @@ -14486,92 +15956,87 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/contentitems').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Update a content. Only supports full resource update. + * Get environment resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, + get( + params: Params$Resource$Projects$Locations$Lakes$Environments$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, + get( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lakes$Environments$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, + get( + params: Params$Resource$Projects$Locations$Lakes$Environments$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Environments$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Patch; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Get; options = {}; } @@ -14585,7 +16050,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -14596,53 +16061,53 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Sets the access control policy on the specified contentitem resource. Replaces any existing policy.Caller must have Google IAM dataplex.content.setIamPolicy permission on the resource. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, options?: MethodOptions ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy, + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( callback: BodyResponseCallback ): void; - setIamPolicy( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy + | Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14658,13 +16123,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy; options = {}; } @@ -14677,11 +16142,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -14702,65 +16167,65 @@ export namespace dataplex_v1 { } /** - * Returns the caller's permissions on a resource. If the resource does not exist, an empty set of permissions is returned (a NOT_FOUND error is not returned).A caller is not required to have Google IAM permission to make this request.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists environments under the given lake. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Lakes$Environments$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Lakes$Environments$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lakes$Environments$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Lakes$Environments$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Environments$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lakes$Environments$List; options = {}; } @@ -14773,191 +16238,70 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/environments').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Create - extends StandardParameters { - /** - * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\} - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Content; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Delete - extends StandardParameters { - /** - * Required. The resource name of the content: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Get - extends StandardParameters { - /** - * Required. The resource name of the content: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} - */ - name?: string; - /** - * Optional. Specify content view to make a partial request. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$List - extends StandardParameters { - /** - * Optional. Filter request. Filters are case-sensitive. The following formats are supported:labels.key1 = "value1" labels:key1 type = "NOTEBOOK" type = "SQL_SCRIPT"These restrictions can be coinjoined with AND, OR and NOT conjunctions. - */ - filter?: string; - /** - * Optional. Maximum number of content to return. The service may return fewer than this value. If unspecified, at most 10 content will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListContent call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListContent must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\} - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the content, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/content/{content_id\} - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Content; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Contentitems$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Lakes$Environments { - context: APIRequestContext; - sessions: Resource$Projects$Locations$Lakes$Environments$Sessions; - constructor(context: APIRequestContext) { - this.context = context; - this.sessions = - new Resource$Projects$Locations$Lakes$Environments$Sessions( - this.context + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters ); + } } /** - * Create an environment resource. + * Update the environment resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lakes$Environments$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Create, + patch( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lakes$Environments$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Environments$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Environments$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Create + | Params$Resource$Projects$Locations$Lakes$Environments$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14973,13 +16317,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Create; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Patch; options = {}; } @@ -14992,18 +16336,15 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/environments').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -15017,65 +16358,63 @@ export namespace dataplex_v1 { } /** - * Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Environments$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - delete( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Delete; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy; options = {}; } @@ -15088,87 +16427,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Get environment resource. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lakes$Environments$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lakes$Environments$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Environments$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Environments$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - get( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Get; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions; options = {}; } @@ -15181,125 +16523,154 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Lakes$Environments$Create + extends StandardParameters { + /** + * Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake. + */ + environmentId?: string; + /** + * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Environment; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Delete + extends StandardParameters { + /** + * Required. The resource name of the environment: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environments/{environment_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Get + extends StandardParameters { + /** + * Required. The resource name of the environment: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environments/{environment_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the environment, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\} + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Request body metadata */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; + requestBody?: Schema$GoogleCloudDataplexV1Environment; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Lakes$Environments$Sessions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists environments under the given lake. + * Lists session resources in an environment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15307,57 +16678,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Environments$List, + params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Environments$List, + params?: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Environments$List, + params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Environments$List, + params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Environments$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$List; + {}) as Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$List; + {} as Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List; options = {}; } @@ -15370,7 +16741,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/environments').replace( + url: (rootUrl + '/v1/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -15385,55 +16756,86 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List + extends StandardParameters { /** - * Update the environment resource. + * Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.mode = ADMIN | USER + */ + filter?: string; + /** + * Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListSessions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSessions must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent environment: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Lakes$Tasks { + context: APIRequestContext; + jobs: Resource$Projects$Locations$Lakes$Tasks$Jobs; + constructor(context: APIRequestContext) { + this.context = context; + this.jobs = new Resource$Projects$Locations$Lakes$Tasks$Jobs( + this.context + ); + } + + /** + * Creates a task resource within a lake. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, + create( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Patch, + create( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, + create( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, + create( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Environments$Patch, + create( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Patch + | Params$Resource$Projects$Locations$Lakes$Tasks$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15449,13 +16851,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Patch; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Create; options = {}; } @@ -15468,15 +16869,18 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1/{+parent}/tasks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -15490,63 +16894,64 @@ export namespace dataplex_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Delete the task resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - setIamPolicy( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Delete; options = {}; } @@ -15559,90 +16964,84 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Get task resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, + get( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Get, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, + callback: BodyResponseCallback ): void; - testIamPermissions( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Get; options = {}; } @@ -15655,154 +17054,123 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Lakes$Environments$Create - extends StandardParameters { - /** - * Required. Environment identifier. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the lake. - */ - environmentId?: string; - /** - * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Environment; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$Delete - extends StandardParameters { - /** - * Required. The resource name of the environment: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environments/{environment_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$Get - extends StandardParameters { - /** - * Required. The resource name of the environment: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environments/{environment_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$List - extends StandardParameters { - /** - * Optional. Filter request. - */ - filter?: string; - /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of environments to return. The service may return fewer than this value. If unspecified, at most 10 environments will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListEnvironments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEnvironments must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent lake: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the environment, of the form: projects/{project_id\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\} - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Environment; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - resource?: string; + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Environments$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Lakes$Environments$Sessions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Lists session resources in an environment. + * Lists tasks under the given lake. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15810,57 +17178,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, + params: Params$Resource$Projects$Locations$Lakes$Tasks$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, + params?: Params$Resource$Projects$Locations$Lakes$Tasks$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, + params: Params$Resource$Projects$Locations$Lakes$Tasks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, + params: Params$Resource$Projects$Locations$Lakes$Tasks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Tasks$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$List; options = {}; } @@ -15873,7 +17240,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/sessions').replace( + url: (rootUrl + '/v1/{+parent}/tasks').replace( /([^:]\/)\/+/g, '$1' ), @@ -15888,86 +17255,55 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Lakes$Environments$Sessions$List - extends StandardParameters { - /** - * Optional. Filter request. The following mode filter is supported to return only the sessions belonging to the requester when the mode is USER and return sessions of all the users when the mode is ADMIN. When no filter is sent default to USER mode. NOTE: When the mode is ADMIN, the requester should have dataplex.environments.listAllSessions permission to list all sessions, in absence of the permission, the request fails.mode = ADMIN | USER - */ - filter?: string; - /** - * Optional. Maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 10 sessions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListSessions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSessions must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent environment: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/environment/{environment_id\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Lakes$Tasks { - context: APIRequestContext; - jobs: Resource$Projects$Locations$Lakes$Tasks$Jobs; - constructor(context: APIRequestContext) { - this.context = context; - this.jobs = new Resource$Projects$Locations$Lakes$Tasks$Jobs( - this.context - ); - } /** - * Creates a task resource within a lake. + * Update the task resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Create, + patch( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Create + | Params$Resource$Projects$Locations$Lakes$Tasks$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15983,12 +17319,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Create; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Patch; options = {}; } @@ -16001,18 +17337,15 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tasks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -16026,64 +17359,64 @@ export namespace dataplex_v1 { } /** - * Delete the task resource. + * Run an on demand execution of a Task. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, + run( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, + run( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Run, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, + run( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Delete, - callback: BodyResponseCallback + run( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + run( + callback: BodyResponseCallback ): void; - delete( + run( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Run + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Run; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Delete; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Run; options = {}; } @@ -16096,8 +17429,8 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -16108,72 +17441,75 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Get task resource. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Get, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Get; + params = + {} as Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy; options = {}; } @@ -16186,85 +17522,90 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - getIamPolicy( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions; options = {}; } @@ -16277,11 +17618,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -16292,74 +17633,202 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Create + extends StandardParameters { /** - * Lists tasks under the given lake. + * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + */ + parent?: string; + /** + * Required. Task identifier. + */ + taskId?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Task; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Delete + extends StandardParameters { + /** + * Required. The resource name of the task: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/task/{task_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Get + extends StandardParameters { + /** + * Required. The resource name of the task: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{tasks_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the task, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/ tasks/{task_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Task; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Run + extends StandardParameters { + /** + * Required. The resource name of the task: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1RunTaskRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Lakes$Tasks$Jobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancel jobs running for the task resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$List, + */ + cancel( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$List, + cancel( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$List, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$List, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, + callback: BodyResponseCallback ): void; - list( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$List; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$List; + params = + {} as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel; options = {}; } @@ -16372,91 +17841,84 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/tasks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Update the task resource. + * Get job resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, + get( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Patch, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, + callback: BodyResponseCallback ): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Patch; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get; options = {}; } @@ -16470,7 +17932,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -16481,74 +17943,74 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Run an on demand execution of a Task. + * Lists Jobs under the given task. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - run( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, + list( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, options: StreamMethodOptions ): GaxiosPromise; - run( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Run, + list( + params?: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, options?: MethodOptions - ): GaxiosPromise; - run( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, + list( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - run( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Run, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, + callback: BodyResponseCallback ): void; - run( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - run( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Run - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Run; + {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Run; + params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List; options = {}; } @@ -16561,87 +18023,142 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Required. The resource name of the job: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/task/{task_id\}/job/{job_id\}. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1CancelJobRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get + extends StandardParameters { + /** + * Required. The resource name of the job: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}/jobs/{job_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List + extends StandardParameters { + /** + * Optional. Maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent environment: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Lakes$Zones { + context: APIRequestContext; + actions: Resource$Projects$Locations$Lakes$Zones$Actions; + assets: Resource$Projects$Locations$Lakes$Zones$Assets; + entities: Resource$Projects$Locations$Lakes$Zones$Entities; + constructor(context: APIRequestContext) { + this.context = context; + this.actions = new Resource$Projects$Locations$Lakes$Zones$Actions( + this.context + ); + this.assets = new Resource$Projects$Locations$Lakes$Zones$Assets( + this.context + ); + this.entities = new Resource$Projects$Locations$Lakes$Zones$Entities( + this.context + ); + } + + /** + * Creates a zone resource within a lake. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Create, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, + create( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Create, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - setIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Create; options = {}; } @@ -16654,7 +18171,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/zones').replace( /([^:]\/)\/+/g, '$1' ), @@ -16664,80 +18181,79 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - testIamPermissions( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Delete; options = {}; } @@ -16750,217 +18266,84 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Create - extends StandardParameters { - /** - * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - /** - * Required. Task identifier. - */ - taskId?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Task; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Delete - extends StandardParameters { - /** - * Required. The resource name of the task: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/task/{task_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Get - extends StandardParameters { - /** - * Required. The resource name of the task: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{tasks_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$List - extends StandardParameters { - /** - * Optional. Filter request. - */ - filter?: string; - /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of tasks to return. The service may return fewer than this value. If unspecified, at most 10 tasks will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the task, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/ tasks/{task_id\}. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Task; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Run - extends StandardParameters { - /** - * Required. The resource name of the task: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1RunTaskRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Lakes$Tasks$Jobs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Cancel jobs running for the task resource. + * Retrieves a zone resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. - */ - cancel( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, + */ + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Get, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, + get( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Get, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel; + params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Get; options = {}; } @@ -16973,8 +18356,8 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -16985,72 +18368,73 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Get job resource. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get; + params = + {} as Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy; options = {}; } @@ -17063,29 +18447,32 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Jobs under the given task. + * Lists zone resources in a lake. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17093,56 +18480,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, + params?: Params$Resource$Projects$Locations$Lakes$Zones$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Zones$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List; + params = {} as Params$Resource$Projects$Locations$Lakes$Zones$List; options = {}; } @@ -17155,7 +18542,10 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/jobs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/zones').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -17167,109 +18557,55 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Cancel - extends StandardParameters { - /** - * Required. The resource name of the job: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/task/{task_id\}/job/{job_id\}. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1CancelJobRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$Get - extends StandardParameters { - /** - * Required. The resource name of the job: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}/jobs/{job_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Tasks$Jobs$List - extends StandardParameters { - /** - * Optional. Maximum number of jobs to return. The service may return fewer than this value. If unspecified, at most 10 jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListJobs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListJobs must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent environment: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/tasks/{task_id\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Lakes$Zones { - context: APIRequestContext; - actions: Resource$Projects$Locations$Lakes$Zones$Actions; - assets: Resource$Projects$Locations$Lakes$Zones$Assets; - entities: Resource$Projects$Locations$Lakes$Zones$Entities; - constructor(context: APIRequestContext) { - this.context = context; - this.actions = new Resource$Projects$Locations$Lakes$Zones$Actions( - this.context - ); - this.assets = new Resource$Projects$Locations$Lakes$Zones$Assets( - this.context - ); - this.entities = new Resource$Projects$Locations$Lakes$Zones$Entities( - this.context - ); - } /** - * Creates a zone resource within a lake. + * Updates a zone resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Create, + patch( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Create + | Params$Resource$Projects$Locations$Lakes$Zones$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17285,12 +18621,12 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Create; + params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Patch; options = {}; } @@ -17303,18 +18639,15 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/zones').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -17328,64 +18661,63 @@ export namespace dataplex_v1 { } /** - * Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted. + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Delete, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Delete, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + setIamPolicy( + callback: BodyResponseCallback ): void; - delete( + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Delete; + params = + {} as Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy; options = {}; } @@ -17398,175 +18730,308 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a zone resource. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Get, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Get, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Get, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Get, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Get; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Lakes$Zones$Create + extends StandardParameters { + /** + * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + /** + * Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique across all lakes from all locations in a project. * Must not be one of the reserved IDs (i.e. "default", "global-temp") + */ + zoneId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Zone; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Delete + extends StandardParameters { + /** + * Required. The resource name of the zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Get + extends StandardParameters { + /** + * Required. The resource name of the zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of zones to return. The service may return fewer than this value. If unspecified, at most 10 zones will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the zone, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Zone; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Lakes$Zones$Actions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists action resources in a zone. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Actions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Actions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Actions$List; options = {}; } @@ -17579,7 +19044,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/actions').replace( /([^:]\/)\/+/g, '$1' ), @@ -17589,79 +19054,109 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Lakes$Zones$Actions$List + extends StandardParameters { + /** + * Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListZoneActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZoneActions must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Lakes$Zones$Assets { + context: APIRequestContext; + actions: Resource$Projects$Locations$Lakes$Zones$Assets$Actions; + constructor(context: APIRequestContext) { + this.context = context; + this.actions = new Resource$Projects$Locations$Lakes$Zones$Assets$Actions( + this.context + ); + } /** - * Lists zone resources in a lake. + * Creates an asset resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$List, + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lakes$Zones$List, + create( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$List, + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$List; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Zones$List; + params = + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create; options = {}; } @@ -17674,11 +19169,11 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/zones').replace( + url: (rootUrl + '/v1/{+parent}/assets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -17689,55 +19184,53 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a zone resource. + * Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Patch, + delete( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Patch, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, callback: BodyResponseCallback ): void; - patch( + delete( callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Patch + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17753,12 +19246,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lakes$Zones$Patch; + params = + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete; options = {}; } @@ -17772,7 +19266,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -17793,63 +19287,65 @@ export namespace dataplex_v1 { } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * Retrieves an asset resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - setIamPolicy( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get; options = {}; } @@ -17862,90 +19358,85 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, + getIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions, - callback: BodyResponseCallback + getIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + getIamPolicy( + callback: BodyResponseCallback ): void; - testIamPermissions( + getIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy; options = {}; } @@ -17958,154 +19449,32 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Lakes$Zones$Create - extends StandardParameters { - /** - * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - /** - * Required. Zone identifier. This ID will be used to generate names such as database and dataset names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique across all lakes from all locations in a project. * Must not be one of the reserved IDs (i.e. "default", "global-temp") - */ - zoneId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Zone; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Delete - extends StandardParameters { - /** - * Required. The resource name of the zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Get - extends StandardParameters { - /** - * Required. The resource name of the zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$List - extends StandardParameters { - /** - * Optional. Filter request. - */ - filter?: string; - /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of zones to return. The service may return fewer than this value. If unspecified, at most 10 zones will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListZones call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZones must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent lake: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the zone, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Zone; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Lakes$Zones$Actions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Lists action resources in a zone. + * Lists asset resources in a zone. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18113,57 +19482,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Actions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Actions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Actions$List; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Actions$List; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$List; options = {}; } @@ -18176,7 +19545,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/actions').replace( + url: (rootUrl + '/v1/{+parent}/assets').replace( /([^:]\/)\/+/g, '$1' ), @@ -18191,82 +19560,55 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Lakes$Zones$Actions$List - extends StandardParameters { - /** - * Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. - */ - pageSize?: number; - /** - * Optional. Page token received from a previous ListZoneActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListZoneActions must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Lakes$Zones$Assets { - context: APIRequestContext; - actions: Resource$Projects$Locations$Lakes$Zones$Assets$Actions; - constructor(context: APIRequestContext) { - this.context = context; - this.actions = new Resource$Projects$Locations$Lakes$Zones$Assets$Actions( - this.context - ); - } /** - * Creates an asset resource. + * Updates an asset resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, + patch( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create, + patch( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, callback: BodyResponseCallback ): void; - create( + patch( callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18282,13 +19624,13 @@ export namespace dataplex_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch; options = {}; } @@ -18301,7 +19643,98 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/assets').replace( + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( /([^:]\/)\/+/g, '$1' ), @@ -18311,80 +19744,80 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy. + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete, - callback: BodyResponseCallback + testIamPermissions( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + testIamPermissions( + callback: BodyResponseCallback ): void; - delete( + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions; options = {}; } @@ -18397,87 +19830,212 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['resource'], + pathParams: ['resource'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create + extends StandardParameters { /** - * Retrieves an asset resource. + * Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the zone. + */ + assetId?: string; + /** + * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + */ + parent?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Asset; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete + extends StandardParameters { + /** + * Required. The resource name of the asset: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get + extends StandardParameters { + /** + * Required. The resource name of the asset: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$List + extends StandardParameters { + /** + * Optional. Filter request. + */ + filter?: string; + /** + * Optional. Order by fields for the result. + */ + orderBy?: string; + /** + * Optional. Maximum number of asset to return. The service may return fewer than this value. If unspecified, at most 10 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListAssets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssets must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch + extends StandardParameters { + /** + * Output only. The relative resource name of the asset, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + */ + name?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + /** + * Optional. Only validate the request, but do not perform mutations. The default is false. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1Asset; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Lakes$Zones$Assets$Actions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists action resources in an asset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, + list( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List; options = {}; } @@ -18490,85 +20048,120 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/actions').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * Optional. Page token received from a previous ListAssetActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssetActions must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the parent asset: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Lakes$Zones$Entities { + context: APIRequestContext; + partitions: Resource$Projects$Locations$Lakes$Zones$Entities$Partitions; + constructor(context: APIRequestContext) { + this.context = context; + this.partitions = + new Resource$Projects$Locations$Lakes$Zones$Entities$Partitions( + this.context + ); + } + + /** + * Create a metadata entity. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, + callback: BodyResponseCallback ): void; - getIamPolicy( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getIamPolicy( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create; options = {}; } @@ -18581,90 +20174,83 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/entities').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists asset resources in a zone. + * Delete a metadata entity. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, + delete( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$List; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$List; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete; options = {}; } @@ -18677,92 +20263,87 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/assets').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates an asset resource. + * Get a metadata entity. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, + get( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get; options = {}; } @@ -18776,7 +20357,7 @@ export namespace dataplex_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -18787,73 +20368,75 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. + * List metadata entities in a zone. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, + callback: BodyResponseCallback ): void; - setIamPolicy( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - setIamPolicy( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$List; options = {}; } @@ -18866,90 +20449,92 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/entities').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Update a metadata entity. Only supports full resource update. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, + update( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, + update( + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, + ): GaxiosPromise; + update( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, + update( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions, - callback: BodyResponseCallback + update( + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + update( + callback: BodyResponseCallback ): void; - testIamPermissions( + update( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update; options = {}; } @@ -18962,39 +20547,30 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Create + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create extends StandardParameters { - /** - * Required. Asset identifier. This ID will be used to generate names such as table names when publishing metadata to Hive Metastore and BigQuery. * Must contain only lowercase letters, numbers and hyphens. * Must start with a letter. * Must end with a number or a letter. * Must be between 1-63 characters. * Must be unique within the zone. - */ - assetId?: string; /** * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. */ @@ -19007,235 +20583,78 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1Asset; + requestBody?: Schema$GoogleCloudDataplexV1Entity; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Delete + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete extends StandardParameters { /** - * Required. The resource name of the asset: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + * Required. The etag associated with the entity, which can be retrieved with a GetEntity request. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Get - extends StandardParameters { + etag?: string; /** - * Required. The resource name of the asset: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + * Required. The resource name of the entity: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Getiampolicy + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). + * Required. The resource name of the entity: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. */ - 'options.requestedPolicyVersion'?: number; + name?: string; /** - * REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Used to select the subset of entity information to return. Defaults to BASIC. */ - resource?: string; + view?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$List + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$List extends StandardParameters { /** - * Optional. Filter request. + * Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: Entity ID: ?filter="id=entityID" Asset ID: ?filter="asset=assetID" Data path ?filter="data_path=gs://my-bucket" Is HIVE compatible: ?filter="hive_compatible=true" Is BigQuery compatible: ?filter="bigquery_compatible=true" */ filter?: string; /** - * Optional. Order by fields for the result. - */ - orderBy?: string; - /** - * Optional. Maximum number of asset to return. The service may return fewer than this value. If unspecified, at most 10 assets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500. */ pageSize?: number; /** - * Optional. Page token received from a previous ListAssets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssets must match the call that provided the page token. + * Optional. Page token received from a previous ListEntities call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntities must match the call that provided the page token. */ pageToken?: string; /** * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Patch - extends StandardParameters { - /** - * Output only. The relative resource name of the asset, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. - */ - name?: string; - /** - * Required. Mask of fields to update. - */ - updateMask?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Asset; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Lakes$Zones$Assets$Actions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - /** - * Lists action resources in an asset. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. Specify the entity view to make a partial list request. */ - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/actions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } + view?: string; } - - export interface Params$Resource$Projects$Locations$Lakes$Zones$Assets$Actions$List + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update extends StandardParameters { /** - * Optional. Maximum number of actions to return. The service may return fewer than this value. If unspecified, at most 10 actions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. + * Output only. The resource name of the entity, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{id\}. */ - pageSize?: number; + name?: string; /** - * Optional. Page token received from a previous ListAssetActions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAssetActions must match the call that provided the page token. + * Optional. Only validate the request, but do not perform mutations. The default is false. */ - pageToken?: string; + validateOnly?: boolean; + /** - * Required. The resource name of the parent asset: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/assets/{asset_id\}. + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDataplexV1Entity; } - export class Resource$Projects$Locations$Lakes$Zones$Entities { + export class Resource$Projects$Locations$Lakes$Zones$Entities$Partitions { context: APIRequestContext; - partitions: Resource$Projects$Locations$Lakes$Zones$Entities$Partitions; constructor(context: APIRequestContext) { this.context = context; - this.partitions = - new Resource$Projects$Locations$Lakes$Zones$Entities$Partitions( - this.context - ); } /** - * Create a metadata entity. + * Create a metadata partition. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19243,57 +20662,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create; options = {}; } @@ -19306,7 +20725,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entities').replace( + url: (rootUrl + '/v1/{+parent}/partitions').replace( /([^:]\/)\/+/g, '$1' ), @@ -19321,17 +20740,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Delete a metadata entity. + * Delete a metadata partition. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19339,31 +20760,31 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19376,13 +20797,13 @@ export namespace dataplex_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete; options = {}; } @@ -19417,7 +20838,7 @@ export namespace dataplex_v1 { } /** - * Get a metadata entity. + * Get a metadata partition of an entity. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19425,57 +20846,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get; options = {}; } @@ -19500,17 +20921,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * List metadata entities in a zone. + * List metadata partitions of an entity. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19518,57 +20941,57 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, + params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$List; + {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$List; + {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List; options = {}; } @@ -19581,7 +21004,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/entities').replace( + url: (rootUrl + '/v1/{+parent}/partitions').replace( /([^:]\/)\/+/g, '$1' ), @@ -19591,120 +21014,27 @@ export namespace dataplex_v1 { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Update a metadata entity. Only supports full resource update. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - update( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, - options: StreamMethodOptions - ): GaxiosPromise; - update( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://dataplex.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Create + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create extends StandardParameters { /** - * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. */ parent?: string; /** @@ -19715,136 +21045,104 @@ export namespace dataplex_v1 { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1Entity; + requestBody?: Schema$GoogleCloudDataplexV1Partition; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Delete + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete extends StandardParameters { /** - * Required. The etag associated with the entity, which can be retrieved with a GetEntity request. + * Optional. The etag associated with the partition. */ etag?: string; /** - * Required. The resource name of the entity: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. + * Required. The resource name of the partition. format: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}/partitions/{partition_value_path\}. The {partition_value_path\} segment consists of an ordered sequence of partition values separated by "/". All values must be provided. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Get + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get extends StandardParameters { /** - * Required. The resource name of the entity: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. + * Required. The resource name of the partition: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}/partitions/{partition_value_path\}. The {partition_value_path\} segment consists of an ordered sequence of partition values separated by "/". All values must be provided. */ name?: string; - /** - * Optional. Used to select the subset of entity information to return. Defaults to BASIC. - */ - view?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$List + export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List extends StandardParameters { /** - * Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: Entity ID: ?filter="id=entityID" Asset ID: ?filter="asset=assetID" Data path ?filter="data_path=gs://my-bucket" Is HIVE compatible: ?filter="hive_compatible=true" Is BigQuery compatible: ?filter="bigquery_compatible=true" + * Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax: logic operators: AND, OR comparison operators: <, \>, \>=, <= ,=, != LIKE operators: The right hand of a LIKE operator supports "." and "*" for wildcard searches, for example "value1 LIKE ".*oo.*" parenthetical grouping: ( )Sample filter expression: `?filter="key1 < value1 OR key2 \> value2"Notes: Keys to the left of operators are case insensitive. Partition results are sorted first by creation time, then by lexicographic order. Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter. */ filter?: string; /** - * Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500. + * Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500. */ pageSize?: number; /** - * Optional. Page token received from a previous ListEntities call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListEntities must match the call that provided the page token. + * Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}. + * Required. The resource name of the parent entity: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. */ parent?: string; - /** - * Required. Specify the entity view to make a partial list request. - */ - view?: string; - } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Update - extends StandardParameters { - /** - * Output only. The resource name of the entity, of the form: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{id\}. - */ - name?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. - */ - validateOnly?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDataplexV1Entity; } - export class Resource$Projects$Locations$Lakes$Zones$Entities$Partitions { + export class Resource$Projects$Locations$Metadatajobs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Create a metadata partition. + * Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, + cancel( + params: Params$Resource$Projects$Locations$Metadatajobs$Cancel, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, + cancel( + params?: Params$Resource$Projects$Locations$Metadatajobs$Cancel, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Metadatajobs$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatajobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Metadatajobs$Cancel, + callback: BodyResponseCallback ): void; - create( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatajobs$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create; + {}) as Params$Resource$Projects$Locations$Metadatajobs$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create; + params = {} as Params$Resource$Projects$Locations$Metadatajobs$Cancel; options = {}; } @@ -19857,85 +21155,86 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/partitions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Delete a metadata partition. + * Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, + create( + params: Params$Resource$Projects$Locations$Metadatajobs$Create, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, + create( + params?: Params$Resource$Projects$Locations$Metadatajobs$Create, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Metadatajobs$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatajobs$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Metadatajobs$Create, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatajobs$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete; + {}) as Params$Resource$Projects$Locations$Metadatajobs$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete; + params = {} as Params$Resource$Projects$Locations$Metadatajobs$Create; options = {}; } @@ -19948,29 +21247,32 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/metadataJobs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Get a metadata partition of an entity. + * Gets a metadata job. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19978,57 +21280,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, + params: Params$Resource$Projects$Locations$Metadatajobs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, + params?: Params$Resource$Projects$Locations$Metadatajobs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, + params: Params$Resource$Projects$Locations$Metadatajobs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, + params: Params$Resource$Projects$Locations$Metadatajobs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatajobs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatajobs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get; + {}) as Params$Resource$Projects$Locations$Metadatajobs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get; + params = {} as Params$Resource$Projects$Locations$Metadatajobs$Get; options = {}; } @@ -20053,19 +21354,19 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * List metadata partitions of an entity. + * Lists metadata jobs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -20073,57 +21374,56 @@ export namespace dataplex_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, + params: Params$Resource$Projects$Locations$Metadatajobs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, + params?: Params$Resource$Projects$Locations$Metadatajobs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, + params: Params$Resource$Projects$Locations$Metadatajobs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, + params: Params$Resource$Projects$Locations$Metadatajobs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Metadatajobs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Metadatajobs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List; + {}) as Params$Resource$Projects$Locations$Metadatajobs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List; + params = {} as Params$Resource$Projects$Locations$Metadatajobs$List; options = {}; } @@ -20136,7 +21436,7 @@ export namespace dataplex_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/partitions').replace( + url: (rootUrl + '/v1/{+parent}/metadataJobs').replace( /([^:]\/)\/+/g, '$1' ), @@ -20151,68 +21451,73 @@ export namespace dataplex_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Create + export interface Params$Resource$Projects$Locations$Metadatajobs$Cancel extends StandardParameters { /** - * Required. The resource name of the parent zone: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. - */ - parent?: string; - /** - * Optional. Only validate the request, but do not perform mutations. The default is false. + * Required. The resource name of the job, in the format projects/{project_id_or_number\}/locations/{location_id\}/metadataJobs/{metadata_job_id\} */ - validateOnly?: boolean; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDataplexV1Partition; + requestBody?: Schema$GoogleCloudDataplexV1CancelMetadataJobRequest; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Delete + export interface Params$Resource$Projects$Locations$Metadatajobs$Create extends StandardParameters { /** - * Optional. The etag associated with the partition. + * Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-. */ - etag?: string; + metadataJobId?: string; /** - * Required. The resource name of the partition. format: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}/partitions/{partition_value_path\}. The {partition_value_path\} segment consists of an ordered sequence of partition values separated by "/". All values must be provided. + * Required. The resource name of the parent location, in the format projects/{project_id_or_number\}/locations/{location_id\} */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDataplexV1MetadataJob; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$Get + export interface Params$Resource$Projects$Locations$Metadatajobs$Get extends StandardParameters { /** - * Required. The resource name of the partition: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}/partitions/{partition_value_path\}. The {partition_value_path\} segment consists of an ordered sequence of partition values separated by "/". All values must be provided. + * Required. The resource name of the metadata job, in the format projects/{project_id_or_number\}/locations/{location_id\}/metadataJobs/{metadata_job_id\}. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lakes$Zones$Entities$Partitions$List + export interface Params$Resource$Projects$Locations$Metadatajobs$List extends StandardParameters { /** - * Optional. Filter the partitions returned to the caller using a key value pair expression. Supported operators and syntax: logic operators: AND, OR comparison operators: <, \>, \>=, <= ,=, != LIKE operators: The right hand of a LIKE operator supports "." and "*" for wildcard searches, for example "value1 LIKE ".*oo.*" parenthetical grouping: ( )Sample filter expression: `?filter="key1 < value1 OR key2 \> value2"Notes: Keys to the left of operators are case insensitive. Partition results are sorted first by creation time, then by lexicographic order. Up to 20 key value filter pairs are allowed, but due to performance considerations, only the first 10 will be used as a filter. + * Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators. */ filter?: string; /** - * Optional. Maximum number of partitions to return. The service may return fewer than this value. If unspecified, 100 partitions will be returned by default. The maximum page size is 500; larger values will will be truncated to 500. + * Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined. + */ + orderBy?: string; + /** + * Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000. */ pageSize?: number; /** - * Optional. Page token received from a previous ListPartitions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListPartitions must match the call that provided the page token. + * Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token. */ pageToken?: string; /** - * Required. The resource name of the parent entity: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\}. + * Required. The resource name of the parent location, in the format projects/{project_id_or_number\}/locations/{location_id\} */ parent?: string; } diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 689fec9fed..9b7c278038 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v2 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -298,12 +302,16 @@ export namespace dialogflow_v2 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -523,7 +531,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -590,7 +598,7 @@ export namespace dialogflow_v2 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -632,6 +640,10 @@ export namespace dialogflow_v2 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1539,7 +1551,7 @@ export namespace dialogflow_v2 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -1585,7 +1597,7 @@ export namespace dialogflow_v2 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -1602,11 +1614,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -2217,7 +2229,7 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -2284,7 +2296,7 @@ export namespace dialogflow_v2 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -2326,6 +2338,10 @@ export namespace dialogflow_v2 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -3229,7 +3245,7 @@ export namespace dialogflow_v2 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -3275,7 +3291,7 @@ export namespace dialogflow_v2 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -3292,11 +3308,11 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -4327,6 +4343,19 @@ export namespace dialogflow_v2 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -4472,6 +4501,24 @@ export namespace dialogflow_v2 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). */ @@ -5512,6 +5559,10 @@ export namespace dialogflow_v2 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -5624,6 +5675,96 @@ export namespace dialogflow_v2 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. */ @@ -6409,6 +6550,19 @@ export namespace dialogflow_v2 { */ acceptsDtmfInput?: boolean | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -7308,6 +7462,24 @@ export namespace dialogflow_v2 { */ topP?: number | null; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * Instructs the speech recognizer how to process the audio content. */ @@ -8961,10 +9133,26 @@ export namespace dialogflow_v2 { * Configures speech transcription for ConversationProfile. */ export interface Schema$GoogleCloudDialogflowV2SpeechToTextConfig { + /** + * Audio encoding of the audio content to process. + */ + audioEncoding?: string | null; + /** + * If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + */ + enableWordInfo?: boolean | null; + /** + * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + */ + languageCode?: string | null; /** * Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */ model?: string | null; + /** + * Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. + */ + sampleRateHertz?: number | null; /** * The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */ @@ -23596,6 +23784,7 @@ export namespace dialogflow_v2 { conversationModels: Resource$Projects$Locations$Conversationmodels; conversationProfiles: Resource$Projects$Locations$Conversationprofiles; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; @@ -23616,6 +23805,9 @@ export namespace dialogflow_v2 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.generators = new Resource$Projects$Locations$Generators( this.context ); @@ -23914,6 +24106,100 @@ export namespace dialogflow_v2 { } } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists information about the supported locations for this service. * @@ -24130,6 +24416,13 @@ export namespace dialogflow_v2 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -35231,6 +35524,122 @@ export namespace dialogflow_v2 { requestBody?: Schema$GoogleCloudDialogflowV2SuggestConversationSummaryRequest; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Generators { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 2beff5da0d..e189e4b3e3 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v2beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -298,12 +302,16 @@ export namespace dialogflow_v2beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -523,7 +531,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -590,7 +598,7 @@ export namespace dialogflow_v2beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -632,6 +640,10 @@ export namespace dialogflow_v2beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1539,7 +1551,7 @@ export namespace dialogflow_v2beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -1585,7 +1597,7 @@ export namespace dialogflow_v2beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -1602,11 +1614,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -2217,7 +2229,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -2284,7 +2296,7 @@ export namespace dialogflow_v2beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -2326,6 +2338,10 @@ export namespace dialogflow_v2beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -3229,7 +3245,7 @@ export namespace dialogflow_v2beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -3275,7 +3291,7 @@ export namespace dialogflow_v2beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -3292,11 +3308,11 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -4116,7 +4132,7 @@ export namespace dialogflow_v2beta1 { */ export interface Schema$GoogleCloudDialogflowV2beta1AudioInput { /** - * Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. + * Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. */ audio?: string | null; /** @@ -4719,6 +4735,19 @@ export namespace dialogflow_v2beta1 { */ acceptsDtmfInput?: boolean | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -5528,6 +5557,24 @@ export namespace dialogflow_v2beta1 { */ topP?: number | null; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -6872,6 +6919,10 @@ export namespace dialogflow_v2beta1 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -7464,10 +7515,26 @@ export namespace dialogflow_v2beta1 { * Configures speech transcription for ConversationProfile. */ export interface Schema$GoogleCloudDialogflowV2beta1SpeechToTextConfig { + /** + * Audio encoding of the audio content to process. + */ + audioEncoding?: string | null; + /** + * If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + */ + enableWordInfo?: boolean | null; + /** + * The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + */ + languageCode?: string | null; /** * Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */ model?: string | null; + /** + * Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. + */ + sampleRateHertz?: number | null; /** * The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */ @@ -8286,6 +8353,19 @@ export namespace dialogflow_v2beta1 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -8461,6 +8541,24 @@ export namespace dialogflow_v2beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -22861,6 +22959,7 @@ export namespace dialogflow_v2beta1 { answerRecords: Resource$Projects$Locations$Answerrecords; conversationProfiles: Resource$Projects$Locations$Conversationprofiles; conversations: Resource$Projects$Locations$Conversations; + encryptionSpec: Resource$Projects$Locations$Encryptionspec; generators: Resource$Projects$Locations$Generators; knowledgeBases: Resource$Projects$Locations$Knowledgebases; operations: Resource$Projects$Locations$Operations; @@ -22877,6 +22976,9 @@ export namespace dialogflow_v2beta1 { this.conversations = new Resource$Projects$Locations$Conversations( this.context ); + this.encryptionSpec = new Resource$Projects$Locations$Encryptionspec( + this.context + ); this.generators = new Resource$Projects$Locations$Generators( this.context ); @@ -23175,6 +23277,100 @@ export namespace dialogflow_v2beta1 { } } + /** + * Gets location-level encryption key specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params?: Params$Resource$Projects$Locations$Getencryptionspec, + options?: MethodOptions + ): GaxiosPromise; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + params: Params$Resource$Projects$Locations$Getencryptionspec, + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + callback: BodyResponseCallback + ): void; + getEncryptionSpec( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getencryptionspec + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getencryptionspec; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getencryptionspec; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Lists information about the supported locations for this service. * @@ -23391,6 +23587,13 @@ export namespace dialogflow_v2beta1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Getencryptionspec + extends StandardParameters { + /** + * Required. The name of the encryption spec resource to get. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -33182,6 +33385,122 @@ export namespace dialogflow_v2beta1 { requestBody?: Schema$GoogleCloudDialogflowV2beta1SuggestConversationSummaryRequest; } + export class Resource$Projects$Locations$Encryptionspec { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions + ): GaxiosPromise; + initialize( + params?: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options?: MethodOptions + ): GaxiosPromise; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + initialize( + params: Params$Resource$Projects$Locations$Encryptionspec$Initialize, + callback: BodyResponseCallback + ): void; + initialize( + callback: BodyResponseCallback + ): void; + initialize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Encryptionspec$Initialize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Encryptionspec$Initialize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}:initialize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Encryptionspec$Initialize + extends StandardParameters { + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + export class Resource$Projects$Locations$Generators { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index 16ea0dfd70..aa68995d28 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v3 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -424,7 +428,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3BatchDeleteTestCasesRequest { /** - * Required. Format of test case names: `projects//locations/ /agents//testCases/`. + * Required. Format of test case names: `projects//locations//agents//testCases/`. */ names?: string[] | null; } @@ -509,12 +513,16 @@ export namespace dialogflow_v3 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -734,7 +742,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -801,7 +809,7 @@ export namespace dialogflow_v3 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -843,6 +851,10 @@ export namespace dialogflow_v3 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1750,7 +1762,7 @@ export namespace dialogflow_v3 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -1796,7 +1808,7 @@ export namespace dialogflow_v3 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -1813,11 +1825,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -2573,6 +2585,10 @@ export namespace dialogflow_v3 { * Diagnostic info related to the answer generation model call. */ export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -2625,6 +2641,10 @@ export namespace dialogflow_v3 { * Diagnostic info related to the rewriter model call. */ export interface Schema$GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -2691,7 +2711,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowRequest { /** - * Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`. + * Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`. */ flowVersion?: string | null; } @@ -2700,7 +2720,7 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -2914,7 +2934,7 @@ export namespace dialogflow_v3 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -2956,6 +2976,10 @@ export namespace dialogflow_v3 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -3003,7 +3027,7 @@ export namespace dialogflow_v3 { */ lastUpdateTime?: string | null; /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string | null; /** @@ -3356,6 +3380,10 @@ export namespace dialogflow_v3 { * Optional. Knowledge connector configuration. */ knowledgeConnectorSettings?: Schema$GoogleCloudDialogflowCxV3KnowledgeConnectorSettings; + /** + * Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected. + */ + locked?: boolean | null; /** * Optional. Multi-lingual agent settings for this flow. */ @@ -3369,7 +3397,7 @@ export namespace dialogflow_v3 { */ nluSettings?: Schema$GoogleCloudDialogflowCxV3NluSettings; /** - * A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. + * A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format: `projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. */ transitionRouteGroups?: string[] | null; /** @@ -5321,7 +5349,7 @@ export namespace dialogflow_v3 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -5367,7 +5395,7 @@ export namespace dialogflow_v3 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -5384,11 +5412,11 @@ export namespace dialogflow_v3 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -6264,6 +6292,19 @@ export namespace dialogflow_v3 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -6409,6 +6450,24 @@ export namespace dialogflow_v3 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). */ @@ -7449,6 +7508,10 @@ export namespace dialogflow_v3 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -7561,6 +7624,96 @@ export namespace dialogflow_v3 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. */ @@ -7995,6 +8148,19 @@ export namespace dialogflow_v3 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -8170,6 +8336,24 @@ export namespace dialogflow_v3 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -12814,7 +12998,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Environments$Deployflow extends StandardParameters { /** - * Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`. + * Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`. */ environment?: string; @@ -13005,7 +13189,7 @@ export namespace dialogflow_v3 { */ pageToken?: string; /** - * Required. The environment to list results for. Format: `projects//locations//agents// environments/`. + * Required. The environment to list results for. Format: `projects//locations//agents//environments/`. */ parent?: string; } @@ -13949,7 +14133,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Environments$Experiments$Patch extends StandardParameters { /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string; /** @@ -17871,7 +18055,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Flows$Versions$Compareversions extends StandardParameters { /** - * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`. + * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`. */ baseVersion?: string; @@ -21362,7 +21546,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchrun extends StandardParameters { /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: `projects//locations//agents/`. */ parent?: string; @@ -21447,7 +21631,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Patch extends StandardParameters { /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string; /** @@ -21463,7 +21647,7 @@ export namespace dialogflow_v3 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Run extends StandardParameters { /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: `projects//locations//agents//testCases/`. */ name?: string; @@ -21695,7 +21879,7 @@ export namespace dialogflow_v3 { */ pageToken?: string; /** - * Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. + * Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. */ parent?: string; } diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 95df81fe7a..d3f96c9d38 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -174,12 +174,16 @@ export namespace dialogflow_v3beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -323,12 +327,16 @@ export namespace dialogflow_v3beta1 { * Define behaviors on logging. */ export interface Schema$GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings { + /** + * Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. + */ + enableConsentBasedRedaction?: boolean | null; /** * Enables DF Interaction logging. */ enableInteractionLogging?: boolean | null; /** - * Enables StackDriver logging. + * Enables Google Cloud Logging. */ enableStackdriverLogging?: boolean | null; } @@ -586,7 +594,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1BatchDeleteTestCasesRequest { /** - * Required. Format of test case names: `projects//locations/ /agents//testCases/`. + * Required. Format of test case names: `projects//locations//agents//testCases/`. */ names?: string[] | null; } @@ -1115,6 +1123,10 @@ export namespace dialogflow_v3beta1 { * Diagnostic info related to the answer generation model call. */ export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -1167,6 +1179,10 @@ export namespace dialogflow_v3beta1 { * Diagnostic info related to the rewriter model call. */ export interface Schema$GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals { + /** + * Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. + */ + model?: string | null; /** * Output of the generative model. */ @@ -1233,7 +1249,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowRequest { /** - * Required. The flow version to deploy. Format: `projects//locations//agents// flows//versions/`. + * Required. The flow version to deploy. Format: `projects//locations//agents//flows//versions/`. */ flowVersion?: string | null; } @@ -1242,7 +1258,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1DeployFlowResponse { /** - * The name of the flow version deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -1460,7 +1476,7 @@ export namespace dialogflow_v3beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -1502,6 +1518,10 @@ export namespace dialogflow_v3beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -1598,7 +1618,7 @@ export namespace dialogflow_v3beta1 { */ lastUpdateTime?: string | null; /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string | null; /** @@ -1972,6 +1992,10 @@ export namespace dialogflow_v3beta1 { * Optional. Knowledge connector configuration. */ knowledgeConnectorSettings?: Schema$GoogleCloudDialogflowCxV3beta1KnowledgeConnectorSettings; + /** + * Indicates whether the flow is locked for changes. If the flow is locked, modifications to the flow will be rejected. + */ + locked?: boolean | null; /** * Optional. Multi-lingual agent settings for this flow. */ @@ -2007,7 +2031,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1FlowInvocation { /** - * Required. The unique identifier of the flow. Format: `projects//locations//agents/`. + * Required. The unique identifier of the flow. Format: `projects//locations//agents//flows/`. */ flow?: string | null; /** @@ -2578,6 +2602,19 @@ export namespace dialogflow_v3beta1 { */ content?: string | null; } + /** + * A type schema object that's specified inline. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineSchema { + /** + * Schema of the elements if this is an ARRAY type. + */ + items?: Schema$GoogleCloudDialogflowCxV3beta1TypeSchema; + /** + * Data type of the schema. + */ + type?: string | null; + } /** * Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow. */ @@ -3345,9 +3382,13 @@ export namespace dialogflow_v3beta1 { */ name?: string | null; /** - * Required. Type of parameter. + * Type of parameter. */ type?: string | null; + /** + * Optional. Type schema of parameter. + */ + typeSchema?: Schema$GoogleCloudDialogflowCxV3beta1TypeSchema; } /** * Text input which can be used for prompt or banned phrases. @@ -4261,7 +4302,7 @@ export namespace dialogflow_v3beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3beta1TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -4307,7 +4348,7 @@ export namespace dialogflow_v3beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -4324,11 +4365,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3beta1TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -4578,6 +4619,10 @@ export namespace dialogflow_v3beta1 { * Optional. Authentication information required by the API. */ authentication?: Schema$GoogleCloudDialogflowCxV3beta1ToolAuthentication; + /** + * Optional. Service Directory configuration. + */ + serviceDirectoryConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig; /** * Required. The OpenAPI schema specified as a text. */ @@ -4587,6 +4632,15 @@ export namespace dialogflow_v3beta1 { */ tlsConfig?: Schema$GoogleCloudDialogflowCxV3beta1ToolTLSConfig; } + /** + * Configuration for tools using Service Directory. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig { + /** + * Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `LocationID` of the service directory must be the same as the location of the agent. + */ + service?: string | null; + } /** * The TLS configuration. */ @@ -4827,6 +4881,32 @@ export namespace dialogflow_v3beta1 { */ webhookStatuses?: string[] | null; } + /** + * Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1TypeSchema { + /** + * Set if this is an inline schema definition. + */ + inlineSchema?: Schema$GoogleCloudDialogflowCxV3beta1InlineSchema; + /** + * Set if this is a schema reference. + */ + schemaReference?: Schema$GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference; + } + /** + * A reference to the schema of an existing tool. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1TypeSchemaSchemaReference { + /** + * The name of the schema. + */ + schema?: string | null; + /** + * The tool that contains this schema definition. Format: `projects//locations//agents//tools/`. + */ + tool?: string | null; + } /** * Metadata for UpdateDocument operation. */ @@ -5399,7 +5479,7 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3DeployFlowResponse { /** - * The name of the flow version Deployment. Format: `projects//locations//agents// environments//deployments/`. + * The name of the flow version Deployment. Format: `projects//locations//agents//environments//deployments/`. */ deployment?: string | null; /** @@ -5466,7 +5546,7 @@ export namespace dialogflow_v3beta1 { */ enablePredeploymentRun?: boolean | null; /** - * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations/ /agents//testCases/` + * A list of test case names to run. They should be under the same agent. Format of each test case name: `projects//locations//agents//testCases/` */ testCases?: string[] | null; } @@ -5508,6 +5588,10 @@ export namespace dialogflow_v3beta1 { * The target page to transition to. Format: `projects//locations//agents//flows//pages/`. */ targetPage?: string | null; + /** + * The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. + */ + targetPlaybook?: string | null; /** * The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. */ @@ -6411,7 +6495,7 @@ export namespace dialogflow_v3beta1 { */ lastTestResult?: Schema$GoogleCloudDialogflowCxV3TestCaseResult; /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string | null; /** @@ -6457,7 +6541,7 @@ export namespace dialogflow_v3beta1 { */ environment?: string | null; /** - * The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. + * The resource name for the test case result. Format: `projects//locations//agents//testCases//results/`. */ name?: string | null; /** @@ -6474,11 +6558,11 @@ export namespace dialogflow_v3beta1 { */ export interface Schema$GoogleCloudDialogflowCxV3TestConfig { /** - * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ flow?: string | null; /** - * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + * The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */ page?: string | null; /** @@ -7100,6 +7184,19 @@ export namespace dialogflow_v3beta1 { */ queryResult?: Schema$GoogleCloudDialogflowV2beta1QueryResult; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2beta1EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -7245,6 +7342,24 @@ export namespace dialogflow_v3beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2beta1EncryptionSpec; + } /** * An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview). */ @@ -8285,6 +8400,10 @@ export namespace dialogflow_v3beta1 { * Output only. The role of the participant. */ participantRole?: string | null; + /** + * Optional. Automated agent responses. + */ + responseMessages?: Schema$GoogleCloudDialogflowV2beta1ResponseMessage[]; /** * Optional. The time when the message was sent. */ @@ -8397,6 +8516,96 @@ export namespace dialogflow_v3beta1 { */ webhookSource?: string | null; } + /** + * Response messages from an automated agent. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessage { + /** + * A signal that indicates the interaction with the Dialogflow agent has ended. + */ + endInteraction?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction; + /** + * Hands off conversation to a live agent. + */ + liveAgentHandoff?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff; + /** + * An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + */ + mixedAudio?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio; + /** + * Returns a response containing a custom, platform-specific payload. + */ + payload?: {[key: string]: any} | null; + /** + * A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + */ + telephonyTransferCall?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall; + /** + * Returns a text response. + */ + text?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageText; + } + /** + * Indicates that interaction with the Dialogflow agent has ended. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction {} + /** + * Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff { + /** + * Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + */ + metadata?: {[key: string]: any} | null; + } + /** + * Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio { + /** + * Segments this audio response is composed of. + */ + segments?: Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment[]; + } + /** + * Represents one segment of audio. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment { + /** + * Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + */ + allowPlaybackInterruption?: boolean | null; + /** + * Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + */ + audio?: string | null; + /** + * Client-specific URI that points to an audio clip accessible to the client. + */ + uri?: string | null; + } + /** + * Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall { + /** + * Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + */ + phoneNumber?: string | null; + /** + * Transfer the call to a SIP endpoint. + */ + sipUri?: string | null; + } + /** + * The text response message. + */ + export interface Schema$GoogleCloudDialogflowV2beta1ResponseMessageText { + /** + * A collection of text responses. + */ + text?: string[] | null; + } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. */ @@ -8831,6 +9040,19 @@ export namespace dialogflow_v3beta1 { */ createTime?: string | null; } + /** + * A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). + */ + export interface Schema$GoogleCloudDialogflowV2EncryptionSpec { + /** + * Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project\}/locations/{location\}/keyRings/{keyRing\}/cryptoKeys/{key\}` + */ + kmsKey?: string | null; + /** + * Immutable. The resource name of the encryption key specification resource. Format: projects/{project\}/locations/{location\}/encryptionSpec + */ + name?: string | null; + } /** * Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). */ @@ -9006,6 +9228,24 @@ export namespace dialogflow_v3beta1 { */ warnings?: Schema$GoogleRpcStatus[]; } + /** + * Metadata for initializing a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata { + /** + * Output only. The original request for initialization. + */ + request?: Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest; + } + /** + * The request to initialize a location-level encryption specification. + */ + export interface Schema$GoogleCloudDialogflowV2InitializeEncryptionSpecRequest { + /** + * Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced. + */ + encryptionSpec?: Schema$GoogleCloudDialogflowV2EncryptionSpec; + } /** * InputDataset used to create model or do evaluation. NextID:5 */ @@ -13984,7 +14224,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Environments$Deployflow extends StandardParameters { /** - * Required. The environment to deploy the flow to. Format: `projects//locations//agents// environments/`. + * Required. The environment to deploy the flow to. Format: `projects//locations//agents//environments/`. */ environment?: string; @@ -14175,7 +14415,7 @@ export namespace dialogflow_v3beta1 { */ pageToken?: string; /** - * Required. The environment to list results for. Format: `projects//locations//agents// environments/`. + * Required. The environment to list results for. Format: `projects//locations//agents//environments/`. */ parent?: string; } @@ -15125,7 +15365,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Environments$Experiments$Patch extends StandardParameters { /** - * The name of the experiment. Format: projects//locations//agents//environments//experiments/.. + * The name of the experiment. Format: projects//locations//agents//environments//experiments/. */ name?: string; /** @@ -19056,7 +19296,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Flows$Versions$Compareversions extends StandardParameters { /** - * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents/ /flows//versions/`. + * Required. Name of the base flow version to compare with the target version. Use version ID `0` to indicate the draft version of the specified flow. Format: `projects//locations//agents//flows//versions/`. */ baseVersion?: string; @@ -24068,7 +24308,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Batchrun extends StandardParameters { /** - * Required. Agent name. Format: `projects//locations//agents/ `. + * Required. Agent name. Format: `projects//locations//agents/`. */ parent?: string; @@ -24153,7 +24393,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Patch extends StandardParameters { /** - * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. + * The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents//testCases/`. */ name?: string; /** @@ -24169,7 +24409,7 @@ export namespace dialogflow_v3beta1 { export interface Params$Resource$Projects$Locations$Agents$Testcases$Run extends StandardParameters { /** - * Required. Format of test case name to run: `projects//locations/ /agents//testCases/`. + * Required. Format of test case name to run: `projects//locations//agents//testCases/`. */ name?: string; @@ -24401,7 +24641,7 @@ export namespace dialogflow_v3beta1 { */ pageToken?: string; /** - * Required. The test case to list results for. Format: `projects//locations//agents// testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. + * Required. The test case to list results for. Format: `projects//locations//agents//testCases/`. Specify a `-` as a wildcard for TestCase ID to list results across multiple test cases. */ parent?: string; } diff --git a/src/apis/discoveryengine/v1.ts b/src/apis/discoveryengine/v1.ts index c9192db6cb..55f5041c0f 100644 --- a/src/apis/discoveryengine/v1.ts +++ b/src/apis/discoveryengine/v1.ts @@ -260,7 +260,7 @@ export namespace discoveryengine_v1 { */ locationId?: string | null; /** - * The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -386,6 +386,10 @@ export namespace discoveryengine_v1 { * Chunk information. */ chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo; + /** + * Structured document information. + */ + structuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo; /** * Unstructured document information. */ @@ -408,7 +412,7 @@ export namespace discoveryengine_v1 { */ documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata; /** - * Relevance score. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ relevanceScore?: number | null; } @@ -437,6 +441,19 @@ export namespace discoveryengine_v1 { */ uri?: string | null; } + /** + * Structured search information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo { + /** + * Document resource name. + */ + document?: string | null; + /** + * Structured search data. + */ + structData?: {[key: string]: any} | null; + } /** * Unstructured document information. */ @@ -474,6 +491,10 @@ export namespace discoveryengine_v1 { * Page identifier. */ pageIdentifier?: string | null; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; } /** * Step information. @@ -531,6 +552,10 @@ export namespace discoveryengine_v1 { * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + */ + structData?: {[key: string]: any} | null; /** * Title. */ @@ -553,7 +578,7 @@ export namespace discoveryengine_v1 { */ content?: string | null; /** - * Relevance score. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ relevanceScore?: number | null; } @@ -645,7 +670,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaControl { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ associatedServingConfigIds?: string[] | null; /** @@ -759,6 +784,10 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -785,6 +814,15 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Defines custom fine tuning spec. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec { + /** + * Whether or not to enable and include custom fine tuned search adaptor model. + */ + enableSearchAdaptor?: boolean | null; + } /** * Metadata that describes a custom tuned model. */ @@ -797,6 +835,10 @@ export namespace discoveryengine_v1 { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -866,6 +908,10 @@ export namespace discoveryengine_v1 { * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig; } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -953,7 +999,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -1245,6 +1291,65 @@ export namespace discoveryengine_v1 { */ documentCount?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec; + /** + * Identifier. The full resource name of the Evaluation, in the format of `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec; + /** + * Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. */ @@ -1294,6 +1399,15 @@ export namespace discoveryengine_v1 { */ searchableOption?: string | null; } + /** + * Response message for SiteSearchEngineService.GetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse { + /** + * Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + } /** * Identity Provider Config. */ @@ -1397,6 +1511,44 @@ export namespace discoveryengine_v1 { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -1469,6 +1621,27 @@ export namespace discoveryengine_v1 { */ unjoinedEventsCount?: string | null; } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaInterval { + /** + * Exclusive upper bound. + */ + exclusiveMaximum?: number | null; + /** + * Exclusive lower bound. + */ + exclusiveMinimum?: number | null; + /** + * Inclusive upper bound. + */ + maximum?: number | null; + /** + * Inclusive lower bound. + */ + minimum?: number | null; + } /** * Language info for DataStore. */ @@ -1673,6 +1846,52 @@ export namespace discoveryengine_v1 { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics { + /** + * Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines a user inputed query. */ @@ -1780,1163 +1999,2398 @@ export namespace discoveryengine_v1 { structSchema?: {[key: string]: any} | null; } /** - * External session proto definition. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest { /** - * Output only. The time the session finished. + * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ - endTime?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */ - name?: string | null; + branch?: string | null; /** - * Output only. The time the session started. + * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ - startTime?: string | null; + canonicalFilter?: string | null; /** - * The state of the session. + * A specification for configuring the behavior of content search. */ - state?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; /** - * Turns. + * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */ - turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; + customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * A unique identifier for tracking users. + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */ - userPseudoId?: string | null; - } - /** - * Represents a turn, including a query from the user and a answer from service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** - * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */ - answer?: string | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec; /** - * The user query. + * Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[]; /** - * Site verification state indicating the ownership and validity. + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ - siteVerificationState?: string | null; + filter?: string | null; /** - * Latest site verification time. + * Raw image query. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { + imageQuery?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery; /** - * 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. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */ - exactMatch?: boolean | null; + languageCode?: string | null; /** - * Output only. Failure reason. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - generatedUriPattern?: string | null; + offset?: number | null; /** - * Output only. Indexing status. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - indexingStatus?: string | null; + orderBy?: string | null; /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - name?: string | null; + pageSize?: number | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - providedUriPattern?: string | null; + pageToken?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ - rootDomainUri?: string | null; + params?: {[key: string]: any} | null; /** - * Output only. Site ownership and validity verification status. + * Raw search query. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; + query?: string | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - type?: string | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * Output only. The target site's last updated time. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { + rankingExpression?: string | null; /** - * Failed due to insufficient quota. + * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { + regionCode?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */ - totalRequiredQuota?: string | null; - } - /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { + relevanceThreshold?: string | null; /** - * Operation create time. + * Whether to turn on safe search. This is only supported for website search. */ - createTime?: string | null; + safeSearch?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - updateTime?: string | null; - } - /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; /** - * Echoes the destination for the complete errors in the request if set. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + servingConfig?: string | null; /** - * A sample of errors encountered while processing the data. + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - errorSamples?: Schema$GoogleRpcStatus[]; + session?: string | null; /** - * The metrics of the trained model. + * Session specification. Can be used only when `session` is set. */ - metrics?: {[key: string]: number} | null; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; /** - * Fully qualified name of the CustomTuningModel. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - modelName?: string | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - modelStatus?: string | null; - } - /** - * Metadata associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { + userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - engine?: string | null; + userLabels?: {[key: string]: string} | null; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string | null; } /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ - updateTime?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec { /** - * Operation create time. + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ - createTime?: string | null; + boost?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Complex specification for custom ranking based on customer defined attribute value. */ - updateTime?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + /** + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + */ + condition?: string | null; } /** - * Defines an answer. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1Answer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */ - answerSkippedReasons?: string[] | null; + attributeType?: string | null; /** - * The textual answer. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - answerText?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * Citations. + * The name of the field whose value will be used to determine the boost amount. */ - citations?: Schema$GoogleCloudDiscoveryengineV1AnswerCitation[]; + fieldName?: string | null; /** - * Output only. Answer completed timestamp. + * The interpolation type to be applied to connect the control points listed below. */ - completeTime?: string | null; + interpolationType?: string | null; + } + /** + * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Output only. Answer creation timestamp. + * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */ - createTime?: string | null; + attributeValue?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - name?: string | null; + boostAmount?: number | null; + } + /** + * A specification for configuring the behavior of content search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec { /** - * Query understanding information. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec; /** - * References. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - references?: Schema$GoogleCloudDiscoveryengineV1AnswerReference[]; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Suggested related questions. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - relatedQuestions?: string[] | null; + searchResultMode?: string | null; /** - * The state of the answer generation. + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - state?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec; /** - * Answer generation steps. + * If `summarySpec` is not specified, summaries are not included in the search response. */ - steps?: Schema$GoogleCloudDiscoveryengineV1AnswerStep[]; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec; } /** - * Citation info for a segment. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitation { - /** - * End of the attributed segment, exclusive. - */ - endIndex?: string | null; - /** - * Citation sources for the attributed segment. - */ - sources?: Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource[]; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec { /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */ - startIndex?: string | null; - } - /** - * Citation source. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource { + numNextChunks?: number | null; /** - * ID of the citation source. + * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */ - referenceId?: string | null; + numPreviousChunks?: number | null; } /** - * Request message for ConversationalSearchService.AnswerQuery method. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest { - /** - * Answer generation specification. - */ - answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec; - /** - * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. - */ - asynchronousMode?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * Required. Current user query. + * The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */ - query?: Schema$GoogleCloudDiscoveryengineV1Query; + maxExtractiveAnswerCount?: number | null; /** - * Query understanding specification. + * The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */ - queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec; + maxExtractiveSegmentCount?: number | null; /** - * Related questions specification. + * Return at most `num_next_segments` segments after each selected segments. */ - relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec; + numNextSegments?: number | null; /** - * Model specification. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - safetySpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec; + numPreviousSegments?: number | null; /** - * Search specification. + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */ - searchSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec; + returnExtractiveSegmentScore?: boolean | null; + } + /** + * A specification for configuring snippets in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec { /** - * The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + * [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. */ - session?: string | null; + maxSnippetCount?: number | null; /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - userLabels?: {[key: string]: string} | null; + referenceOnly?: boolean | null; /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */ - userPseudoId?: string | null; + returnSnippet?: boolean | null; } /** - * Answer generation specification. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec { - /** - * Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. - */ - answerLanguageCode?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec { /** - * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; /** - * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ ignoreLowRelevantContent?: boolean | null; /** - * Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. + * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ - ignoreNonAnswerSeekingQuery?: boolean | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Specifies whether to include citation metadata in the answer. The default value is `false`. + * Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */ includeCitations?: boolean | null; /** - * Answer generation model specification. - */ - modelSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec; - /** - * Answer generation prompt specification. + * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */ - promptSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec; - } - /** - * Answer Generation Model specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec { + languageCode?: string | null; /** - * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - modelVersion?: string | null; - } - /** - * Answer generation prompt specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec { + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * Customized preamble. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - preamble?: string | null; - } - /** - * Query understanding specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec { + modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * Query classification specification. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; + summaryResultCount?: number | null; /** - * Query rephraser specification. + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */ - queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; + useSemanticChunks?: boolean | null; } /** - * Query classification specification. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Enabled query classification types. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - types?: string[] | null; + preamble?: string | null; } /** - * Query rephraser specification. + * Specification of the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * Disable query rephraser. + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ - disable?: boolean | null; + version?: string | null; } /** - * Related questions specification. + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { /** - * Enable related questions feature if true. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - enable?: boolean | null; + dataStore?: string | null; } /** - * Safety specification. + * The specification that uses customized query embedding vector to do semantic document retrieval. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec { /** - * Enable the safety filtering on the answer response. It is false by default. + * The embedding vector used for retrieval. Limit to 1. */ - enable?: boolean | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Search specification. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Search parameters. + * Embedding field path in schema. */ - searchParams?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams; + fieldPath?: string | null; /** - * Search result list. + * Query embedding vector. */ - searchResultList?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList; + vector?: number[] | null; } /** - * Search parameters. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec { /** - * Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpec; + enableDynamicPosition?: boolean | null; /** - * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. + * List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]; + excludedFilterKeys?: string[] | null; /** - * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * Required. The facet key specification. */ - filter?: string | null; + facetKey?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey; /** - * Number of search results to return. The default value is 10. + * Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - maxReturnResults?: number | null; + limit?: number | null; + } + /** + * Specifies how a facet is computed. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey { /** - * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - orderBy?: string | null; + caseInsensitive?: boolean | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + * Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. */ - searchResultMode?: string | null; - } - /** - * Search result list. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList { + contains?: string[] | null; /** - * Search results. + * Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult[]; - } - /** - * Search result. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult { + intervals?: Schema$GoogleCloudDiscoveryengineV1alphaInterval[]; /** - * Chunk information. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; + key?: string | null; /** - * Unstructured document information. + * The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; - } - /** - * Chunk information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { + orderBy?: string | null; /** - * Chunk resource name. + * Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. */ - chunk?: string | null; + prefixes?: string[] | null; /** - * Chunk textual content. + * Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. */ - content?: string | null; + restrictedValues?: string[] | null; } /** - * Unstructured document information. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { - /** - * Document resource name. - */ - document?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery { /** - * List of document contexts. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - documentContexts?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; + imageBytes?: string | null; + } + /** + * Specification to enable natural language understanding capabilities for search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * List of extractive answers. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; + filterExtractionCondition?: string | null; /** - * List of extractive segments. + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */ - extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; + geoSearchQueryDetectionFieldNames?: string[] | null; + } + /** + * Specification to determine under which conditions query expansion should occur. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec { /** - * Title. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - title?: string | null; + condition?: string | null; /** - * URI for the document. + * Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */ - uri?: string | null; + pinUnexpandedResults?: boolean | null; } /** - * Document context. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { - /** - * Document content. - */ - content?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec { /** - * Page identifier. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - pageIdentifier?: string | null; + condition?: string | null; } /** - * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec { /** - * Extractive answer content. + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */ - content?: string | null; + queryId?: string | null; /** - * Page identifier. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */ - pageIdentifier?: string | null; + searchResultPersistenceCount?: number | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * The specification for query spell correction. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { - /** - * Extractive segment content. - */ - content?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec { /** - * Page identifier. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - pageIdentifier?: string | null; + mode?: string | null; } /** - * Response message for ConversationalSearchService.AnswerQuery method. + * External session proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { /** - * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + * Output only. The time the session finished. */ - answer?: Schema$GoogleCloudDiscoveryengineV1Answer; + endTime?: string | null; /** - * A global unique ID used for logging. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - answerQueryToken?: string | null; + name?: string | null; /** - * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. + * Output only. The time the session started. */ - session?: Schema$GoogleCloudDiscoveryengineV1Session; - } - /** - * Query understanding information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo { + startTime?: string | null; /** - * Query classification information. + * The state of the session. */ - queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo[]; - } - /** - * Query classification information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo { + state?: string | null; /** - * Classification output. + * Turns. */ - positive?: boolean | null; + turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; /** - * Query classification type. + * A unique identifier for tracking users. */ - type?: string | null; + userPseudoId?: string | null; } /** - * Reference. + * Represents a turn, including a query from the user and a answer from service. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReference { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { /** - * Chunk information. + * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo; + answer?: string | null; /** - * Unstructured document information. + * The user query. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo; + query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; } /** - * Chunk information. + * Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata { /** - * Chunk resource name. + * Operation create time. */ - chunk?: string | null; + createTime?: string | null; /** - * Chunk textual content. + * Operation last update time. If the operation is done, this is also the finish time. */ - content?: string | null; + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.SetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {} + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { /** - * Document metadata. + * Site verification state indicating the ownership and validity. */ - documentMetadata?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata; + siteVerificationState?: string | null; /** - * Relevance score. + * Latest site verification time. */ - relevanceScore?: number | null; + verifyTime?: string | null; } /** - * Document metadata. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { /** - * Document resource name. + * 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. */ - document?: string | null; + exactMatch?: boolean | null; /** - * Page identifier. + * Output only. Failure reason. */ - pageIdentifier?: string | null; + failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Output only. This is system-generated based on the provided_uri_pattern. */ - structData?: {[key: string]: any} | null; + generatedUriPattern?: string | null; /** - * Title. + * Output only. Indexing status. */ - title?: string | null; + indexingStatus?: string | null; /** - * URI for the document. + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. */ - uri?: string | null; - } - /** - * Unstructured document information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo { + name?: string | null; /** - * List of cited chunk contents derived from document content. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - chunkContents?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[]; + providedUriPattern?: string | null; /** - * Document resource name. + * Output only. Root domain of the provided_uri_pattern. */ - document?: string | null; + rootDomainUri?: string | null; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Output only. Site ownership and validity verification status. */ - structData?: {[key: string]: any} | null; + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; /** - * Title. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - title?: string | null; + type?: string | null; /** - * URI for the document. + * Output only. The target site's last updated time. */ - uri?: string | null; + updateTime?: string | null; } /** - * Chunk content. + * Site search indexing failure reasons. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent { - /** - * Chunk textual content. - */ - content?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { /** - * Page identifier. + * Failed due to insufficient quota. */ - pageIdentifier?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; } /** - * Step information. + * Failed due to insufficient quota. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStep { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { /** - * Actions. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - actions?: Schema$GoogleCloudDiscoveryengineV1AnswerStepAction[]; - /** - * The description of the step. + totalRequiredQuota?: string | null; + } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { + /** + * Operation create time. */ - description?: string | null; + createTime?: string | null; /** - * The state of the step. + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; + } + /** + * Metadata associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { + /** + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + engine?: string | null; + } + /** + * Response associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Information of an end user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { + /** + * 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 | null; + /** + * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userId?: string | null; + } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } + /** + * Defines an answer. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Answer { + /** + * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + */ + answerSkippedReasons?: string[] | null; + /** + * The textual answer. + */ + answerText?: string | null; + /** + * Citations. + */ + citations?: Schema$GoogleCloudDiscoveryengineV1AnswerCitation[]; + /** + * Output only. Answer completed timestamp. + */ + completeTime?: string | null; + /** + * Output only. Answer creation timestamp. + */ + createTime?: string | null; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` + */ + name?: string | null; + /** + * Query understanding information. + */ + queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo; + /** + * References. + */ + references?: Schema$GoogleCloudDiscoveryengineV1AnswerReference[]; + /** + * Suggested related questions. + */ + relatedQuestions?: string[] | null; + /** + * The state of the answer generation. */ state?: string | null; /** - * The thought of the step. + * Answer generation steps. */ - thought?: string | null; + steps?: Schema$GoogleCloudDiscoveryengineV1AnswerStep[]; } /** - * Action. + * Citation info for a segment. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepAction { + export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitation { /** - * Observation. + * End of the attributed segment, exclusive. + */ + endIndex?: string | null; + /** + * Citation sources for the attributed segment. + */ + sources?: Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource[]; + /** + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + */ + startIndex?: string | null; + } + /** + * Citation source. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerCitationSource { + /** + * ID of the citation source. + */ + referenceId?: string | null; + } + /** + * Request message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequest { + /** + * Answer generation specification. + */ + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec; + /** + * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + */ + asynchronousMode?: boolean | null; + /** + * Required. Current user query. + */ + query?: Schema$GoogleCloudDiscoveryengineV1Query; + /** + * Query understanding specification. + */ + queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec; + /** + * Related questions specification. + */ + relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec; + /** + * Model specification. + */ + safetySpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec; + /** + * Search specification. + */ + searchSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec; + /** + * The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + */ + session?: string | null; + /** + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + */ + userLabels?: {[key: string]: string} | null; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string | null; + } + /** + * Answer generation specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec { + /** + * Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. + */ + answerLanguageCode?: string | null; + /** + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. + */ + ignoreAdversarialQuery?: boolean | null; + /** + * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. + */ + ignoreLowRelevantContent?: boolean | null; + /** + * Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. + */ + ignoreNonAnswerSeekingQuery?: boolean | null; + /** + * Specifies whether to include citation metadata in the answer. The default value is `false`. + */ + includeCitations?: boolean | null; + /** + * Answer generation model specification. + */ + modelSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec; + /** + * Answer generation prompt specification. + */ + promptSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec; + } + /** + * Answer Generation Model specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec { + /** + * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + */ + modelVersion?: string | null; + } + /** + * Answer generation prompt specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec { + /** + * Customized preamble. + */ + preamble?: string | null; + } + /** + * Query understanding specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec { + /** + * Query classification specification. + */ + queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; + /** + * Query rephraser specification. + */ + queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; + } + /** + * Query classification specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { + /** + * Enabled query classification types. + */ + types?: string[] | null; + } + /** + * Query rephraser specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { + /** + * Disable query rephraser. + */ + disable?: boolean | null; + /** + * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. + */ + maxRephraseSteps?: number | null; + } + /** + * Related questions specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec { + /** + * Enable related questions feature if true. + */ + enable?: boolean | null; + } + /** + * Safety specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec { + /** + * Enable the safety filtering on the answer response. It is false by default. + */ + enable?: boolean | null; + } + /** + * Search specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec { + /** + * Search parameters. + */ + searchParams?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams; + /** + * Search result list. + */ + searchResultList?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams { + /** + * Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + */ + boostSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestBoostSpec; + /** + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. + */ + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[]; + /** + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; + /** + * Number of search results to return. The default value is 10. + */ + maxReturnResults?: number | null; + /** + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + */ + orderBy?: string | null; + /** + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + */ + searchResultMode?: string | null; + } + /** + * Search result list. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList { + /** + * Search results. + */ + searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + } + /** + * Search result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult { + /** + * Chunk information. + */ + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; + /** + * Unstructured document information. + */ + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { + /** + * Chunk resource name. + */ + chunk?: string | null; + /** + * Chunk textual content. + */ + content?: string | null; + } + /** + * Unstructured document information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { + /** + * Document resource name. + */ + document?: string | null; + /** + * List of document contexts. + */ + documentContexts?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; + /** + * List of extractive answers. + */ + extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; + /** + * List of extractive segments. + */ + extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Document context. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { + /** + * Document content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { + /** + * Extractive answer content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { + /** + * Extractive segment content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + } + /** + * Response message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryResponse { + /** + * Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + */ + answer?: Schema$GoogleCloudDiscoveryengineV1Answer; + /** + * A global unique ID used for logging. + */ + answerQueryToken?: string | null; + /** + * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. + */ + session?: Schema$GoogleCloudDiscoveryengineV1Session; + } + /** + * Query understanding information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo { + /** + * Query classification information. + */ + queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo[]; + } + /** + * Query classification information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo { + /** + * Classification output. + */ + positive?: boolean | null; + /** + * Query classification type. + */ + type?: string | null; + } + /** + * Reference. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReference { + /** + * Chunk information. + */ + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo; + /** + * Structured document information. + */ + structuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo; + /** + * Unstructured document information. + */ + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo { + /** + * Chunk resource name. + */ + chunk?: string | null; + /** + * Chunk textual content. + */ + content?: string | null; + /** + * Document metadata. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; + } + /** + * Document metadata. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata { + /** + * Document resource name. + */ + document?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + /** + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + */ + structData?: {[key: string]: any} | null; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Structured search information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo { + /** + * Document resource name. + */ + document?: string | null; + /** + * Structured search data. + */ + structData?: {[key: string]: any} | null; + } + /** + * Unstructured document information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo { + /** + * List of cited chunk contents derived from document content. + */ + chunkContents?: Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[]; + /** + * Document resource name. + */ + document?: string | null; + /** + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + */ + structData?: {[key: string]: any} | null; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Chunk content. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent { + /** + * Chunk textual content. + */ + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; + } + /** + * Step information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStep { + /** + * Actions. + */ + actions?: Schema$GoogleCloudDiscoveryengineV1AnswerStepAction[]; + /** + * The description of the step. + */ + description?: string | null; + /** + * The state of the step. + */ + state?: string | null; + /** + * The thought of the step. + */ + thought?: string | null; + } + /** + * Action. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepAction { + /** + * Observation. + */ + observation?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation; + /** + * Search action. + */ + searchAction?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction; + } + /** + * Observation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation { + /** + * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. + */ + searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult[]; + } + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult { + /** + * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + */ + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo[]; + /** + * Document resource name. + */ + document?: string | null; + /** + * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + */ + snippetInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + */ + structData?: {[key: string]: any} | null; + /** + * Title. + */ + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo { + /** + * Chunk resource name. + */ + chunk?: string | null; + /** + * Chunk textual content. + */ + content?: string | null; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; + } + /** + * Snippet information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo { + /** + * Snippet content. + */ + snippet?: string | null; + /** + * Status of the snippet defined by the search team. + */ + snippetStatus?: string | null; + } + /** + * Search action. + */ + export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction { + /** + * The query to search. + */ + query?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest { + /** + * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. + */ + requests?: Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteRequest[]; + } + /** + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { + /** + * TargetSites created. + */ + targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + } + /** + * Response message for DocumentService.BatchGetDocumentsMetadata method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse { + /** + * The metadata of the Documents. + */ + documentsMetadata?: Schema$GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata[]; + } + /** + * The metadata of a Document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadata { + /** + * The timestamp of the last time the Document was last indexed. + */ + lastRefreshedTime?: string | null; + /** + * The value of the matcher that was used to match the Document. + */ + matcherValue?: Schema$GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; + /** + * The status of the document. + */ + status?: string | null; + } + /** + * The value of the matcher that was used to match the Document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue { + /** + * If match by URI, the URI of the Document. + */ + uri?: string | null; + } + /** + * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {} + /** + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { + /** + * TargetSites created. + */ + targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + } + /** + * Defines circumstances to be checked before allowing a behavior + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { + /** + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + */ + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; + /** + * Search only A list of terms to match the query on. Maximum of 10 query terms. + */ + queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; + } + /** + * Matcher for search request query + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { + /** + * Whether the search query needs to exactly match the query term. + */ + fullMatch?: boolean | null; + /** + * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + */ + value?: string | null; + } + /** + * Used for time-dependent conditions. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { + /** + * End of time range. Range is inclusive. Must be in the future. + */ + endTime?: string | null; + /** + * Start of time range. Range is inclusive. + */ + startTime?: string | null; + } + /** + * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControl { + /** + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. + */ + associatedServingConfigIds?: string[] | null; + /** + * Defines a boost-type control + */ + boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; + /** + * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. + */ + conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; + /** + * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + displayName?: string | null; + /** + * Defines a filter-type control Currently not supported by Recommendation + */ + filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string | null; + /** + * Defines a redirect-type control. + */ + redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; + /** + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + */ + solutionType?: string | null; + /** + * Treats a group of terms as synonyms of one another. + */ + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; + /** + * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. + */ + useCases?: string[] | null; + } + /** + * Adjusts order of products in returned list. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { + /** + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + */ + boost?: number | null; + /** + * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + */ + dataStore?: string | null; + /** + * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + filter?: string | null; + } + /** + * Specified which products may be included in results. Uses same filter as boost. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { + /** + * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + */ + dataStore?: string | null; + /** + * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + filter?: string | null; + } + /** + * Redirects a shopper to the provided URI. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { + /** + * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + redirectUri?: string | null; + } + /** + * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { + /** + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + */ + synonyms?: string[] | null; + } + /** + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {} + /** + * Metadata for Create Schema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata that describes a custom tuned model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { + /** + * Timestamp the Model was created at. + */ + createTime?: string | null; + /** + * The display name of the model. + */ + displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + */ + modelState?: string | null; + /** + * The version of the model. + */ + modelVersion?: string | null; + /** + * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + */ + name?: string | null; + /** + * Timestamp the model training was initiated. + */ + trainingStartTime?: string | null; + } + /** + * DataStore captures global settings and configs at the DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + /** + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + */ + contentConfig?: string | null; + /** + * Output only. Timestamp the DataStore was created at. + */ + createTime?: string | null; + /** + * Output only. The id of the default Schema asscociated to this data store. + */ + defaultSchemaId?: string | null; + /** + * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + displayName?: string | null; + /** + * Configuration for Document understanding and enrichment. + */ + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + /** + * Immutable. The industry vertical that the data store registers. + */ + industryVertical?: string | null; + /** + * Language info for DataStore. + */ + languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; + /** + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. + */ + solutionTypes?: string[] | null; + /** + * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig; + } + /** + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for DeleteSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} + /** + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; + /** + * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + */ + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string | null; + /** + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + */ + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + } | null; + } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + */ + includeAncestorHeadings?: boolean | null; + } + /** + * Related configurations applied to a specific type of document parser. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { + /** + * Configurations applied to digital parser. + */ + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + /** + * Configurations applied to OCR parser. Currently it only applies to PDFs. + */ + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + /** + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + */ + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; + /** + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + */ + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; + /** + * Common config spec that specifies the metadata of the engine. + */ + commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + /** + * Output only. Timestamp the Recommendation Engine was created at. + */ + createTime?: string | null; + /** + * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + */ + dataStoreIds?: string[] | null; + /** + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + */ + displayName?: string | null; + /** + * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + */ + industryVertical?: string | null; + /** + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string | null; + /** + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + */ + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; + /** + * Required. The solutions of the engine. + */ + solutionType?: string | null; + /** + * Output only. Timestamp the Recommendation Engine was last updated. + */ + updateTime?: string | null; + } + /** + * Configurations for a Chat Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { + /** + * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; + /** + * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + */ + dialogflowAgentToLink?: string | null; + } + /** + * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { + /** + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + */ + business?: string | null; + /** + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + */ + defaultLanguageCode?: string | null; + /** + * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + */ + location?: string | null; + /** + * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + */ + timeZone?: string | null; + } + /** + * Additional information of a Chat Engine. Fields in this message are output only. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { + /** + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + */ + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { + /** + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + */ + companyName?: string | null; + } + /** + * Configurations for a Search Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { + /** + * The add-on that this search engine enables. */ - observation?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation; + searchAddOns?: string[] | null; /** - * Search action. + * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */ - searchAction?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction; + searchTier?: string | null; } /** - * Observation. + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservation { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluation { /** - * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. - */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult[]; - } - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult { - /** - * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + * Output only. Timestamp the Evaluation was created at. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo[]; + createTime?: string | null; /** - * Document resource name. + * Output only. Timestamp the Evaluation was completed at. */ - document?: string | null; + endTime?: string | null; /** - * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */ - snippetInfo?: Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[]; + error?: Schema$GoogleRpcStatus; /** - * Title. + * Output only. A sample of errors encountered while processing the request. */ - title?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * URI for the document. + * Required. The specification of the evaluation. */ - uri?: string | null; - } - /** - * Chunk information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo { + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec; /** - * Chunk resource name. + * Identifier. The full resource name of the Evaluation, in the format of `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - chunk?: string | null; + name?: string | null; /** - * Chunk textual content. + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */ - content?: string | null; + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; /** - * Relevance score. + * Output only. The state of the evaluation. */ - relevanceScore?: number | null; + state?: string | null; } /** - * Snippet information. + * Describes the specification of the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec { /** - * Snippet content. + * Required. The specification of the query set. */ - snippet?: string | null; + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec; /** - * Status of the snippet defined by the search team. + * Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id */ - snippetStatus?: string | null; + searchRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; } /** - * Search action. + * Describes the specification of the query set. */ - export interface Schema$GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec { /** - * The query to search. + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - query?: string | null; + sampleQuerySet?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { /** * Operation create time. */ createTime?: string | null; + /** + * Count of CompletionSuggestions that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { /** - * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. + * The desired location of errors incurred during the Import. */ - requests?: Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteRequest[]; - } - /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * TargetSites created. + * A sample of errors encountered while processing the request. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest {} - /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Count of entries that encountered errors while processing. */ - updateTime?: string | null; - } - /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { + failureCount?: string | null; /** - * TargetSites created. + * Count of entries that were processed successfully. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; - } - /** - * Defines circumstances to be checked before allowing a behavior - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { + successCount?: string | null; /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * Total count of entries that were processed. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; + totalCount?: string | null; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * Operation last update time. If the operation is done, this is also the finish time. */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; + updateTime?: string | null; } /** - * Matcher for search request query + * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { /** - * Whether the search query needs to exactly match the query term. + * Echoes the destination for the complete errors in the request if set. */ - fullMatch?: boolean | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + * A sample of errors encountered while processing the request. */ - value?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Used for time-dependent conditions. + * Configuration of destination for Import related errors. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { - /** - * End of time range. Range is inclusive. Must be in the future. - */ - endTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { /** - * Start of time range. Range is inclusive. + * 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. */ - startTime?: string | null; + gcsPrefix?: string | null; } /** - * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControl { - /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. - */ - associatedServingConfigIds?: string[] | null; - /** - * Defines a boost-type control - */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; - /** - * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. - */ - conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; - /** - * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. - */ - displayName?: string | null; - /** - * Defines a filter-type control Currently not supported by Recommendation - */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * ImportSampleQueries operation create time. */ - name?: string | null; + createTime?: string | null; /** - * Defines a redirect-type control. + * Count of SampleQuerys that failed to be imported. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; + failureCount?: string | null; /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * Count of SampleQuerys successfully imported. */ - solutionType?: string | null; + successCount?: string | null; /** - * Treats a group of terms as synonyms of one another. + * Total count of SampleQuerys that were processed. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; + totalCount?: string | null; /** - * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */ - useCases?: string[] | null; + updateTime?: string | null; } /** - * Adjusts order of products in returned list. + * Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { - /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). - */ - boost?: number | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse { /** - * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * The desired location of errors incurred during the Import. */ - dataStore?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * A sample of errors encountered while processing the request. */ - filter?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Specified which products may be included in results. Uses same filter as boost. + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { /** - * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * Operation create time. */ - dataStore?: string | null; + createTime?: string | null; /** - * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * Operation last update time. If the operation is done, this is also the finish time. */ - filter?: string | null; + updateTime?: string | null; } /** - * Redirects a shopper to the provided URI. + * Response message for CompletionService.ImportSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { /** - * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * A sample of errors encountered while processing the request. */ - redirectUri?: string | null; - } - /** - * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * Count of deny list entries that failed to be imported. */ - synonyms?: string[] | null; + failedEntriesCount?: string | null; + /** + * Count of deny list entries successfully imported. + */ + importedEntriesCount?: string | null; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Count of entries that encountered errors while processing. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { + failureCount?: string | null; /** - * Operation create time. + * Count of entries that were processed successfully. */ - createTime?: string | null; + successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Metadata for Create Schema LRO. + * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { /** - * Operation create time. + * Echoes the destination for the complete errors if this field was set in the request. */ - createTime?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A sample of errors encountered while processing the request. */ - updateTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of user events imported with complete existing Documents. + */ + joinedEventsCount?: string | null; + /** + * Count of user events imported, but with Document information not found in the existing Branch. + */ + unjoinedEventsCount?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * A floating point interval. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { /** - * Operation create time. + * Exclusive upper bound. */ - createTime?: string | null; + exclusiveMaximum?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Exclusive lower bound. */ - updateTime?: string | null; - } - /** - * Metadata that describes a custom tuned model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { + exclusiveMinimum?: number | null; /** - * Timestamp the Model was created at. + * Inclusive upper bound. */ - createTime?: string | null; + maximum?: number | null; /** - * The display name of the model. + * Inclusive lower bound. */ - displayName?: string | null; + minimum?: number | null; + } + /** + * Language info for DataStore. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { /** - * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. */ - modelState?: string | null; + language?: string | null; /** - * The version of the model. + * The language code for the DataStore. */ - modelVersion?: string | null; + languageCode?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`. */ - name?: string | null; + normalizedLanguageCode?: string | null; /** - * Timestamp the model training was initiated. + * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. */ - trainingStartTime?: string | null; + region?: string | null; } /** - * DataStore captures global settings and configs at the DataStore level. + * Response message for SearchTuningService.ListCustomModels method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { + export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + * List of custom tuning models. */ - contentConfig?: string | null; + models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; + } + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProject { /** - * Output only. Timestamp the DataStore was created at. + * Output only. The timestamp when this project is created. */ createTime?: string | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ - defaultSchemaId?: string | null; + name?: string | null; /** - * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */ - displayName?: string | null; + provisionCompletionTime?: string | null; /** - * Configuration for Document understanding and enrichment. + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; + } | null; + } + /** + * Metadata about the terms of service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { /** - * Immutable. The industry vertical that the data store registers. + * The last time when the project agreed to the terms of service. */ - industryVertical?: string | null; + acceptTime?: string | null; /** - * Language info for DataStore. + * The last time when the project declined or revoked the agreement to terms of service. */ - languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; + declineTime?: string | null; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */ - name?: string | null; + id?: string | null; /** - * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. + * Whether the project has accepted/rejected the service terms or it is still pending. */ - solutionTypes?: string[] | null; + state?: string | null; /** - * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + * The version string of the terms of service. For acceptable values, see the comments for id above. */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + version?: string | null; } /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata associated with a project provision operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Count of entries that encountered errors while processing. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { + failureCount?: string | null; /** - * Operation create time. + * Count of entries that were ignored as entries were not found. */ - createTime?: string | null; + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Metadata for DeleteSchema LRO. + * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { /** - * Operation create time. + * The total count of documents purged as a result of the operation. */ - createTime?: string | null; + purgeCount?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */ - updateTime?: string | null; + purgeSample?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { /** * Operation create time. */ @@ -2947,553 +4401,555 @@ export namespace discoveryengine_v1 { updateTime?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { /** - * Operation create time. + * A sample of errors encountered while processing the request. */ - createTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Number of suggestion deny list entries purged. */ - updateTime?: string | null; + purgeCount?: string | null; } /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + * Describes the metrics produced by the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics { /** - * Whether chunking mode is enabled. + * Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; + docNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + * Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + docPrecision?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 */ - name?: string | null; + docRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; - } | null; - } - /** - * Configuration for chunking config. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * Configuration for the layout based chunking. + * Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + pageRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; } /** - * Configuration for the layout based chunking. + * Stores the metric values at specific top-k levels. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics { /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * The top-1 value. */ - chunkSize?: number | null; + top1?: number | null; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * The top-10 value. */ - includeAncestorHeadings?: boolean | null; + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; } /** - * Related configurations applied to a specific type of document parser. + * Defines the structure and layout of a type of document data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { /** - * Configurations applied to digital parser. + * The JSON representation of the schema. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + jsonSchema?: string | null; /** - * Configurations applied to layout parser. + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + name?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * The structured representation of the schema. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + structSchema?: {[key: string]: any} | null; } /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} - /** - * The OCR parsing configurations for documents. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ - enhancedDocumentElements?: string[] | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * If true, will use native text instead of OCR text on pages containing native text. + * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */ - useNativeText?: boolean | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { + branch?: string | null; /** - * Operation create time. + * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. + */ + canonicalFilter?: string | null; + /** + * A specification for configuring the behavior of content search. + */ + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; + /** + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. + */ + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + /** + * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. + */ + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; + /** + * Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; + /** + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + */ + filter?: string | null; + /** + * Raw image query. + */ + imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; + /** + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + */ + languageCode?: string | null; + /** + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + */ + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; + /** + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - createTime?: string | null; + offset?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - updateTime?: string | null; - } - /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} - /** - * Metadata that describes the training and serving parameters of an Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + orderBy?: string | null; /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; + pageSize?: number | null; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; + pageToken?: string | null; /** - * Common config spec that specifies the metadata of the engine. + * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + params?: {[key: string]: any} | null; /** - * Output only. Timestamp the Recommendation Engine was created at. + * Raw search query. */ - createTime?: string | null; + query?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - dataStoreIds?: string[] | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ - displayName?: string | null; + rankingExpression?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ - industryVertical?: string | null; + regionCode?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */ - name?: string | null; + relevanceThreshold?: string | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * Whether to turn on safe search. This is only supported for website search. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; + safeSearch?: boolean | null; /** - * Required. The solutions of the engine. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - solutionType?: string | null; + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - updateTime?: string | null; - } - /** - * Configurations for a Chat Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { + servingConfig?: string | null; /** - * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; + session?: string | null; /** - * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + * Session specification. Can be used only when `session` is set. */ - dialogflowAgentToLink?: string | null; - } - /** - * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - business?: string | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - defaultLanguageCode?: string | null; + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** - * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - location?: string | null; + userLabels?: {[key: string]: string} | null; /** - * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - timeZone?: string | null; + userPseudoId?: string | null; } /** - * Additional information of a Chat Engine. Fields in this message are output only. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ - dialogflowAgent?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Common configurations for an Engine. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ - companyName?: string | null; - } - /** - * Configurations for a Search Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { + boost?: number | null; /** - * The add-on that this search engine enables. + * Complex specification for custom ranking based on customer defined attribute value. */ - searchAddOns?: string[] | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; /** - * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ - searchTier?: string | null; + condition?: string | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Operation create time. + * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */ - createTime?: string | null; + attributeType?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - failureCount?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * Count of CompletionSuggestions successfully imported. + * The name of the field whose value will be used to determine the boost amount. */ - successCount?: string | null; + fieldName?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The interpolation type to be applied to connect the control points listed below. */ - updateTime?: string | null; + interpolationType?: string | null; } /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * The desired location of errors incurred during the Import. + * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + attributeValue?: string | null; /** - * A sample of errors encountered while processing the request. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - errorSamples?: Schema$GoogleRpcStatus[]; + boostAmount?: number | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { /** - * Operation create time. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - createTime?: string | null; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; /** - * Count of entries that encountered errors while processing. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - failureCount?: string | null; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Count of entries that were processed successfully. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - successCount?: string | null; + searchResultMode?: string | null; /** - * Total count of entries that were processed. + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - totalCount?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; /** - * Operation last update time. If the operation is done, this is also the finish time. + * If `summarySpec` is not specified, summaries are not included in the search response. */ - updateTime?: string | null; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; } /** - * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { /** - * Echoes the destination for the complete errors in the request if set. + * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + numNextChunks?: number | null; /** - * A sample of errors encountered while processing the request. + * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */ - errorSamples?: Schema$GoogleRpcStatus[]; + numPreviousChunks?: number | null; } /** - * Configuration of destination for Import related errors. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * 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. + * The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */ - gcsPrefix?: string | null; - } - /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { + maxExtractiveAnswerCount?: number | null; /** - * Operation create time. + * The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */ - createTime?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Return at most `num_next_segments` segments after each selected segments. */ - updateTime?: string | null; + numNextSegments?: number | null; + /** + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. + */ + numPreviousSegments?: number | null; + /** + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { /** - * A sample of errors encountered while processing the request. + * [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. */ - errorSamples?: Schema$GoogleRpcStatus[]; + maxSnippetCount?: number | null; /** - * Count of deny list entries that failed to be imported. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - failedEntriesCount?: string | null; + referenceOnly?: boolean | null; /** - * Count of deny list entries successfully imported. + * If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */ - importedEntriesCount?: string | null; + returnSnippet?: boolean | null; } /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { /** - * Operation create time. + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ - createTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Count of entries that encountered errors while processing. + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ - failureCount?: string | null; + ignoreLowRelevantContent?: boolean | null; /** - * Count of entries that were processed successfully. + * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ - successCount?: string | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */ - updateTime?: string | null; - } - /** - * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { + includeCitations?: boolean | null; /** - * Echoes the destination for the complete errors if this field was set in the request. + * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + languageCode?: string | null; /** - * A sample of errors encountered while processing the request. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - errorSamples?: Schema$GoogleRpcStatus[]; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * Count of user events imported with complete existing Documents. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - joinedEventsCount?: string | null; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - unjoinedEventsCount?: string | null; + summaryResultCount?: number | null; + /** + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. + */ + useSemanticChunks?: boolean | null; } /** - * Language info for DataStore. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - language?: string | null; + preamble?: string | null; + } + /** + * Specification of the model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * The language code for the DataStore. + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ - languageCode?: string | null; + version?: string | null; + } + /** + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { /** - * Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - normalizedLanguageCode?: string | null; + dataStore?: string | null; + } + /** + * The specification that uses customized query embedding vector to do semantic document retrieval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { /** - * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. + * The embedding vector used for retrieval. Limit to 1. */ - region?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Response message for SearchTuningService.ListCustomModels method. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { /** - * List of custom tuning models. + * Embedding field path in schema. */ - models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; + fieldPath?: string | null; + /** + * Query embedding vector. + */ + vector?: number[] | null; } /** - * Metadata and configurations for a Google Cloud project in the service. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { /** - * Output only. The timestamp when this project is created. + * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */ - createTime?: string | null; + enableDynamicPosition?: boolean | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - name?: string | null; + excludedFilterKeys?: string[] | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * Required. The facet key specification. */ - provisionCompletionTime?: string | null; + facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; - } | null; + limit?: number | null; } /** - * Metadata about the terms of service. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { - /** - * The last time when the project agreed to the terms of service. - */ - acceptTime?: string | null; - /** - * The last time when the project declined or revoked the agreement to terms of service. - */ - declineTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { /** - * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - id?: string | null; + caseInsensitive?: boolean | null; /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. */ - state?: string | null; + contains?: string[] | null; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */ - version?: string | null; - } - /** - * Metadata associated with a project provision operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} - /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { + intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; /** - * Operation create time. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - createTime?: string | null; + key?: string | null; /** - * Count of entries that encountered errors while processing. + * The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. */ - failureCount?: string | null; + orderBy?: string | null; /** - * Count of entries that were ignored as entries were not found. + * Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. */ - ignoredCount?: string | null; + prefixes?: string[] | null; /** - * Count of entries that were deleted successfully. + * Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. */ - successCount?: string | null; + restrictedValues?: string[] | null; + } + /** + * Specifies the image query input. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - updateTime?: string | null; + imageBytes?: string | null; } /** - * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * The total count of documents purged as a result of the operation. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - purgeCount?: string | null; + filterExtractionCondition?: string | null; /** - * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */ - purgeSample?: string[] | null; + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { /** - * Operation create time. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - createTime?: string | null; + condition?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */ - updateTime?: string | null; + pinUnexpandedResults?: boolean | null; } /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec { /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; - /** - * Number of suggestion deny list entries purged. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - purgeCount?: string | null; + condition?: string | null; } /** - * Defines the structure and layout of a type of document data. + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec { /** - * The JSON representation of the schema. + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */ - jsonSchema?: string | null; + queryId?: string | null; /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */ - name?: string | null; + searchResultPersistenceCount?: number | null; + } + /** + * The specification for query spell correction. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { /** - * The structured representation of the schema. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - structSchema?: {[key: string]: any} | null; + mode?: string | null; } /** * Verification information for target sites in advanced site search. @@ -3648,6 +5104,32 @@ export namespace discoveryengine_v1 { */ updateTime?: string | null; } + /** + * Information of an end user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + /** + * 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 | null; + /** + * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userId?: string | null; + } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } /** * BigQuery source import data from. */ @@ -3669,7 +5151,7 @@ export namespace discoveryengine_v1 { */ partitionDate?: Schema$GoogleTypeDate; /** - * The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -3749,7 +5231,7 @@ export namespace discoveryengine_v1 { */ instanceId?: string | null; /** - * The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -3815,6 +5297,10 @@ export namespace discoveryengine_v1 { * Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */ groundingCheckRequired?: boolean | null; + /** + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. + */ + score?: number | null; /** * Position indicating the start of the claim in the answer candidate, measured in bytes. */ @@ -3930,7 +5416,7 @@ export namespace discoveryengine_v1 { */ offload?: boolean | null; /** - * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -4054,7 +5540,7 @@ export namespace discoveryengine_v1 { */ export interface Schema$GoogleCloudDiscoveryengineV1Control { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ associatedServingConfigIds?: string[] | null; /** @@ -4333,6 +5819,39 @@ export namespace discoveryengine_v1 { */ text?: string[] | null; } + /** + * Metadata that describes a custom tuned model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CustomTuningModel { + /** + * Timestamp the Model was created at. + */ + createTime?: string | null; + /** + * The display name of the model. + */ + displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + */ + modelState?: string | null; + /** + * The version of the model. + */ + modelVersion?: string | null; + /** + * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + */ + name?: string | null; + /** + * Timestamp the model training was initiated. + */ + trainingStartTime?: string | null; + } /** * DataStore captures global settings and configs at the DataStore level. */ @@ -4373,6 +5892,10 @@ export namespace discoveryengine_v1 { * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig; } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -4513,6 +6036,10 @@ export namespace discoveryengine_v1 { * The Document resource ID. */ id?: string | null; + /** + * Output only. Whether the referenced Document can be found in the data store. + */ + joined?: boolean | null; /** * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` */ @@ -4547,7 +6074,7 @@ export namespace discoveryengine_v1 { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -4800,6 +6327,10 @@ export namespace discoveryengine_v1 { * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */ gcsStagingDir?: string | null; + /** + * The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. + */ + resourceTypes?: string[] | null; } /** * Firestore source import data from. @@ -5200,6 +6731,15 @@ export namespace discoveryengine_v1 { */ nextPageToken?: string | null; } + /** + * Response message for SearchTuningService.ListCustomModels method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ListCustomModelsResponse { + /** + * List of custom tuning models. + */ + models?: Schema$GoogleCloudDiscoveryengineV1CustomTuningModel[]; + } /** * Response message for DataStoreService.ListDataStores method. */ @@ -5461,6 +7001,10 @@ export namespace discoveryengine_v1 { * Request message for DocumentService.PurgeDocuments method. */ export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsRequest { + /** + * The desired location of errors incurred during the purge. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1PurgeErrorConfig; /** * Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */ @@ -5469,6 +7013,23 @@ export namespace discoveryengine_v1 { * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */ force?: boolean | null; + /** + * Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. + */ + gcsSource?: Schema$GoogleCloudDiscoveryengineV1GcsSource; + /** + * Inline source for the input content for purge. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource; + } + /** + * The inline source for the input config for DocumentService.PurgeDocuments method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource { + /** + * Required. A list of full resource name of documents to purge. In the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. Recommended max of 100 items. + */ + documents?: string[] | null; } /** * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. @@ -5483,6 +7044,15 @@ export namespace discoveryengine_v1 { */ purgeSample?: string[] | null; } + /** + * Configuration of destination for Purge related errors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeErrorConfig { + /** + * Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. + */ + gcsPrefix?: string | null; + } /** * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -5513,6 +7083,19 @@ export namespace discoveryengine_v1 { */ purgeCount?: string | null; } + /** + * Request message for PurgeUserEvents method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest { + /** + * Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \> "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `eventType = "search"` * Deleting all events for a specific visitor: `userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. + */ + filter?: string | null; + /** + * The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. + */ + force?: boolean | null; + } /** * Defines a user inputed query. */ @@ -5749,7 +7332,7 @@ export namespace discoveryengine_v1 { */ offset?: number | null; /** - * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ orderBy?: string | null; /** @@ -5776,6 +7359,18 @@ export namespace discoveryengine_v1 { * Whether to turn on safe search. This is only supported for website search. */ safeSearch?: boolean | null; + /** + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. + */ + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec; + /** + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + */ + session?: string | null; + /** + * Session specification. Can be used only when `session` is set. + */ + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestSessionSpec; /** * The spell correction specification that specifies the mode under which spell correction takes effect. */ @@ -5828,7 +7423,7 @@ export namespace discoveryengine_v1 { */ extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecExtractiveContentSpec; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ searchResultMode?: string | null; /** @@ -5903,6 +7498,10 @@ export namespace discoveryengine_v1 { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. + */ + ignoreLowRelevantContent?: boolean | null; /** * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ @@ -5951,7 +7550,7 @@ export namespace discoveryengine_v1 { version?: string | null; } /** - * A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. */ export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec { /** @@ -6035,6 +7634,28 @@ export namespace discoveryengine_v1 { */ pinUnexpandedResults?: boolean | null; } + /** + * Specification for search as you type in search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestSearchAsYouTypeSpec { + /** + * The condition under which search as you type should occur. Default to Condition.DISABLED. + */ + condition?: string | null; + } + /** + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchRequestSessionSpec { + /** + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. + */ + queryId?: string | null; + /** + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + */ + searchResultPersistenceCount?: number | null; + } /** * The specification for query spell correction. */ @@ -6076,6 +7697,10 @@ export namespace discoveryengine_v1 { * A list of matched documents. The order represents the ranking. */ results?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSearchResult[]; + /** + * Session information. Only set if SearchRequest.session is provided. See its description for more details. + */ + sessionInfo?: Schema$GoogleCloudDiscoveryengineV1SearchResponseSessionInfo; /** * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */ @@ -6149,6 +7774,19 @@ export namespace discoveryengine_v1 { */ id?: string | null; } + /** + * Information about the session. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SearchResponseSessionInfo { + /** + * Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. + */ + name?: string | null; + /** + * Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. + */ + queryId?: string | null; + } /** * Summary of the top N search results specified by the summary spec. */ @@ -6350,7 +7988,7 @@ export namespace discoveryengine_v1 { */ instanceId?: string | null; /** - * The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -6447,6 +8085,86 @@ export namespace discoveryengine_v1 { */ input?: string | null; } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SearchTuningService.TrainCustomModel method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelRequest { + /** + * The desired location of errors incurred during the data ingestion and training. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * Cloud Storage training input. + */ + gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput; + /** + * If not provided, a UUID will be generated. + */ + modelId?: string | null; + /** + * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. + */ + modelType?: string | null; + } + /** + * Cloud Storage training data input. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelRequestGcsTrainingInput { + /** + * The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}` + */ + corpusDataPath?: string | null; + /** + * The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\} + */ + queryDataPath?: string | null; + /** + * Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. + */ + testDataPath?: string | null; + /** + * Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` + */ + trainDataPath?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; + } /** * A transaction represents the entire purchase transaction. */ @@ -6602,6 +8320,19 @@ export namespace discoveryengine_v1 { */ userId?: string | null; } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } /** * The request message for Operations.CancelOperation. */ @@ -6808,6 +8539,7 @@ export namespace discoveryengine_v1 { collections: Resource$Projects$Locations$Collections; dataStores: Resource$Projects$Locations$Datastores; groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + identity_mapping_stores: Resource$Projects$Locations$Identity_mapping_stores; operations: Resource$Projects$Locations$Operations; rankingConfigs: Resource$Projects$Locations$Rankingconfigs; userEvents: Resource$Projects$Locations$Userevents; @@ -6822,6 +8554,8 @@ export namespace discoveryengine_v1 { this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( this.context ); + this.identity_mapping_stores = + new Resource$Projects$Locations$Identity_mapping_stores(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context ); @@ -7101,6 +8835,7 @@ export namespace discoveryengine_v1 { completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; controls: Resource$Projects$Locations$Collections$Datastores$Controls; conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; + customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; models: Resource$Projects$Locations$Collections$Datastores$Models; operations: Resource$Projects$Locations$Collections$Datastores$Operations; schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; @@ -7127,6 +8862,10 @@ export namespace discoveryengine_v1 { new Resource$Projects$Locations$Collections$Datastores$Conversations( this.context ); + this.customModels = + new Resource$Projects$Locations$Collections$Datastores$Custommodels( + this.context + ); this.models = new Resource$Projects$Locations$Collections$Datastores$Models( this.context @@ -7837,6 +9576,103 @@ export namespace discoveryengine_v1 { ); } } + + /** + * Trains a custom model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions + ): GaxiosPromise; + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options?: MethodOptions + ): GaxiosPromise; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + callback: BodyResponseCallback + ): void; + trainCustomModel( + callback: BodyResponseCallback + ): void; + trainCustomModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataStore}:trainCustomModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery @@ -7876,6 +9712,10 @@ export namespace discoveryengine_v1 { * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. */ parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; /** * Request body metadata @@ -7903,58 +9743,181 @@ export namespace discoveryengine_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1DataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1TrainCustomModelRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( + this.context + ); + } + + /** + * Gets index freshness metadata for Documents. Supported for website search only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options?: MethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/batchGetDocumentsMetadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata extends StandardParameters { /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + * The exact URIs to match by. */ - pageToken?: string; + 'matcher.urisMatcher.uris'?: string[]; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch - extends StandardParameters { - /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1DataStore; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( - this.context - ); - } - } export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { context: APIRequestContext; @@ -10497,6 +12460,120 @@ export namespace discoveryengine_v1 { requestBody?: Schema$GoogleCloudDiscoveryengineV1Conversation; } + export class Resource$Projects$Locations$Collections$Datastores$Custommodels { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a list of all the custom models. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+dataStore}/customModels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + extends StandardParameters { + /** + * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. + */ + dataStore?: string; + } + export class Resource$Projects$Locations$Collections$Datastores$Models { context: APIRequestContext; operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; @@ -14679,41 +16756,138 @@ export namespace discoveryengine_v1 { options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback + ): void; + collect(callback: BodyResponseCallback): void; + collect( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + import( + callback: BodyResponseCallback + ): void; + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -14727,11 +16901,11 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:collect').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -14742,53 +16916,53 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback ): void; - import( + purge( callback: BodyResponseCallback ): void; - import( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14804,13 +16978,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; options = {}; } @@ -14824,7 +16998,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -14979,6 +17153,18 @@ export namespace discoveryengine_v1 { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportUserEventsRequest; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + extends StandardParameters { + /** + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest; + } export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters { /** @@ -19022,6 +21208,10 @@ export namespace discoveryengine_v1 { * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. */ parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; /** * Request body metadata @@ -19100,6 +21290,117 @@ export namespace discoveryengine_v1 { this.context ); } + + /** + * Gets index freshness metadata for Documents. Supported for website search only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options?: MethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/batchGetDocumentsMetadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { + /** + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; } export class Resource$Projects$Locations$Datastores$Branches$Documents { @@ -24959,7 +27260,104 @@ export namespace discoveryengine_v1 { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -24970,53 +27368,53 @@ export namespace discoveryengine_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, callback: BodyResponseCallback ): void; - import( + purge( callback: BodyResponseCallback ): void; - import( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | Params$Resource$Projects$Locations$Datastores$Userevents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25032,13 +27430,13 @@ export namespace discoveryengine_v1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; options = {}; } @@ -25052,7 +27450,7 @@ export namespace discoveryengine_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1/{+parent}/userEvents:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -25207,6 +27605,18 @@ export namespace discoveryengine_v1 { */ requestBody?: Schema$GoogleCloudDiscoveryengineV1ImportUserEventsRequest; } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge + extends StandardParameters { + /** + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1PurgeUserEventsRequest; + } export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters { /** @@ -25343,6 +27753,245 @@ export namespace discoveryengine_v1 { requestBody?: Schema$GoogleCloudDiscoveryengineV1CheckGroundingRequest; } + export class Resource$Projects$Locations$Identity_mapping_stores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Identity_mapping_stores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Identity_mapping_stores$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Identity_mapping_stores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index b22e3d126e..56f99cdf26 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -409,7 +409,7 @@ export namespace discoveryengine_v1alpha { */ locationId?: string | null; /** - * The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -683,7 +683,7 @@ export namespace discoveryengine_v1alpha { */ orderBy?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */ searchResultMode?: string | null; } @@ -795,7 +795,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryResponse { /** - * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + * Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */ answer?: Schema$GoogleCloudDiscoveryengineV1alphaAnswer; /** @@ -837,6 +837,10 @@ export namespace discoveryengine_v1alpha { * Chunk information. */ chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo; + /** + * Structured document information. + */ + structuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo; /** * Unstructured document information. */ @@ -859,7 +863,7 @@ export namespace discoveryengine_v1alpha { */ documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata; /** - * Relevance score. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ relevanceScore?: number | null; } @@ -888,6 +892,19 @@ export namespace discoveryengine_v1alpha { */ uri?: string | null; } + /** + * Structured search information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo { + /** + * Document resource name. + */ + document?: string | null; + /** + * Structured search data. + */ + structData?: {[key: string]: any} | null; + } /** * Unstructured document information. */ @@ -925,6 +942,10 @@ export namespace discoveryengine_v1alpha { * Page identifier. */ pageIdentifier?: string | null; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; } /** * Step information. @@ -982,6 +1003,10 @@ export namespace discoveryengine_v1alpha { * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + */ + structData?: {[key: string]: any} | null; /** * Title. */ @@ -1004,7 +1029,7 @@ export namespace discoveryengine_v1alpha { */ content?: string | null; /** - * Relevance score. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ relevanceScore?: number | null; } @@ -1061,6 +1086,41 @@ export namespace discoveryengine_v1alpha { */ targetSites?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite[]; } + /** + * Response message for DocumentService.BatchGetDocumentsMetadata method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponse { + /** + * The metadata of the Documents. + */ + documentsMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata[]; + } + /** + * The metadata of a Document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadata { + /** + * The timestamp of the last time the Document was last indexed. + */ + lastRefreshedTime?: string | null; + /** + * The value of the matcher that was used to match the Document. + */ + matcherValue?: Schema$GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; + /** + * The status of the document. + */ + status?: string | null; + } + /** + * The value of the matcher that was used to match the Document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue { + /** + * If match by URI, the URI of the Document. + */ + uri?: string | null; + } /** * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ @@ -1086,7 +1146,7 @@ export namespace discoveryengine_v1alpha { */ partitionDate?: Schema$GoogleTypeDate; /** - * The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -1166,7 +1226,7 @@ export namespace discoveryengine_v1alpha { */ instanceId?: string | null; /** - * The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -1232,6 +1292,10 @@ export namespace discoveryengine_v1alpha { * Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */ groundingCheckRequired?: boolean | null; + /** + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. + */ + score?: number | null; /** * Position indicating the start of the claim in the answer candidate, measured in bytes. */ @@ -1255,7 +1319,7 @@ export namespace discoveryengine_v1alpha { */ requirementType?: string | null; /** - * The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` + * The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` */ resources?: Schema$GoogleApiMonitoredResource[]; } @@ -1410,7 +1474,7 @@ export namespace discoveryengine_v1alpha { */ offload?: boolean | null; /** - * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -1534,7 +1598,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaControl { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ associatedServingConfigIds?: string[] | null; /** @@ -1765,6 +1829,10 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -1838,6 +1906,10 @@ export namespace discoveryengine_v1alpha { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -1907,6 +1979,10 @@ export namespace discoveryengine_v1alpha { * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig; } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -2039,6 +2115,10 @@ export namespace discoveryengine_v1alpha { * AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --\> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ] \} ] \} \} Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" \}, { "group_id": "group_3" \}, { "user_id": "user_2" \} ], \}, { "principals": [ { "group_id": "group_1" \}, { "user_id": "user_1" \} ], \} ] \} \} */ export interface Schema$GoogleCloudDiscoveryengineV1alphaDocumentAclInfoAccessRestriction { + /** + * All users within the Identity Provider. + */ + idpWide?: boolean | null; /** * List of principals. */ @@ -2069,6 +2149,10 @@ export namespace discoveryengine_v1alpha { * The Document resource ID. */ id?: string | null; + /** + * Output only. Whether the referenced Document can be found in the data store. + */ + joined?: boolean | null; /** * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` */ @@ -2103,7 +2187,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -2469,6 +2553,65 @@ export namespace discoveryengine_v1alpha { */ documentCount?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec; + /** + * Identifier. The full resource name of the Evaluation, in the format of `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec; + /** + * Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } /** * Fact Chunk. */ @@ -2519,6 +2662,10 @@ export namespace discoveryengine_v1alpha { * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */ gcsStagingDir?: string | null; + /** + * The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. + */ + resourceTypes?: string[] | null; } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. @@ -2603,6 +2750,15 @@ export namespace discoveryengine_v1alpha { */ inputUris?: string[] | null; } + /** + * Response message for SiteSearchEngineService.GetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse { + /** + * Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + } /** * Grounding Fact. */ @@ -2836,6 +2992,74 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SampleQueryService.ImportSampleQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest { + /** + * BigQuery input source. + */ + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1alphaBigQuerySource; + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * Cloud Storage location for the input content. + */ + gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource; + /** + * The Inline source for sample query entries. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource; + } + /** + * The inline source for SampleQuerys. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource { + /** + * Required. A list of SampleQuerys to import. Max of 1000 items. + */ + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery[]; + } + /** + * Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -3089,6 +3313,71 @@ export namespace discoveryengine_v1alpha { */ nextPageToken?: string | null; } + /** + * Response message for EvaluationService.ListEvaluationResults method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse { + /** + * The EvaluationResults. + */ + evaluationResults?: Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult[]; + /** + * A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Represents the results of an evaluation for a single SampleQuery. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult { + /** + * Output only. The metrics produced by the evaluation, for a given SampleQuery. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The SampleQuery that was evaluated. + */ + sampleQuery?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } + /** + * Response message for EvaluationService.ListEvaluations method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse { + /** + * The Evaluations. + */ + evaluations?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluation[]; + /** + * A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for SampleQueryService.ListSampleQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse { + /** + * A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The SampleQuerys. + */ + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery[]; + } + /** + * Response message for SampleQuerySetService.ListSampleQuerySets method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse { + /** + * A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * The SampleQuerySets. + */ + sampleQuerySets?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet[]; + } /** * Response message for SchemaService.ListSchemas method. */ @@ -3372,6 +3661,19 @@ export namespace discoveryengine_v1alpha { * Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */ gcsSource?: Schema$GoogleCloudDiscoveryengineV1alphaGcsSource; + /** + * Inline source for the input content for purge. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource; + } + /** + * The inline source for the input config for DocumentService.PurgeDocuments method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequestInlineSource { + /** + * Required. A list of full resource name of documents to purge. In the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. Recommended max of 100 items. + */ + documents?: string[] | null; } /** * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. @@ -3468,6 +3770,52 @@ export namespace discoveryengine_v1alpha { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics { + /** + * Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines a user inputed query. */ @@ -3844,57 +4192,125 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest {} /** - * Defines the structure and layout of a type of document data. + * Sample Query captures metadata to be used for evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSchema { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery { /** - * Output only. Configurations for fields of the schema. + * Output only. Timestamp the SampleQuery was created at. */ - fieldConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaFieldConfig[]; + createTime?: string | null; /** - * The JSON representation of the schema. + * Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - jsonSchema?: string | null; + name?: string | null; /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * The query entry. */ - name?: string | null; + queryEntry?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry; + } + /** + * Query Entry captures metadata to be used for search evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry { /** - * The structured representation of the schema. + * Required. The query. */ - structSchema?: {[key: string]: any} | null; + query?: string | null; + /** + * List of targets for the query. + */ + targets?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget[]; } /** - * Detailed search information. + * Defines the parameters of the query's expected outcome. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget { /** - * 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. + * Expected page numbers of the target. Each page number must be non negative. */ - offset?: number | null; + pageNumbers?: number[] | null; /** - * 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. + * Relevance score of the target. */ - orderBy?: string | null; + score?: number | null; /** - * 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. + * Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`. */ - searchQuery?: string | null; + uri?: string | null; } /** - * Request message for SearchService.Search method. + * A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet { /** - * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + * Output only. Timestamp the SampleQuerySet was created at. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; + createTime?: string | null; /** - * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. + * The description of the SampleQuerySet. */ - branch?: string | null; + description?: string | null; /** - * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. + * Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. + */ + displayName?: string | null; + /** + * Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSchema { + /** + * Output only. Configurations for fields of the schema. + */ + fieldConfigs?: Schema$GoogleCloudDiscoveryengineV1alphaFieldConfig[]; + /** + * The JSON representation of the schema. + */ + jsonSchema?: string | null; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The structured representation of the schema. + */ + structSchema?: {[key: string]: any} | null; + } + /** + * Detailed search information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchInfo { + /** + * 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. + */ + offset?: number | null; + /** + * 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. + */ + orderBy?: string | null; + /** + * 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. + */ + searchQuery?: string | null; + } + /** + * Request message for SearchService.Search method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest { + /** + * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + */ + boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; + /** + * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. + */ + branch?: string | null; + /** + * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ canonicalFilter?: string | null; /** @@ -3902,7 +4318,7 @@ export namespace discoveryengine_v1alpha { */ contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; /** - * Custom fine tuning configs. + * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** @@ -3929,12 +4345,16 @@ export namespace discoveryengine_v1alpha { * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */ languageCode?: string | null; + /** + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. + */ + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */ offset?: number | null; /** - * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ orderBy?: string | null; /** @@ -3958,7 +4378,7 @@ export namespace discoveryengine_v1alpha { */ queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ rankingExpression?: string | null; /** @@ -3977,6 +4397,18 @@ export namespace discoveryengine_v1alpha { * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string | null; + /** + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + */ + session?: string | null; + /** + * Session specification. Can be used only when `session` is set. + */ + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; /** * The spell correction specification that specifies the mode under which spell correction takes effect. */ @@ -4067,7 +4499,7 @@ export namespace discoveryengine_v1alpha { */ extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ searchResultMode?: string | null; /** @@ -4142,6 +4574,10 @@ export namespace discoveryengine_v1alpha { * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ ignoreAdversarialQuery?: boolean | null; + /** + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. + */ + ignoreLowRelevantContent?: boolean | null; /** * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ @@ -4190,7 +4626,7 @@ export namespace discoveryengine_v1alpha { version?: string | null; } /** - * A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. */ export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { /** @@ -4283,6 +4719,19 @@ export namespace discoveryengine_v1alpha { */ imageBytes?: string | null; } + /** + * Specification to enable natural language understanding capabilities for search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { + /** + * The condition under which filter extraction should occur. Default to Condition.DISABLED. + */ + filterExtractionCondition?: string | null; + /** + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + */ + geoSearchQueryDetectionFieldNames?: string[] | null; + } /** * Specification to determine under which conditions query expansion should occur. */ @@ -4305,6 +4754,19 @@ export namespace discoveryengine_v1alpha { */ condition?: string | null; } + /** + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec { + /** + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. + */ + queryId?: string | null; + /** + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. + */ + searchResultPersistenceCount?: number | null; + } /** * The specification for query spell correction. */ @@ -4339,10 +4801,18 @@ export namespace discoveryengine_v1alpha { * Guided search result. */ guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult; + /** + * Natural language query understanding information for the returned results. + */ + naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo; /** * A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ nextPageToken?: string | null; + /** + * A list of One Box results. There can be multiple One Box results of different types. + */ + oneBoxResults?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult[]; /** * Query expansion information for the returned results. */ @@ -4355,6 +4825,10 @@ export namespace discoveryengine_v1alpha { * A list of matched documents. The order represents the ranking. */ results?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[]; + /** + * Session information. Only set if SearchRequest.session is provided. See its description for more details. + */ + sessionInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo; /** * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */ @@ -4437,6 +4911,147 @@ export namespace discoveryengine_v1alpha { */ attributeValue?: string | null; } + /** + * Information describing what natural language understanding was done on the input query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfo { + /** + * The filters that were extracted from the input query. + */ + extractedFilters?: string | null; + /** + * Rewritten input query minus the extracted filters. + */ + rewrittenQuery?: string | null; + /** + * The filters that were extracted from the input query represented in a structured form. + */ + structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter; + } + /** + * The filters that were extracted from the input query represented in a structured form. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter { + /** + * The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. + */ + expression?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression; + } + /** + * Logical `And` operator. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression { + /** + * The expressions that were ANDed together. + */ + expressions?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; + } + /** + * The expression denoting the filter that was extracted from the input query. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression { + /** + * Logical "And" compound operator connecting multiple expressions. + */ + andExpr?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression; + /** + * Geolocation constraint expression. + */ + geolocationConstraint?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint; + /** + * Numerical constraint expression. + */ + numberConstraint?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint; + /** + * Logical "Or" compound operator connecting multiple expressions. + */ + orExpr?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression; + /** + * String constraint expression. + */ + stringConstraint?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint; + } + /** + * Constraint of a geolocation field. Name of the geolocation field as defined in the schema. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint { + /** + * The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. + */ + address?: string | null; + /** + * The name of the geolocation field as defined in the schema. + */ + fieldName?: string | null; + /** + * The latitude of the geolocation inferred from the input query. + */ + latitude?: number | null; + /** + * The longitude of the geolocation inferred from the input query. + */ + longitude?: number | null; + /** + * The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. + */ + radiusInMeters?: number | null; + } + /** + * Constraint expression of a number field. Example: price < 100. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint { + /** + * The comparison operation performed between the field value and the value specified in the constraint. + */ + comparison?: string | null; + /** + * Name of the numerical field as defined in the schema. + */ + fieldName?: string | null; + /** + * The value specified in the numerical constraint. + */ + value?: number | null; + } + /** + * Logical `Or` operator. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression { + /** + * The expressions that were ORed together. + */ + expressions?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; + } + /** + * Constraint expression of a string field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint { + /** + * Name of the string field as defined in the schema. + */ + fieldName?: string | null; + /** + * Identifies the keywords within the search query that match a filter. + */ + querySegment?: string | null; + /** + * Values of the string field. The record will only be returned if the field value matches one of the values specified here. + */ + values?: string[] | null; + } + /** + * OneBoxResult is a holder for all results of specific type that we want to display in UI differently. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseOneBoxResult { + /** + * The type of One Box result. + */ + oneBoxType?: string | null; + /** + * The search results for this One Box. + */ + searchResults?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSearchResult[]; + } /** * Information describing query expansion including whether expansion has occurred. */ @@ -4473,6 +5088,19 @@ export namespace discoveryengine_v1alpha { [key: string]: Schema$GoogleCloudDiscoveryengineV1alphaDoubleList; } | null; } + /** + * Information about the session. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseSessionInfo { + /** + * Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. + */ + name?: string | null; + /** + * Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. + */ + queryId?: string | null; + } /** * Summary of the top N search results specified by the summary spec. */ @@ -4606,7 +5234,7 @@ export namespace discoveryengine_v1alpha { */ createTime?: string | null; /** - * Custom fine tuning configs. + * Custom fine tuning configs. If SearchRequest.custom_fine_tuning_spec is set, it has higher priority than the configs set here. */ customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** @@ -4658,7 +5286,7 @@ export namespace discoveryengine_v1alpha { */ onewaySynonymsControlIds?: string[] | null; /** - * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding). + * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ rankingExpression?: string | null; /** @@ -4754,6 +5382,40 @@ export namespace discoveryengine_v1alpha { */ query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; } + /** + * Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.SetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest { + /** + * Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" \} \} \} document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + /** + * If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty. + */ + emptyDocumentDataMap?: boolean | null; + /** + * Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned. + */ + schema?: {[key: string]: any} | null; + } + /** + * Response message for SiteSearchEngineService.SetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {} /** * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ @@ -4793,7 +5455,7 @@ export namespace discoveryengine_v1alpha { */ instanceId?: string | null; /** - * The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ projectId?: string | null; /** @@ -5142,6 +5804,19 @@ export namespace discoveryengine_v1alpha { */ userId?: string | null; } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } /** * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ @@ -5230,7 +5905,7 @@ export namespace discoveryengine_v1alpha { */ export interface Schema$GoogleCloudDiscoveryengineV1betaControl { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ associatedServingConfigIds?: string[] | null; /** @@ -5344,6 +6019,10 @@ export namespace discoveryengine_v1alpha { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -5382,6 +6061,10 @@ export namespace discoveryengine_v1alpha { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -5443,6 +6126,10 @@ export namespace discoveryengine_v1alpha { * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig; } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -5530,7 +6217,7 @@ export namespace discoveryengine_v1alpha { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -5730,49 +6417,108 @@ export namespace discoveryengine_v1alpha { searchTier?: string | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluation { /** - * Operation create time. + * Output only. Timestamp the Evaluation was created at. */ createTime?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. + * Output only. Timestamp the Evaluation was completed at. */ - failureCount?: string | null; + endTime?: string | null; /** - * Count of CompletionSuggestions successfully imported. + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */ - successCount?: string | null; + error?: Schema$GoogleRpcStatus; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Output only. A sample of errors encountered while processing the request. */ - updateTime?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec; + /** + * Identifier. The full resource name of the Evaluation, in the format of `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; } /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + * Describes the specification of the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec { /** - * The desired location of errors incurred during the Import. + * Required. The specification of the query set. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec; /** - * A sample of errors encountered while processing the request. + * Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id */ - errorSamples?: Schema$GoogleRpcStatus[]; + searchRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * Describes the specification of the query set. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec { /** - * Operation create time. + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - createTime?: string | null; - /** - * Count of entries that encountered errors while processing. + sampleQuerySet?: string | null; + } + /** + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of CompletionSuggestions that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. */ failureCount?: string | null; /** @@ -5810,6 +6556,44 @@ export namespace discoveryengine_v1alpha { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -5882,6 +6666,27 @@ export namespace discoveryengine_v1alpha { */ unjoinedEventsCount?: string | null; } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { + /** + * Exclusive upper bound. + */ + exclusiveMaximum?: number | null; + /** + * Exclusive lower bound. + */ + exclusiveMinimum?: number | null; + /** + * Inclusive upper bound. + */ + maximum?: number | null; + /** + * Inclusive lower bound. + */ + minimum?: number | null; + } /** * Language info for DataStore. */ @@ -6028,6 +6833,52 @@ export namespace discoveryengine_v1alpha { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics { + /** + * Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; + /** + * Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; + /** + * Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; + /** + * Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; + /** + * Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines the structure and layout of a type of document data. */ @@ -6046,941 +6897,821 @@ export namespace discoveryengine_v1alpha { structSchema?: {[key: string]: any} | null; } /** - * Verification information for target sites in advanced site search. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { /** - * Site verification state indicating the ownership and validity. + * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ - siteVerificationState?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * Latest site verification time. + * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { + branch?: string | null; /** - * 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. + * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ - exactMatch?: boolean | null; + canonicalFilter?: string | null; /** - * Output only. Failure reason. + * A specification for configuring the behavior of content search. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */ - generatedUriPattern?: string | null; + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * Output only. Indexing status. + * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */ - indexingStatus?: string | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - name?: string | null; + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ - providedUriPattern?: string | null; + filter?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * Raw image query. */ - rootDomainUri?: string | null; + imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; /** - * Output only. Site ownership and validity verification status. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; + languageCode?: string | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - type?: string | null; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Output only. The target site's last updated time. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { + offset?: number | null; /** - * Failed due to insufficient quota. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { + orderBy?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - totalRequiredQuota?: string | null; - } - /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { + pageSize?: number | null; /** - * Operation create time. + * A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - createTime?: string | null; + pageToken?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ - updateTime?: string | null; - } - /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { + params?: {[key: string]: any} | null; /** - * Echoes the destination for the complete errors in the request if set. + * Raw search query. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + query?: string | null; /** - * A sample of errors encountered while processing the data. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - errorSamples?: Schema$GoogleRpcStatus[]; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * The metrics of the trained model. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ - metrics?: {[key: string]: number} | null; + rankingExpression?: string | null; /** - * Fully qualified name of the CustomTuningModel. + * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ - modelName?: string | null; + regionCode?: string | null; /** - * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */ - modelStatus?: string | null; - } - /** - * Metadata associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { + relevanceThreshold?: string | null; /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Whether to turn on safe search. This is only supported for website search. */ - engine?: string | null; - } - /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { + safeSearch?: boolean | null; /** - * Operation create time. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - createTime?: string | null; + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { + servingConfig?: string | null; /** - * Operation create time. + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - createTime?: string | null; + session?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Session specification. Can be used only when `session` is set. */ - updateTime?: string | null; - } - /** - * Defines circumstances to be checked before allowing a behavior - */ - export interface Schema$GoogleCloudDiscoveryengineV1Condition { + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; - } - /** - * Matcher for search request query - */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** - * Whether the search query needs to exactly match the query term. + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - fullMatch?: boolean | null; + userLabels?: {[key: string]: string} | null; /** - * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - value?: string | null; + userPseudoId?: string | null; } /** - * Used for time-dependent conditions. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { - /** - * End of time range. Range is inclusive. Must be in the future. - */ - endTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * Start of time range. Range is inclusive. + * Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ - startTime?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1Control { - /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. - */ - associatedServingConfigIds?: string[] | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * Defines a boost-type control + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; + boost?: number | null; /** - * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. + * Complex specification for custom ranking based on customer defined attribute value. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; /** - * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ - displayName?: string | null; + condition?: string | null; + } + /** + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Defines a filter-type control Currently not supported by Recommendation + * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; + attributeType?: string | null; /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - name?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * Defines a redirect-type control. + * The name of the field whose value will be used to determine the boost amount. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; + fieldName?: string | null; /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * The interpolation type to be applied to connect the control points listed below. */ - solutionType?: string | null; + interpolationType?: string | null; + } + /** + * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Treats a group of terms as synonyms of one another. + * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + attributeValue?: string | null; /** - * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - useCases?: string[] | null; + boostAmount?: number | null; } /** - * Adjusts order of products in returned list. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - boost?: number | null; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; /** - * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - dataStore?: string | null; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; /** - * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. */ - filter?: string | null; - } - /** - * Specified which products may be included in results. Uses same filter as boost. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { + searchResultMode?: string | null; /** - * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * If `snippetSpec` is not specified, snippets are not included in the search response. */ - dataStore?: string | null; + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; /** - * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * If `summarySpec` is not specified, summaries are not included in the search response. */ - filter?: string | null; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; } /** - * Redirects a shopper to the provided URI. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { /** - * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */ - redirectUri?: string | null; - } - /** - * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". - */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { + numNextChunks?: number | null; /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */ - synonyms?: string[] | null; + numPreviousChunks?: number | null; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { + maxExtractiveAnswerCount?: number | null; /** - * Operation create time. + * The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */ - createTime?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Return at most `num_next_segments` segments after each selected segments. */ - updateTime?: string | null; - } - /** - * Metadata for Create Schema LRO. - */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { + numNextSegments?: number | null; /** - * Operation create time. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - createTime?: string | null; + numPreviousSegments?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. */ - updateTime?: string | null; + returnExtractiveSegmentScore?: boolean | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { /** - * Operation create time. + * [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. */ - createTime?: string | null; + maxSnippetCount?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - updateTime?: string | null; + referenceOnly?: boolean | null; + /** + * If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + */ + returnSnippet?: boolean | null; } /** - * DataStore captures global settings and configs at the DataStore level. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ - contentConfig?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Output only. Timestamp the DataStore was created at. + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ - createTime?: string | null; + ignoreLowRelevantContent?: boolean | null; /** - * Output only. The id of the default Schema asscociated to this data store. + * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ - defaultSchemaId?: string | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */ - displayName?: string | null; + includeCitations?: boolean | null; /** - * Configuration for Document understanding and enrichment. + * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + languageCode?: string | null; /** - * Immutable. The industry vertical that the data store registers. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - industryVertical?: string | null; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - name?: string | null; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - solutionTypes?: string[] | null; + summaryResultCount?: number | null; /** - * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + useSemanticChunks?: boolean | null; } /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - updateTime?: string | null; + preamble?: string | null; } /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification of the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ - updateTime?: string | null; + version?: string | null; } /** - * Metadata for DeleteSchema LRO. + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { /** - * Operation create time. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - createTime?: string | null; + dataStore?: string | null; + } + /** + * The specification that uses customized query embedding vector to do semantic document retrieval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The embedding vector used for retrieval. Limit to 1. */ - updateTime?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Operation create time. + * Embedding field path in schema. */ - createTime?: string | null; + fieldPath?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Query embedding vector. */ - updateTime?: string | null; + vector?: number[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { /** - * Operation create time. + * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */ - createTime?: string | null; + enableDynamicPosition?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - updateTime?: string | null; + excludedFilterKeys?: string[] | null; + /** + * Required. The facet key specification. + */ + facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; + /** + * Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. + */ + limit?: number | null; } /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + * Specifies how a facet is computed. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { /** - * Whether chunking mode is enabled. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; + caseInsensitive?: boolean | null; /** - * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + * Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + contains?: string[] | null; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */ - name?: string | null; + intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; - } | null; + key?: string | null; + /** + * The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. + */ + orderBy?: string | null; + /** + * Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. + */ + prefixes?: string[] | null; + /** + * Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. + */ + restrictedValues?: string[] | null; } /** - * Configuration for chunking config. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { /** - * Configuration for the layout based chunking. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + imageBytes?: string | null; } /** - * Configuration for the layout based chunking. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - chunkSize?: number | null; + filterExtractionCondition?: string | null; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */ - includeAncestorHeadings?: boolean | null; + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Related configurations applied to a specific type of document parser. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { - /** - * Configurations applied to digital parser. - */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { /** - * Configurations applied to layout parser. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + condition?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + pinUnexpandedResults?: boolean | null; } /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec { + /** + * The condition under which search as you type should occur. Default to Condition.DISABLED. + */ + condition?: string | null; + } /** - * The OCR parsing configurations for documents. + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */ - enhancedDocumentElements?: string[] | null; + queryId?: string | null; /** - * If true, will use native text instead of OCR text on pages containing native text. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */ - useNativeText?: boolean | null; + searchResultPersistenceCount?: number | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * The specification for query spell correction. */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - updateTime?: string | null; + mode?: string | null; } /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + * Verification information for target sites in advanced site search. */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { + /** + * Site verification state indicating the ownership and validity. + */ + siteVerificationState?: string | null; + /** + * Latest site verification time. + */ + verifyTime?: string | null; + } /** - * Metadata that describes the training and serving parameters of an Engine. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1Engine { + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * 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. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; + exactMatch?: boolean | null; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * Output only. Failure reason. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; + failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; /** - * Common config spec that specifies the metadata of the engine. + * Output only. This is system-generated based on the provided_uri_pattern. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + generatedUriPattern?: string | null; /** - * Output only. Timestamp the Recommendation Engine was created at. + * Output only. Indexing status. */ - createTime?: string | null; + indexingStatus?: string | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. */ - dataStoreIds?: string[] | null; + name?: string | null; /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - displayName?: string | null; + providedUriPattern?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Output only. Root domain of the provided_uri_pattern. */ - industryVertical?: string | null; + rootDomainUri?: string | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Output only. Site ownership and validity verification status. */ - name?: string | null; + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + type?: string | null; /** - * Required. The solutions of the engine. + * Output only. The target site's last updated time. */ - solutionType?: string | null; + updateTime?: string | null; + } + /** + * Site search indexing failure reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { /** - * Output only. Timestamp the Recommendation Engine was last updated. + * Failed due to insufficient quota. */ - updateTime?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; } /** - * Configurations for a Chat Engine. + * Failed due to insufficient quota. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { /** - * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + totalRequiredQuota?: string | null; + } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { /** - * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + * Operation create time. */ - dialogflowAgentToLink?: string | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * Echoes the destination for the complete errors in the request if set. */ - business?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + * A sample of errors encountered while processing the data. */ - defaultLanguageCode?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + * The metrics of the trained model. */ - location?: string | null; + metrics?: {[key: string]: number} | null; /** - * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + * Fully qualified name of the CustomTuningModel. */ - timeZone?: string | null; - } - /** - * Additional information of a Chat Engine. Fields in this message are output only. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + modelName?: string | null; /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */ - dialogflowAgent?: string | null; + modelStatus?: string | null; } /** - * Common configurations for an Engine. + * Metadata associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` */ - companyName?: string | null; + engine?: string | null; } /** - * Configurations for a Search Engine. + * Response associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { /** - * The add-on that this search engine enables. + * Operation create time. */ - searchAddOns?: string[] | null; + createTime?: string | null; /** - * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + * Operation last update time. If the operation is done, this is also the finish time. */ - searchTier?: string | null; + updateTime?: string | null; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. - */ - failureCount?: string | null; - /** - * Count of CompletionSuggestions successfully imported. - */ - successCount?: string | null; - /** - * Operation last update time. If the operation is done, this is also the finish time. + * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + * Information of an end user. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { /** - * The desired location of errors incurred during the Import. + * 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. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + userAgent?: string | null; /** - * A sample of errors encountered while processing the request. + * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - errorSamples?: Schema$GoogleRpcStatus[]; + userId?: string | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * Config to store data store type configuration for workspace data */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { - /** - * Operation create time. - */ - createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. - */ - successCount?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig { /** - * Total count of entries that were processed. + * Obfuscated Dasher customer ID. */ - totalCount?: string | null; + dasherCustomerId?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The Google Workspace data source. */ - updateTime?: string | null; + type?: string | null; } /** - * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + * Defines circumstances to be checked before allowing a behavior */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1Condition { /** - * Echoes the destination for the complete errors in the request if set. + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; /** - * A sample of errors encountered while processing the request. + * Search only A list of terms to match the query on. Maximum of 10 query terms. */ - errorSamples?: Schema$GoogleRpcStatus[]; + queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; } /** - * Configuration of destination for Import related errors. + * Matcher for search request query */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { /** - * 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. + * Whether the search query needs to exactly match the query term. */ - gcsPrefix?: string | null; + fullMatch?: boolean | null; + /** + * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + */ + value?: string | null; } /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Used for time-dependent conditions. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { /** - * Operation create time. + * End of time range. Range is inclusive. Must be in the future. */ - createTime?: string | null; + endTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Start of time range. Range is inclusive. */ - updateTime?: string | null; + startTime?: string | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1Control { /** - * Count of deny list entries that failed to be imported. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ - failedEntriesCount?: string | null; + associatedServingConfigIds?: string[] | null; /** - * Count of deny list entries successfully imported. + * Defines a boost-type control */ - importedEntriesCount?: string | null; - } - /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; /** - * Operation create time. + * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */ - createTime?: string | null; + conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; /** - * Count of entries that encountered errors while processing. + * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - failureCount?: string | null; + displayName?: string | null; /** - * Count of entries that were processed successfully. + * Defines a filter-type control Currently not supported by Recommendation */ - successCount?: string | null; + filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ - updateTime?: string | null; - } - /** - * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + name?: string | null; /** - * Echoes the destination for the complete errors if this field was set in the request. + * Defines a redirect-type control. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; /** - * A sample of errors encountered while processing the request. + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */ - errorSamples?: Schema$GoogleRpcStatus[]; + solutionType?: string | null; /** - * Count of user events imported with complete existing Documents. + * Treats a group of terms as synonyms of one another. */ - joinedEventsCount?: string | null; + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */ - unjoinedEventsCount?: string | null; + useCases?: string[] | null; } /** - * Metadata and configurations for a Google Cloud project in the service. + * Adjusts order of products in returned list. */ - export interface Schema$GoogleCloudDiscoveryengineV1Project { - /** - * Output only. The timestamp when this project is created. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ - name?: string | null; + boost?: number | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ - provisionCompletionTime?: string | null; + dataStore?: string | null; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; - } | null; + filter?: string | null; } /** - * Metadata about the terms of service. + * Specified which products may be included in results. Uses same filter as boost. */ - export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { - /** - * The last time when the project agreed to the terms of service. - */ - acceptTime?: string | null; - /** - * The last time when the project declined or revoked the agreement to terms of service. - */ - declineTime?: string | null; - /** - * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. - */ - id?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ - state?: string | null; + dataStore?: string | null; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - version?: string | null; + filter?: string | null; } /** - * Metadata associated with a project provision operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} - /** - * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + * Redirects a shopper to the provided URI. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - updateTime?: string | null; + redirectUri?: string | null; } /** - * Response message for CompletionService.PurgeCompletionSuggestions method. + * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { /** - * Whether the completion suggestions were successfully purged. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ - purgeSucceeded?: boolean | null; + synonyms?: string[] | null; } /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { /** * Operation create time. */ createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were ignored as entries were not found. - */ - ignoredCount?: string | null; - /** - * Count of entries that were deleted successfully. - */ - successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { /** - * The total count of documents purged as a result of the operation. + * Operation create time. */ - purgeCount?: string | null; + createTime?: string | null; /** - * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. + * Operation last update time. If the operation is done, this is also the finish time. */ - purgeSample?: string[] | null; + updateTime?: string | null; } /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata for Create Schema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { /** * Operation create time. */ @@ -6991,115 +7722,93 @@ export namespace discoveryengine_v1alpha { updateTime?: string | null; } /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { /** - * A sample of errors encountered while processing the request. + * Operation create time. */ - errorSamples?: Schema$GoogleRpcStatus[]; + createTime?: string | null; /** - * Number of suggestion deny list entries purged. + * Operation last update time. If the operation is done, this is also the finish time. */ - purgeCount?: string | null; + updateTime?: string | null; } /** - * Defines the structure and layout of a type of document data. + * DataStore captures global settings and configs at the DataStore level. */ - export interface Schema$GoogleCloudDiscoveryengineV1Schema { + export interface Schema$GoogleCloudDiscoveryengineV1DataStore { /** - * The JSON representation of the schema. + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ - jsonSchema?: string | null; - /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string | null; - /** - * The structured representation of the schema. - */ - structSchema?: {[key: string]: any} | null; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { - /** - * Site verification state indicating the ownership and validity. - */ - siteVerificationState?: string | null; + contentConfig?: string | null; /** - * Latest site verification time. + * Output only. Timestamp the DataStore was created at. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + createTime?: string | null; /** - * 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. + * Output only. The id of the default Schema asscociated to this data store. */ - exactMatch?: boolean | null; + defaultSchemaId?: string | null; /** - * Output only. Failure reason. + * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + displayName?: string | null; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * Configuration for Document understanding and enrichment. */ - generatedUriPattern?: string | null; + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; /** - * Output only. Indexing status. + * Immutable. The industry vertical that the data store registers. */ - indexingStatus?: string | null; + industryVertical?: string | null; /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ - providedUriPattern?: string | null; + solutionTypes?: string[] | null; /** - * Output only. Root domain of the provided_uri_pattern. + * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ - rootDomainUri?: string | null; + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; /** - * Output only. Site ownership and validity verification status. + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig; + } + /** + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * Operation create time. */ - type?: string | null; + createTime?: string | null; /** - * Output only. The target site's last updated time. + * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Site search indexing failure reasons. + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { /** - * Failed due to insufficient quota. + * Operation create time. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + createTime?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * Operation last update time. If the operation is done, this is also the finish time. */ - totalRequiredQuota?: string | null; + updateTime?: string | null; } /** - * Metadata for UpdateSchema LRO. + * Metadata for DeleteSchema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { /** * Operation create time. */ @@ -7110,9 +7819,9 @@ export namespace discoveryengine_v1alpha { updateTime?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { /** * Operation create time. */ @@ -7123,200 +7832,2790 @@ export namespace discoveryengine_v1alpha { updateTime?: string | null; } /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$GoogleLongrunningCancelOperationRequest {} - /** - * The response message for Operations.ListOperations. + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleLongrunningListOperationsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { /** - * The standard List next-page token. + * Operation create time. */ - nextPageToken?: string | null; + createTime?: string | null; /** - * A list of operations that matches the specified filter in the request. + * Operation last update time. If the operation is done, this is also the finish time. */ - operations?: Schema$GoogleLongrunningOperation[]; + updateTime?: string | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. */ - export interface Schema$GoogleLongrunningOperation { + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} + /** + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { /** - * 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. + * Whether chunking mode is enabled. */ - done?: boolean | null; + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; /** - * The error result of the operation in case of failure or cancellation. + * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */ - error?: Schema$GoogleRpcStatus; + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; /** - * 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. + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. */ - metadata?: {[key: string]: any} | null; + name?: string | null; /** - * 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\}`. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ - name?: string | null; + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + } | null; + } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { /** - * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * Configuration for the layout based chunking. */ - response?: {[key: string]: any} | null; + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; } /** - * A single strongly-typed value. + * Configuration for the layout based chunking. */ - export interface Schema$GoogleMonitoringV3TypedValue { + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { /** - * A Boolean value: `true` or `false`. + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */ - boolValue?: boolean | null; + chunkSize?: number | null; /** - * A distribution value. + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */ - distributionValue?: Schema$GoogleApiDistribution; + includeAncestorHeadings?: boolean | null; + } + /** + * Related configurations applied to a specific type of document parser. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { /** - * A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. + * Configurations applied to digital parser. */ - doubleValue?: number | null; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; /** - * A 64-bit integer. Its range is approximately ±9.2x1018. + * Configurations applied to layout parser. */ - int64Value?: string | null; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; /** - * A variable-length string value. + * Configurations applied to OCR parser. Currently it only applies to PDFs. */ - stringValue?: string | null; + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; } /** - * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} + * The digital parsing configurations for documents. */ - export interface Schema$GoogleProtobufEmpty {} + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * The layout parsing configurations for documents. */ - export interface Schema$GoogleRpcStatus { - /** - * The status code, which should be an enum value of google.rpc.Code. - */ - code?: number | null; + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */ - details?: Array<{[key: string]: any}> | null; + enhancedDocumentElements?: string[] | null; /** - * 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. + * If true, will use native text instead of OCR text on pages containing native text. */ - message?: string | null; + useNativeText?: boolean | null; } /** - * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleTypeDate { - /** - * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - */ - day?: number | null; + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { /** - * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + * Operation create time. */ - month?: number | null; + createTime?: string | null; /** - * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + * Operation last update time. If the operation is done, this is also the finish time. */ - year?: number | null; + updateTime?: string | null; } /** - * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. */ - export interface Schema$GoogleTypeExpr { + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Engine { /** - * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - description?: string | null; + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; /** - * Textual representation of an expression in Common Expression Language syntax. + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - expression?: string | null; + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; /** - * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Common config spec that specifies the metadata of the engine. */ - location?: string | null; + commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; /** - * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Output only. Timestamp the Recommendation Engine was created at. */ - title?: string | null; - } - - export class Resource$Projects { - context: APIRequestContext; - locations: Resource$Projects$Locations; - operations: Resource$Projects$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); - } - + createTime?: string | null; /** - * Gets a Project. Returns NOT_FOUND when the project is not yet created. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ - get( + dataStoreIds?: string[] | null; + /** + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + */ + displayName?: string | null; + /** + * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + */ + industryVertical?: string | null; + /** + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string | null; + /** + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + */ + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + /** + * Required. The solutions of the engine. + */ + solutionType?: string | null; + /** + * Output only. Timestamp the Recommendation Engine was last updated. + */ + updateTime?: string | null; + } + /** + * Configurations for a Chat Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { + /** + * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + /** + * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + */ + dialogflowAgentToLink?: string | null; + } + /** + * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + /** + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + */ + business?: string | null; + /** + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + */ + defaultLanguageCode?: string | null; + /** + * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + */ + location?: string | null; + /** + * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + */ + timeZone?: string | null; + } + /** + * Additional information of a Chat Engine. Fields in this message are output only. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + /** + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + */ + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + /** + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + */ + companyName?: string | null; + } + /** + * Configurations for a Search Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + /** + * The add-on that this search engine enables. + */ + searchAddOns?: string[] | null; + /** + * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + */ + searchTier?: string | null; + } + /** + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of CompletionSuggestions that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Total count of entries that were processed. + */ + totalCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Configuration of destination for Import related errors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + /** + * 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. + */ + gcsPrefix?: string | null; + } + /** + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.ImportSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of deny list entries that failed to be imported. + */ + failedEntriesCount?: string | null; + /** + * Count of deny list entries successfully imported. + */ + importedEntriesCount?: string | null; + } + /** + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + /** + * Echoes the destination for the complete errors if this field was set in the request. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of user events imported with complete existing Documents. + */ + joinedEventsCount?: string | null; + /** + * Count of user events imported, but with Document information not found in the existing Branch. + */ + unjoinedEventsCount?: string | null; + } + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The timestamp when this project is created. + */ + createTime?: string | null; + /** + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + */ + name?: string | null; + /** + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + */ + provisionCompletionTime?: string | null; + /** + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + */ + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; + } | null; + } + /** + * Metadata about the terms of service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { + /** + * The last time when the project agreed to the terms of service. + */ + acceptTime?: string | null; + /** + * The last time when the project declined or revoked the agreement to terms of service. + */ + declineTime?: string | null; + /** + * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. + */ + id?: string | null; + /** + * Whether the project has accepted/rejected the service terms or it is still pending. + */ + state?: string | null; + /** + * The version string of the terms of service. For acceptable values, see the comments for id above. + */ + version?: string | null; + } + /** + * Metadata associated with a project provision operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} + /** + * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeCompletionSuggestions method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Whether the completion suggestions were successfully purged. + */ + purgeSucceeded?: boolean | null; + } + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were ignored as entries were not found. + */ + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + /** + * The total count of documents purged as a result of the operation. + */ + purgeCount?: string | null; + /** + * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. + */ + purgeSample?: string[] | null; + } + /** + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Number of suggestion deny list entries purged. + */ + purgeCount?: string | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Schema { + /** + * The JSON representation of the schema. + */ + jsonSchema?: string | null; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The structured representation of the schema. + */ + structSchema?: {[key: string]: any} | null; + } + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + /** + * Site verification state indicating the ownership and validity. + */ + siteVerificationState?: string | null; + /** + * Latest site verification time. + */ + verifyTime?: string | null; + } + /** + * A target site for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + /** + * 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?: boolean | null; + /** + * Output only. Failure reason. + */ + failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + /** + * Output only. This is system-generated based on the provided_uri_pattern. + */ + generatedUriPattern?: string | null; + /** + * Output only. Indexing status. + */ + indexingStatus?: string | null; + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string | null; + /** + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + */ + providedUriPattern?: string | null; + /** + * Output only. Root domain of the provided_uri_pattern. + */ + rootDomainUri?: string | null; + /** + * Output only. Site ownership and validity verification status. + */ + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + /** + * The type of the target site, e.g., whether the site is to be included or excluded. + */ + type?: string | null; + /** + * Output only. The target site's last updated time. + */ + updateTime?: string | null; + } + /** + * Site search indexing failure reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + /** + * Failed due to insufficient quota. + */ + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + /** + * This number is an estimation on how much total quota this project needs to successfully complete indexing. + */ + totalRequiredQuota?: string | null; + } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; + } + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$GoogleLongrunningCancelOperationRequest {} + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * 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?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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?: {[key: string]: any} | null; + /** + * 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 | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * A single strongly-typed value. + */ + export interface Schema$GoogleMonitoringV3TypedValue { + /** + * A Boolean value: `true` or `false`. + */ + boolValue?: boolean | null; + /** + * A distribution value. + */ + distributionValue?: Schema$GoogleApiDistribution; + /** + * A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. + */ + doubleValue?: number | null; + /** + * A 64-bit integer. Its range is approximately ±9.2x1018. + */ + int64Value?: string | null; + /** + * A variable-length string value. + */ + stringValue?: string | null; + } + /** + * 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); \} + */ + export interface Schema$GoogleProtobufEmpty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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 | null; + } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$GoogleTypeExpr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + + /** + * Gets a Project. Returns NOT_FOUND when the project is not yet created. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( params: Params$Resource$Projects$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions + ): GaxiosPromise; + provision( + params?: Params$Resource$Projects$Provision, + options?: MethodOptions + ): GaxiosPromise; + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + callback: BodyResponseCallback + ): void; + provision( + callback: BodyResponseCallback + ): void; + provision( + paramsOrCallback?: + | Params$Resource$Projects$Provision + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Provision; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Provision; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:provision').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms) + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + options: StreamMethodOptions + ): GaxiosPromise; + reportConsentChange( + params?: Params$Resource$Projects$Reportconsentchange, + options?: MethodOptions + ): GaxiosPromise; + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + reportConsentChange( + params: Params$Resource$Projects$Reportconsentchange, + callback: BodyResponseCallback + ): void; + reportConsentChange( + callback: BodyResponseCallback + ): void; + reportConsentChange( + paramsOrCallback?: + | Params$Resource$Projects$Reportconsentchange + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Reportconsentchange; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Reportconsentchange; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+project}:reportConsentChange').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Get extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Provision + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest; + } + export interface Params$Resource$Projects$Reportconsentchange + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + project?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + collections: Resource$Projects$Locations$Collections; + dataStores: Resource$Projects$Locations$Datastores; + evaluations: Resource$Projects$Locations$Evaluations; + groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + identity_mapping_stores: Resource$Projects$Locations$Identity_mapping_stores; + operations: Resource$Projects$Locations$Operations; + rankingConfigs: Resource$Projects$Locations$Rankingconfigs; + requirements: Resource$Projects$Locations$Requirements; + sampleQuerySets: Resource$Projects$Locations$Samplequerysets; + userEvents: Resource$Projects$Locations$Userevents; + userStores: Resource$Projects$Locations$Userstores; + constructor(context: APIRequestContext) { + this.context = context; + this.collections = new Resource$Projects$Locations$Collections( + this.context + ); + this.dataStores = new Resource$Projects$Locations$Datastores( + this.context + ); + this.evaluations = new Resource$Projects$Locations$Evaluations( + this.context + ); + this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( + this.context + ); + this.identity_mapping_stores = + new Resource$Projects$Locations$Identity_mapping_stores(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( + this.context + ); + this.requirements = new Resource$Projects$Locations$Requirements( + this.context + ); + this.sampleQuerySets = new Resource$Projects$Locations$Samplequerysets( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Userevents( + this.context + ); + this.userStores = new Resource$Projects$Locations$Userstores( + this.context + ); + } + + /** + * Estimates the data size to be used by a customer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + options: StreamMethodOptions + ): GaxiosPromise; + estimateDataSize( + params?: Params$Resource$Projects$Locations$Estimatedatasize, + options?: MethodOptions + ): GaxiosPromise; + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + estimateDataSize( + params: Params$Resource$Projects$Locations$Estimatedatasize, + callback: BodyResponseCallback + ): void; + estimateDataSize( + callback: BodyResponseCallback + ): void; + estimateDataSize( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Estimatedatasize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Estimatedatasize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Estimatedatasize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+location}:estimateDataSize').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['location'], + pathParams: ['location'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the AclConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getAclConfig( + params?: Params$Resource$Projects$Locations$Getaclconfig, + options?: MethodOptions + ): GaxiosPromise; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAclConfig( + params: Params$Resource$Projects$Locations$Getaclconfig, + callback: BodyResponseCallback + ): void; + getAclConfig( + callback: BodyResponseCallback + ): void; + getAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Default ACL configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateAclConfig( + params?: Params$Resource$Projects$Locations$Updateaclconfig, + options?: MethodOptions + ): GaxiosPromise; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAclConfig( + params: Params$Resource$Projects$Locations$Updateaclconfig, + callback: BodyResponseCallback + ): void; + updateAclConfig( + callback: BodyResponseCallback + ): void; + updateAclConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updateaclconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updateaclconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Estimatedatasize + extends StandardParameters { + /** + * Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`. + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest; + } + export interface Params$Resource$Projects$Locations$Getaclconfig + extends StandardParameters { + /** + * Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Updateaclconfig + extends StandardParameters { + /** + * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig; + } + + export class Resource$Projects$Locations$Collections { + context: APIRequestContext; + dataConnector: Resource$Projects$Locations$Collections$Dataconnector; + dataStores: Resource$Projects$Locations$Collections$Datastores; + engines: Resource$Projects$Locations$Collections$Engines; + operations: Resource$Projects$Locations$Collections$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dataConnector = + new Resource$Projects$Locations$Collections$Dataconnector(this.context); + this.dataStores = new Resource$Projects$Locations$Collections$Datastores( + this.context + ); + this.engines = new Resource$Projects$Locations$Collections$Engines( + this.context + ); + this.operations = new Resource$Projects$Locations$Collections$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Dataconnector$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Collections$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Collections$Datastores$Controls; + conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; + customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; + models: Resource$Projects$Locations$Collections$Datastores$Models; + operations: Resource$Projects$Locations$Collections$Datastores$Operations; + schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = + new Resource$Projects$Locations$Collections$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( + this.context + ); + this.controls = + new Resource$Projects$Locations$Collections$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Datastores$Conversations( + this.context + ); + this.customModels = + new Resource$Projects$Locations$Collections$Datastores$Custommodels( + this.context + ); + this.models = + new Resource$Projects$Locations$Collections$Datastores$Models( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Operations( + this.context + ); + this.schemas = + new Resource$Projects$Locations$Collections$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = + new Resource$Projects$Locations$Collections$Datastores$Userevents( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions + ): GaxiosPromise; + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options?: MethodOptions + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + callback: BodyResponseCallback + ): void; + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Completequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a DocumentProcessingConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options?: MethodOptions + ): GaxiosPromise; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + callback: BodyResponseCallback + ): void; + getDocumentProcessingConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the SiteSearchEngine. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: StreamMethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options?: MethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all the DataStores associated with the project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a DataStore + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Trains a custom model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions + ): GaxiosPromise; + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options?: MethodOptions + ): GaxiosPromise; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + callback: BodyResponseCallback + ): void; + trainCustomModel( + callback: BodyResponseCallback + ): void; + trainCustomModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+dataStore}:trainCustomModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Get, + updateDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Get, + ): GaxiosPromise; + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Get, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Get, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + updateDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - get( + updateDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Projects$Get; + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Get; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; options = {}; } @@ -7331,7 +10630,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -7342,76 +10641,233 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); - } else { - return createAPIRequest( - parameters + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery + extends StandardParameters { + /** + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + */ + dataStore?: string; + /** + * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + */ + queryModel?: string; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + extends StandardParameters { + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Get + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig + extends StandardParameters { + /** + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig + extends StandardParameters { + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string; + /** + * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( + this.context ); - } } /** - * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. + * Gets index freshness metadata for Documents. Supported for website search only. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - provision( - params: Params$Resource$Projects$Provision, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions ): GaxiosPromise; - provision( - params?: Params$Resource$Projects$Provision, + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options?: MethodOptions - ): GaxiosPromise; - provision( - params: Params$Resource$Projects$Provision, + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, - callback: BodyResponseCallback + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback ): void; - provision( - callback: BodyResponseCallback + batchGetDocumentsMetadata( + callback: BodyResponseCallback ): void; - provision( + batchGetDocumentsMetadata( paramsOrCallback?: - | Params$Resource$Projects$Provision - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Provision; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Provision; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; options = {}; } @@ -7425,89 +10881,115 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:provision').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1alpha/{+parent}/batchGetDocumentsMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { /** - * Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms) + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( + this.context + ); + } + + /** + * Creates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; - reportConsentChange( - params?: Params$Resource$Projects$Reportconsentchange, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - reportConsentChange( - params: Params$Resource$Projects$Reportconsentchange, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - reportConsentChange( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - reportConsentChange( + create( paramsOrCallback?: - | Params$Resource$Projects$Reportconsentchange - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Reportconsentchange; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Reportconsentchange; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; options = {}; } @@ -7521,7 +11003,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+project}:reportConsentChange').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -7531,155 +11013,78 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['project'], - pathParams: ['project'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Get extends StandardParameters { - /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Provision - extends StandardParameters { - /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaProvisionProjectRequest; - } - export interface Params$Resource$Projects$Reportconsentchange - extends StandardParameters { - /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. - */ - project?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaReportConsentChangeRequest; - } - - export class Resource$Projects$Locations { - context: APIRequestContext; - collections: Resource$Projects$Locations$Collections; - dataStores: Resource$Projects$Locations$Datastores; - evaluations: Resource$Projects$Locations$Evaluations; - groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - operations: Resource$Projects$Locations$Operations; - rankingConfigs: Resource$Projects$Locations$Rankingconfigs; - requirements: Resource$Projects$Locations$Requirements; - sampleQuerySets: Resource$Projects$Locations$Samplequerysets; - userEvents: Resource$Projects$Locations$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.collections = new Resource$Projects$Locations$Collections( - this.context - ); - this.dataStores = new Resource$Projects$Locations$Datastores( - this.context - ); - this.evaluations = new Resource$Projects$Locations$Evaluations( - this.context - ); - this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( - this.context - ); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( - this.context - ); - this.requirements = new Resource$Projects$Locations$Requirements( - this.context - ); - this.sampleQuerySets = new Resource$Projects$Locations$Samplequerysets( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Userevents( - this.context - ); - } /** - * Estimates the data size to be used by a customer. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; - estimateDataSize( - params?: Params$Resource$Projects$Locations$Estimatedatasize, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): GaxiosPromise; - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - estimateDataSize( - params: Params$Resource$Projects$Locations$Estimatedatasize, - callback: BodyResponseCallback - ): void; - estimateDataSize( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - estimateDataSize( + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Estimatedatasize - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Estimatedatasize; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Estimatedatasize; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; options = {}; } @@ -7693,89 +11098,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+location}:estimateDataSize').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the AclConfig. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; - getAclConfig( - params?: Params$Resource$Projects$Locations$Getaclconfig, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAclConfig( - params: Params$Resource$Projects$Locations$Getaclconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; - getAclConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getAclConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Getaclconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Getaclconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Getaclconfig; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; options = {}; } @@ -7801,76 +11204,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Default Acl Configuration for use in a location of a customer's project. Updates will only reflect to new data stores. Existing data stores will still use the old value. + * Gets the parsed layout information for a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions ): GaxiosPromise; - updateAclConfig( - params?: Params$Resource$Projects$Locations$Updateaclconfig, + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions - ): GaxiosPromise; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + ): GaxiosPromise; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateAclConfig( - params: Params$Resource$Projects$Locations$Updateaclconfig, - callback: BodyResponseCallback + getProcessedDocument( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback ): void; - updateAclConfig( - callback: BodyResponseCallback + getProcessedDocument( + callback: BodyResponseCallback ): void; - updateAclConfig( + getProcessedDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Updateaclconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Updateaclconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Updateaclconfig; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; options = {}; } @@ -7884,8 +11288,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -7896,128 +11303,55 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Estimatedatasize - extends StandardParameters { - /** - * Required. Full resource name of the location, such as `projects/{project\}/locations/{location\}`. - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEstimateDataSizeRequest; - } - export interface Params$Resource$Projects$Locations$Getaclconfig - extends StandardParameters { - /** - * Required. Resource name of AclConfig, such as `projects/x/locations/x/aclConfig`. If the caller does not have permission to access the AclConfig, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Updateaclconfig - extends StandardParameters { - /** - * Immutable. The full resource name of the acl configuration. Format: `projects/{project\}/locations/{location\}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAclConfig; - } - - export class Resource$Projects$Locations$Collections { - context: APIRequestContext; - dataConnector: Resource$Projects$Locations$Collections$Dataconnector; - dataStores: Resource$Projects$Locations$Collections$Datastores; - engines: Resource$Projects$Locations$Collections$Engines; - operations: Resource$Projects$Locations$Collections$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.dataConnector = - new Resource$Projects$Locations$Collections$Dataconnector(this.context); - this.dataStores = new Resource$Projects$Locations$Collections$Datastores( - this.context - ); - this.engines = new Resource$Projects$Locations$Collections$Engines( - this.context - ); - this.operations = new Resource$Projects$Locations$Collections$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Dataconnector { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Dataconnector$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Dataconnector$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, callback: BodyResponseCallback ): void; - get( + import( callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8033,13 +11367,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; options = {}; } @@ -8053,15 +11387,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -8075,7 +11412,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a list of Documents. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8083,57 +11420,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; options = {}; } @@ -8147,7 +11484,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -8157,181 +11494,178 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; /** - * The standard list page token. + * Updates a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; - } + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Collections$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Collections$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Collections$Datastores$Controls; - conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; - customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; - models: Resource$Projects$Locations$Collections$Datastores$Models; - operations: Resource$Projects$Locations$Collections$Datastores$Operations; - schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = - new Resource$Projects$Locations$Collections$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( - this.context - ); - this.controls = - new Resource$Projects$Locations$Collections$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Datastores$Conversations( - this.context - ); - this.customModels = - new Resource$Projects$Locations$Collections$Datastores$Custommodels( - this.context - ); - this.models = - new Resource$Projects$Locations$Collections$Datastores$Models( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Operations( - this.context - ); - this.schemas = - new Resource$Projects$Locations$Collections$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( - this.context + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.userEvents = - new Resource$Projects$Locations$Collections$Datastores$Userevents( - this.context + } else { + return createAPIRequest( + parameters ); + } } /** - * Completes the specified user input with keyword suggestions. + * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - completeQuery( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; options = {}; } @@ -8345,92 +11679,202 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( + url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + extends StandardParameters { /** - * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * 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. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; options = {}; } @@ -8444,90 +11888,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a DataStore. + * Gets a list of Chunks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; options = {}; } @@ -8541,87 +11984,118 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get + extends StandardParameters { /** - * Gets a DataStore. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { + /** + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + cancel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; options = {}; } @@ -8635,8 +12109,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -8647,77 +12124,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a DocumentProcessingConfig. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - getDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; options = {}; } @@ -8743,77 +12218,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the SiteSearchEngine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; options = {}; } @@ -8827,7 +12300,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -8839,77 +12315,123 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + extends StandardParameters { /** - * Lists all the DataStores associated with the project. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - list( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; options = {}; } @@ -8923,11 +12445,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -8938,77 +12459,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a DataStore + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - patch( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; options = {}; } @@ -9022,89 +12541,121 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + extends StandardParameters { /** - * Trains a custom model. + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - trainCustomModel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - trainCustomModel( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - trainCustomModel( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; options = {}; } @@ -9118,7 +12669,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:trainCustomModel').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -9128,80 +12679,78 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - updateDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; options = {}; } @@ -9216,7 +12765,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -9227,241 +12776,171 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. - */ - queryModel?: string; - /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Create - extends StandardParameters { - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getdocumentprocessingconfig - extends StandardParameters { - /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch - extends StandardParameters { - /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - extends StandardParameters { - /** - * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + * Gets a Control. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - dataStore?: string; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Updatedocumentprocessingconfig - extends StandardParameters { - /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - */ - name?: string; - /** - * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - */ - updateMask?: string; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + options = {}; + } - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } - export class Resource$Projects$Locations$Collections$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( - this.context + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { - context: APIRequestContext; - chunks: Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks; - constructor(context: APIRequestContext) { - this.context = context; - this.chunks = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks( - this.context + } else { + return createAPIRequest( + parameters ); + } } /** - * Creates a Document. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; options = {}; } @@ -9475,11 +12954,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -9490,167 +12969,246 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Document. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + extends StandardParameters { + /** + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Collections$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets a Document. + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + converse( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - get( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; options = {}; } @@ -9664,8 +13222,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -9676,77 +13237,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the parsed layout information for a Document. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - getProcessedDocument( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - getProcessedDocument( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - getProcessedDocument( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; options = {}; } @@ -9760,92 +13321,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; options = {}; } @@ -9859,90 +13416,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; options = {}; } @@ -9956,92 +13510,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; options = {}; } @@ -10055,89 +13606,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; options = {}; } @@ -10151,202 +13705,174 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - documentId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ - parent?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Getprocesseddocument + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; - /** - * What format output should be. If unspecified, defaults to JSON. - */ - processedDocumentFormat?: string; - /** - * Required. What type of processing to return. - */ - processedDocumentType?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List extends StandardParameters { /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ - parent?: string; - + filter?: string; /** - * Request body metadata + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * 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. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters { /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - extends StandardParameters { + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */ - parent?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; } - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks { + export class Resource$Projects$Locations$Collections$Datastores$Custommodels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Document. + * Gets a list of all the custom models. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; options = {}; } @@ -10360,89 +13886,119 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+dataStore}/customModels').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + extends StandardParameters { /** - * Gets a list of Chunks. + * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. + */ + dataStore?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Models$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; options = {}; } @@ -10456,118 +14012,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$Get - extends StandardParameters { - /** - * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Chunks$List - extends StandardParameters { - /** - * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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`. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; options = {}; } @@ -10581,11 +14106,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -10596,14 +14121,50 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * 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. @@ -10614,27 +14175,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -10642,7 +14203,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10658,13 +14219,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; options = {}; } @@ -10708,27 +14269,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, callback: BodyResponseCallback ): void; list( @@ -10736,7 +14297,7 @@ export namespace discoveryengine_v1alpha { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -10752,13 +14313,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; options = {}; } @@ -10799,26 +14360,14 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List extends StandardParameters { /** * The standard list filter. @@ -10838,72 +14387,268 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Collections$Datastores$Schemas { context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + this.context + ); + } + + /** + * Creates a Schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Schema. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Imports CompletionSuggestions for a DataStore. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; options = {}; } @@ -10917,89 +14662,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; options = {}; } @@ -11013,10 +14758,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -11027,107 +14773,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; options = {}; } @@ -11141,88 +14857,156 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + extends StandardParameters { /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + extends StandardParameters { + /** + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + } + + export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; options = {}; } @@ -11237,7 +15021,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -11248,75 +15032,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Control. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; options = {}; } @@ -11330,7 +15114,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -11342,77 +15129,111 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists all Controls by their parent DataStore. + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + answer( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - list( + answer( + callback: BodyResponseCallback + ): void; + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; options = {}; } @@ -11426,92 +15247,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -11526,7 +15347,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -11537,150 +15358,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - - export class Resource$Projects$Locations$Collections$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - converse( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -11694,92 +15442,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; options = {}; } @@ -11793,88 +15541,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + recommend( + callback: BodyResponseCallback + ): void; + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; options = {}; } @@ -11888,87 +15637,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - get( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; options = {}; } @@ -11977,94 +15731,184 @@ export namespace discoveryengine_v1alpha { options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( + this.context ); - } } /** - * Lists all Conversations by their parent DataStore. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; options = {}; } @@ -12078,11 +15922,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -12093,77 +15937,73 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; options = {}; } @@ -12178,7 +16018,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -12189,104 +16029,113 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + * Gets a Session. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - updateMask?: string; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + options = {}; + } - export class Resource$Projects$Locations$Collections$Datastores$Custommodels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Gets a list of all the custom models. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12294,57 +16143,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; options = {}; } @@ -12358,7 +16207,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}/customModels').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -12368,203 +16217,251 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - extends StandardParameters { - /** - * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. - */ - dataStore?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; options = {}; } @@ -12578,10 +16475,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -12593,89 +16487,80 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); } /** - * 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. + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, callback: BodyResponseCallback ): void; - get( + batchVerifyTargetSites( callback: BodyResponseCallback ): void; - get( + batchVerifyTargetSites( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12691,13 +16576,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; options = {}; } @@ -12711,15 +16596,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -12733,65 +16620,65 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + ): GaxiosPromise; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, - callback: BodyResponseCallback + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + disableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - list( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -12803,111 +16690,69 @@ export namespace discoveryengine_v1alpha { const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/'; const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Schemas { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( - this.context - ); - } /** - * Creates a Schema. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback ): void; - create( + enableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - create( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12923,13 +16768,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -12943,18 +16788,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -12968,65 +16812,65 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a Schema. + * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + fetchDomainVerificationStatus( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + ): GaxiosPromise; + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - callback: BodyResponseCallback + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + fetchDomainVerificationStatus( + callback: BodyResponseCallback ): void; - delete( + fetchDomainVerificationStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; options = {}; } @@ -13040,87 +16884,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + + '/v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Schema. + * Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + getUriPatternDocumentData( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + ): GaxiosPromise; + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, - callback: BodyResponseCallback + getUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getUriPatternDocumentData( + callback: BodyResponseCallback ): void; - get( + getUriPatternDocumentData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata; options = {}; } @@ -13134,89 +16983,91 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:getUriPatternDocumentData' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Schemas. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + recrawlUris( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - list( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -13230,70 +17081,68 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + setUriPatternDocumentData( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + setUriPatternDocumentData( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata, callback: BodyResponseCallback ): void; - patch( + setUriPatternDocumentData( callback: BodyResponseCallback ): void; - patch( + setUriPatternDocumentData( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13309,13 +17158,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata; options = {}; } @@ -13329,15 +17178,17 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:setUriPatternDocumentData' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -13351,69 +17202,90 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites extends StandardParameters { /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters { /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - name?: string; + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters { /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - name?: string; + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus extends StandardParameters { /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */ pageSize?: number; /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. */ pageToken?: string; /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - parent?: string; + siteSearchEngine?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Geturipatterndocumentdata extends StandardParameters { /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - allowMissing?: boolean; + siteSearchEngine?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - name?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Seturipatterndocumentdata + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; - export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -13428,27 +17300,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -13456,7 +17328,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13472,13 +17344,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; options = {}; } @@ -13522,190 +17394,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Answer query method. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - options: StreamMethodOptions - ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - answer( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; options = {}; } @@ -13719,92 +17458,131 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + extends StandardParameters { /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( + this.context + ); + } + + /** + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + batchCreate( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - get( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -13818,89 +17596,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -13914,11 +17692,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -13929,77 +17707,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - patch( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -14014,7 +17790,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -14025,77 +17801,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Makes a recommendation, which requires a contextual user event. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - recommend( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -14109,92 +17883,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - search( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -14208,179 +17979,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - extends StandardParameters { - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sessions { - context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; - constructor(context: APIRequestContext) { - this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( - this.context - ); - } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -14394,88 +18078,160 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; options = {}; } @@ -14490,7 +18246,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -14501,75 +18257,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; options = {}; } @@ -14583,7 +18339,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -14595,77 +18354,111 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists all Sessions by their parent DataStore. + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - list( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -14679,11 +18472,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -14694,77 +18486,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - patch( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -14778,162 +18568,117 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; } - export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { + export class Resource$Projects$Locations$Collections$Datastores$Userevents { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Answer. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + collect( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - get( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; options = {}; } @@ -14947,92 +18692,68 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + import( callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15048,13 +18769,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -15068,9 +18789,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}:batchVerifyTargetSites' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -15092,43 +18814,43 @@ export namespace discoveryengine_v1alpha { } /** - * Downgrade from advanced site search to basic site search. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + purge( callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15144,13 +18866,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; options = {}; } @@ -15164,17 +18886,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -15188,161 +18911,256 @@ export namespace discoveryengine_v1alpha { } /** - * Upgrade from basic site search to advanced site search. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + write( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + extends StandardParameters { + /** + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * 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. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + extends StandardParameters { + /** + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Projects$Locations$Collections$Engines { + context: APIRequestContext; + controls: Resource$Projects$Locations$Collections$Engines$Controls; + conversations: Resource$Projects$Locations$Collections$Engines$Conversations; + operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Engines$Sessions; + constructor(context: APIRequestContext) { + this.context = context; + this.controls = + new Resource$Projects$Locations$Collections$Engines$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Engines$Conversations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Engines$Operations( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Engines$Sessions( + this.context ); - } else { - return createAPIRequest(parameters); - } } /** - * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. + * Creates a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions ): GaxiosPromise; - fetchDomainVerificationStatus( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions - ): GaxiosPromise; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {} as Params$Resource$Projects$Locations$Collections$Engines$Create; options = {}; } @@ -15356,70 +19174,68 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1alpha/{+siteSearchEngine}:fetchDomainVerificationStatus' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/engines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Request on-demand recrawl for a list of URIs. + * Deletes a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, callback: BodyResponseCallback ): void; - recrawlUris( + delete( callback: BodyResponseCallback ): void; - recrawlUris( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Collections$Engines$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15435,13 +19251,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; options = {}; } @@ -15455,103 +19271,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchVerifyTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * 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. + * Gets a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15559,57 +19301,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Get; options = {}; } @@ -15635,17 +19377,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all the Engines associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15653,57 +19397,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$List; options = {}; } @@ -15717,7 +19461,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), @@ -15727,121 +19471,178 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. + * Updates an Engine + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - pageToken?: string; - } + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( - this.context + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Creates TargetSite in a batch. + * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + pause( + params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + pause( + callback: BodyResponseCallback ): void; - batchCreate( + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; options = {}; } @@ -15855,89 +19656,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a TargetSite. + * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + resume( + params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + ): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - create( + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; options = {}; } @@ -15951,7 +19755,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+name}:resume').replace( /([^:]\/)\/+/g, '$1' ), @@ -15961,58 +19765,60 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a TargetSite. + * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + tune( + params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback ): void; - delete( + tune( callback: BodyResponseCallback ): void; - delete( + tune( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | Params$Resource$Projects$Locations$Collections$Engines$Tune | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -16028,13 +19834,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; options = {}; } @@ -16048,8 +19854,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}:tune').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -16068,67 +19877,176 @@ export namespace discoveryengine_v1alpha { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Create + extends StandardParameters { /** - * Gets a TargetSite. + * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + engineId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Delete + extends StandardParameters { + /** + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Get + extends StandardParameters { + /** + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$List + extends StandardParameters { + /** + * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + */ + filter?: string; + /** + * Optional. Not supported. + */ + pageSize?: number; + /** + * Optional. Not supported. + */ + pageToken?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Patch + extends StandardParameters { + /** + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string; + /** + * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Pause + extends StandardParameters { + /** + * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Resume + extends StandardParameters { + /** + * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Tune + extends StandardParameters { + /** + * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest; + } + + export class Resource$Projects$Locations$Collections$Engines$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; options = {}; } @@ -16142,89 +20060,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of TargetSites. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; options = {}; } @@ -16238,92 +20155,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TargetSite. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; options = {}; } @@ -16338,7 +20250,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -16349,148 +20261,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; options = {}; } @@ -16504,87 +20345,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; options = {}; } @@ -16598,11 +20444,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -16613,111 +20456,249 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create extends StandardParameters { /** - * The name of the operation resource. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */ - name?: string; + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete extends StandardParameters { /** - * The standard list filter. + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ - filter?: string; + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + extends StandardParameters { /** - * The name of the operation's parent resource. + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + extends StandardParameters { /** - * The standard list page size. + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * The standard list page token. + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */ pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; - export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + + export class Resource$Projects$Locations$Collections$Engines$Conversations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Converses a conversation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options: StreamMethodOptions + ): GaxiosPromise; + converse( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options?: MethodOptions + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + callback: BodyResponseCallback + ): void; + converse( + callback: BodyResponseCallback + ): void; + converse( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; options = {}; } @@ -16731,9 +20712,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -16745,75 +20727,73 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + callback: BodyResponseCallback ): void; - purge( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; options = {}; } @@ -16827,117 +20807,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; options = {}; } @@ -16951,90 +20901,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. - */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + */ + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; options = {}; } @@ -17048,11 +20997,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -17063,75 +21012,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; options = {}; } @@ -17145,90 +21096,174 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + extends StandardParameters { /** - * Writes a single user event. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + + export class Resource$Projects$Locations$Collections$Engines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - write( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; options = {}; } @@ -17242,184 +21277,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * 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. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge - extends StandardParameters { - /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; - } - - export class Resource$Projects$Locations$Collections$Engines { - context: APIRequestContext; - controls: Resource$Projects$Locations$Collections$Engines$Controls; - conversations: Resource$Projects$Locations$Collections$Engines$Conversations; - operations: Resource$Projects$Locations$Collections$Engines$Operations; - servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Engines$Sessions; - constructor(context: APIRequestContext) { - this.context = context; - this.controls = - new Resource$Projects$Locations$Collections$Engines$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Engines$Conversations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Engines$Operations( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Engines$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Engines$Sessions( - this.context - ); - } /** - * Creates a Engine. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; options = {}; } @@ -17433,90 +21371,126 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/engines').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + extends StandardParameters { /** - * Deletes a Engine. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - delete( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; options = {}; } @@ -17530,29 +21504,34 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Engine. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17560,57 +21539,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; options = {}; } @@ -17636,19 +21615,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the Engines associated with the project. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17656,57 +21635,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; options = {}; } @@ -17720,7 +21699,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/engines').replace( + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), @@ -17735,19 +21714,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Engine + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17755,57 +21734,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; options = {}; } @@ -17831,176 +21810,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - options: StreamMethodOptions - ): GaxiosPromise; - pause( - params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, - options?: MethodOptions - ): GaxiosPromise; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - callback: BodyResponseCallback - ): void; - pause( - callback: BodyResponseCallback - ): void; - pause( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Pause - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}:pause').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - resume( - params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - resume( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - resume( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; options = {}; } @@ -18014,7 +21894,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:resume').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), @@ -18024,82 +21904,82 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - tune( - params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - tune( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - tune( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Tune - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; options = {}; } @@ -18113,7 +21993,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:tune').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( /([^:]\/)\/+/g, '$1' ), @@ -18123,131 +22003,111 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Create + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer extends StandardParameters { /** - * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - engineId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - parent?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Delete - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters { /** - * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH - */ - filter?: string; - /** - * Optional. Not supported. + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */ pageSize?: number; /** - * Optional. Not supported. + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** - * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Pause - extends StandardParameters { - /** - * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPauseEngineRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Resume + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend extends StandardParameters { /** - * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */ - name?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaResumeEngineRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Tune + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search extends StandardParameters { /** - * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - name?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; } - export class Resource$Projects$Locations$Collections$Engines$Controls { + export class Resource$Projects$Locations$Collections$Engines$Sessions { context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.context + ); } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18255,57 +22115,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; options = {}; } @@ -18319,7 +22179,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -18334,19 +22194,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18354,31 +22214,31 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18394,13 +22254,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; options = {}; } @@ -18436,7 +22296,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Control. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18444,57 +22304,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; options = {}; } @@ -18520,19 +22380,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18540,57 +22400,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; options = {}; } @@ -18604,7 +22464,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -18619,19 +22479,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18639,57 +22499,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; options = {}; } @@ -18715,249 +22575,150 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters { /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string; /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; - } - - export class Resource$Projects$Locations$Collections$Engines$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Converses a conversation. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options: StreamMethodOptions - ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - callback: BodyResponseCallback - ): void; - converse( - callback: BodyResponseCallback - ): void; - converse( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; options = {}; } @@ -18971,88 +22732,104 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + extends StandardParameters { /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + get( + params?: Params$Resource$Projects$Locations$Collections$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Operations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Operations$Get; options = {}; } @@ -19067,7 +22844,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -19078,75 +22855,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Conversation. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + list( + params?: Params$Resource$Projects$Locations$Collections$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Operations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Operations$List; options = {}; } @@ -19160,7 +22937,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -19172,77 +22952,160 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); - } else { - return createAPIRequest( - parameters + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Datastores$Controls; + conversations: Resource$Projects$Locations$Datastores$Conversations; + models: Resource$Projects$Locations$Datastores$Models; + operations: Resource$Projects$Locations$Datastores$Operations; + schemas: Resource$Projects$Locations$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Datastores$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = new Resource$Projects$Locations$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Datastores$Completionsuggestions( + this.context + ); + this.controls = new Resource$Projects$Locations$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Datastores$Conversations(this.context); + this.models = new Resource$Projects$Locations$Datastores$Models( + this.context + ); + this.operations = new Resource$Projects$Locations$Datastores$Operations( + this.context + ); + this.schemas = new Resource$Projects$Locations$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); + this.sessions = new Resource$Projects$Locations$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Datastores$Sitesearchengine( + this.context ); - } + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( + this.context + ); } /** - * Lists all Conversations by their parent DataStore. + * Completes the specified user input with keyword suggestions. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completequery, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + completeQuery( + callback: BodyResponseCallback ): void; - list( + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Completequery; options = {}; } @@ -19256,7 +23119,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( /([^:]\/)\/+/g, '$1' ), @@ -19266,82 +23129,81 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Create, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + params = {} as Params$Resource$Projects$Locations$Datastores$Create; options = {}; } @@ -19355,152 +23217,68 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; - } - - export class Resource$Projects$Locations$Collections$Engines$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * 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. + * Deletes a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, callback: BodyResponseCallback ): void; - get( + delete( callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19516,13 +23294,12 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Datastores$Delete; options = {}; } @@ -19537,7 +23314,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -19558,65 +23335,64 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + params = {} as Params$Resource$Projects$Locations$Datastores$Get; options = {}; } @@ -19630,10 +23406,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -19645,111 +23418,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Gets a DocumentProcessingConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + getDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + ): GaxiosPromise; + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback + getDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + getDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - answer( + getDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; options = {}; } @@ -19763,92 +23502,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Gets the SiteSearchEngine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - get( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; options = {}; } @@ -19874,19 +23610,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Lists all the DataStores associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19894,57 +23630,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + params = {} as Params$Resource$Projects$Locations$Datastores$List; options = {}; } @@ -19958,7 +23693,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), @@ -19973,19 +23708,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Updates a DataStore * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19993,57 +23728,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + params = {} as Params$Resource$Projects$Locations$Datastores$Patch; options = {}; } @@ -20069,77 +23803,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + updateDocumentProcessingConfig( + params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + ): GaxiosPromise; + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, - callback: BodyResponseCallback + updateDocumentProcessingConfig( + params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + updateDocumentProcessingConfig( + callback: BodyResponseCallback ): void; - recommend( + updateDocumentProcessingConfig( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; options = {}; } @@ -20153,278 +23887,233 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Completequery + extends StandardParameters { /** - * Performs a search. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - options: StreamMethodOptions - ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - callback: BodyResponseCallback - ): void; - search( - callback: BodyResponseCallback - ): void; - search( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + */ + dataStore?: string; + /** + * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + */ + queryModel?: string; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string; } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Datastores$Create extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. */ - servingConfig?: string; + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig + extends StandardParameters { + /** + * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - extends StandardParameters { + name?: string; /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. */ - servingConfig?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; } - export class Resource$Projects$Locations$Collections$Engines$Sessions { + export class Resource$Projects$Locations$Datastores$Branches { context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; + documents: Resource$Projects$Locations$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Datastores$Branches$Operations; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.documents = + new Resource$Projects$Locations$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Datastores$Branches$Operations( this.context ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Gets index freshness metadata for Documents. Supported for website search only. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, - callback: BodyResponseCallback + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + batchGetDocumentsMetadata( + callback: BodyResponseCallback ): void; - create( + batchGetDocumentsMetadata( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; options = {}; } @@ -20438,11 +24127,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: ( + rootUrl + '/v1alpha/{+parent}/batchGetDocumentsMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -20453,167 +24141,101 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The exact URIs to match by. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Projects$Locations$Datastores$Branches$Documents { + context: APIRequestContext; + chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; + constructor(context: APIRequestContext) { + this.context = context; + this.chunks = + new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( + this.context ); - } else { - return createAPIRequest(parameters); - } } /** - * Gets a Session. + * Creates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; options = {}; } @@ -20627,89 +24249,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Sessions by their parent DataStore. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; options = {}; } @@ -20723,92 +24344,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; options = {}; } @@ -20823,7 +24439,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -20834,150 +24450,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - - export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + } } /** - * Gets a Answer. + * Gets the parsed layout information for a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + getProcessedDocument( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + ): GaxiosPromise; + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - callback: BodyResponseCallback + getProcessedDocument( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getProcessedDocument( + callback: BodyResponseCallback ): void; - get( + getProcessedDocument( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; options = {}; } @@ -20991,7 +24534,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -21003,70 +24549,55 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, callback: BodyResponseCallback ): void; - get( + import( callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21082,13 +24613,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; options = {}; } @@ -21102,15 +24633,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -21124,7 +24658,7 @@ export namespace discoveryengine_v1alpha { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a list of Documents. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21132,57 +24666,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; options = {}; } @@ -21193,178 +24727,95 @@ export namespace discoveryengine_v1alpha { const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Datastores$Controls; - conversations: Resource$Projects$Locations$Datastores$Conversations; - models: Resource$Projects$Locations$Datastores$Models; - operations: Resource$Projects$Locations$Datastores$Operations; - schemas: Resource$Projects$Locations$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = new Resource$Projects$Locations$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Datastores$Completionsuggestions( - this.context - ); - this.controls = new Resource$Projects$Locations$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Datastores$Conversations(this.context); - this.models = new Resource$Projects$Locations$Datastores$Models( - this.context - ); - this.operations = new Resource$Projects$Locations$Datastores$Operations( - this.context - ); - this.schemas = new Resource$Projects$Locations$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); - this.sessions = new Resource$Projects$Locations$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Datastores$Sitesearchengine( - this.context + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( - this.context + } else { + return createAPIRequest( + parameters ); - this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( - this.context - ); + } } /** - * Completes the specified user input with keyword suggestions. + * Updates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completequery, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - completeQuery( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; options = {}; } @@ -21378,70 +24829,67 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+dataStore}:completeQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, callback: BodyResponseCallback ): void; - create( + purge( callback: BodyResponseCallback ): void; - create( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Create + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21457,12 +24905,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Create; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; options = {}; } @@ -21471,94 +24920,207 @@ export namespace discoveryengine_v1alpha { options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + extends StandardParameters { + /** + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + /** + * What format output should be. If unspecified, defaults to JSON. + */ + processedDocumentFormat?: string; + /** + * Required. What type of processing to return. + */ + processedDocumentType?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * 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. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; + } + + export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Deletes a DataStore. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Delete, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; options = {}; } @@ -21573,7 +25135,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -21584,74 +25146,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a DataStore. + * Gets a list of Chunks. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Get, + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Get; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; options = {}; } @@ -21665,89 +25230,118 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get + extends StandardParameters { /** - * Gets a DocumentProcessingConfig. + * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List + extends StandardParameters { + /** + * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Datastores$Branches$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - getDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + cancel( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - getDocumentProcessingConfig( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; options = {}; } @@ -21761,8 +25355,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -21773,77 +25370,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets the SiteSearchEngine. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + get( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; options = {}; } @@ -21869,19 +25464,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the DataStores associated with the project. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -21889,56 +25482,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$List; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; options = {}; } @@ -21952,7 +25546,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/dataStores').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -21962,81 +25556,128 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + extends StandardParameters { /** - * Updates a DataStore + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Patch, + import( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - patch( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Patch; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; options = {}; } @@ -22050,89 +25691,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - updateDocumentProcessingConfig( - params?: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options?: MethodOptions - ): GaxiosPromise; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - params: Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - updateDocumentProcessingConfig( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig; + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; options = {}; } @@ -22146,183 +25787,63 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. - */ - queryModel?: string; - /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Create + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import extends StandardParameters { /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getdocumentprocessingconfig - extends StandardParameters { - /** - * Required. Full DocumentProcessingConfig resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/documentProcessingConfig` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; } - export interface Params$Resource$Projects$Locations$Datastores$List + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge extends StandardParameters { /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Patch - extends StandardParameters { - /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Updatedocumentprocessingconfig - extends StandardParameters { - /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. - */ - name?: string; - /** - * Indicates which fields in the provided DocumentProcessingConfig to update. The following are the only supported fields: * DocumentProcessingConfig.ocr_config If not set, all supported fields are updated. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig; - } - - export class Resource$Projects$Locations$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Datastores$Branches$Operations( - this.context - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; } - export class Resource$Projects$Locations$Datastores$Branches$Documents { + export class Resource$Projects$Locations$Datastores$Controls { context: APIRequestContext; - chunks: Resource$Projects$Locations$Datastores$Branches$Documents$Chunks; constructor(context: APIRequestContext) { this.context = context; - this.chunks = - new Resource$Projects$Locations$Datastores$Branches$Documents$Chunks( - this.context - ); } /** - * Creates a Document. + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22330,57 +25851,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; options = {}; } @@ -22394,7 +25915,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -22409,19 +25930,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Document. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22429,31 +25950,31 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + | Params$Resource$Projects$Locations$Datastores$Controls$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -22469,13 +25990,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; options = {}; } @@ -22511,7 +26032,7 @@ export namespace discoveryengine_v1alpha { } /** - * Gets a Document. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -22519,57 +26040,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; options = {}; } @@ -22595,77 +26116,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the parsed layout information for a Document. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - getProcessedDocument( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params?: Params$Resource$Projects$Locations$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getProcessedDocument( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - getProcessedDocument( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - getProcessedDocument( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument; + {} as Params$Resource$Projects$Locations$Datastores$Controls$List; options = {}; } @@ -22679,7 +26200,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:getProcessedDocument').replace( + url: (rootUrl + '/v1alpha/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -22689,82 +26210,82 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - import( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; options = {}; } @@ -22778,90 +26299,162 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + extends StandardParameters { /** - * Gets a list of Documents. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + } + + export class Resource$Projects$Locations$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + converse( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - list( + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; options = {}; } @@ -22875,92 +26468,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents').replace( + url: (rootUrl + '/v1alpha/{+name}:converse').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; options = {}; } @@ -22974,89 +26567,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - purge( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; options = {}; } @@ -23070,144 +26662,29 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - extends StandardParameters { - /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - documentId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Getprocesseddocument - extends StandardParameters { - /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - /** - * What format output should be. If unspecified, defaults to JSON. - */ - processedDocumentFormat?: string; - /** - * Required. What type of processing to return. - */ - processedDocumentType?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - extends StandardParameters { - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - extends StandardParameters { - /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * 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. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - extends StandardParameters { - /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDocument; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeDocumentsRequest; - } - - export class Resource$Projects$Locations$Datastores$Branches$Documents$Chunks { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Document. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23215,57 +26692,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; options = {}; } @@ -23291,19 +26768,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of Chunks. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23311,57 +26788,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; options = {}; } @@ -23375,7 +26852,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/chunks').replace( + url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -23390,138 +26867,208 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$Get - extends StandardParameters { - /** - * Required. Full resource name of Chunk, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}/chunks/{chunk\}`. If the caller does not have permission to access the Chunk, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Chunk does not exist, a `NOT_FOUND` error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Chunks$List - extends StandardParameters { - /** - * Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. - */ - pageSize?: number; - /** - * A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - pageToken?: string; - /** - * Required. The parent document resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned. - */ - parent?: string; - } - - export class Resource$Projects$Locations$Datastores$Branches$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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`. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}:cancel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Projects$Locations$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datastores$Models$Operations( + this.context ); - } else { - return createAPIRequest(parameters); - } + } + } + + export class Resource$Projects$Locations$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** @@ -23533,27 +27080,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -23561,7 +27108,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23577,13 +27124,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; options = {}; } @@ -23627,27 +27174,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, callback: BodyResponseCallback ): void; list( @@ -23655,7 +27202,7 @@ export namespace discoveryengine_v1alpha { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | Params$Resource$Projects$Locations$Datastores$Models$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23671,13 +27218,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; options = {}; } @@ -23718,26 +27265,14 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List extends StandardParameters { /** * The standard list filter. @@ -23757,50 +27292,50 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Datastores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, callback: BodyResponseCallback ): void; - import( + get( callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | Params$Resource$Projects$Locations$Datastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23816,13 +27351,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; options = {}; } @@ -23836,17 +27371,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -23860,65 +27393,65 @@ export namespace discoveryengine_v1alpha { } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + list( + params?: Params$Resource$Projects$Locations$Datastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Operations$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Operations$List; options = {}; } @@ -23932,63 +27465,68 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + export interface Params$Resource$Projects$Locations$Datastores$Operations$Get extends StandardParameters { /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + export interface Params$Resource$Projects$Locations$Datastores$Operations$List extends StandardParameters { /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * The standard list filter. */ - parent?: string; - + filter?: string; /** - * Request body metadata + * The name of the operation's parent resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsRequest; + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Controls { + export class Resource$Projects$Locations$Datastores$Schemas { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23996,57 +27534,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; options = {}; } @@ -24060,7 +27598,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -24075,19 +27613,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24095,53 +27631,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; options = {}; } @@ -24167,17 +27707,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Control. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24185,57 +27725,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; options = {}; } @@ -24261,19 +27801,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24281,57 +27821,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Controls$List, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; options = {}; } @@ -24345,7 +27885,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/controls').replace( + url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -24360,19 +27900,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24380,57 +27920,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; options = {}; } @@ -24456,150 +27996,144 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create extends StandardParameters { /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - controlId?: string; + parent?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ - parent?: string; + schemaId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$List + export interface Params$Resource$Projects$Locations$Datastores$Schemas$List extends StandardParameters { /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */ - name?: string; + allowMissing?: boolean; /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - updateMask?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; } - export class Resource$Projects$Locations$Datastores$Conversations { + export class Resource$Projects$Locations$Datastores$Servingconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Converses a conversation. + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + answer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - converse( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; options = {}; } @@ -24613,7 +28147,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}:converse').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), @@ -24623,82 +28157,82 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; options = {}; } @@ -24712,88 +28246,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; options = {}; } @@ -24807,87 +28342,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; options = {}; } @@ -24902,7 +28442,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -24913,77 +28453,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, + recommend( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - list( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; options = {}; } @@ -24997,92 +28537,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/conversations').replace( + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + search( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - patch( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; options = {}; } @@ -25096,186 +28636,179 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - name?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConverseConversationRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get - extends StandardParameters { + pageSize?: number; /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */ - name?: string; + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$List + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ - filter?: string; + name?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */ - orderBy?: string; + updateMask?: string; + /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + extends StandardParameters { /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */ - pageToken?: string; + servingConfig?: string; + /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - updateMask?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaConversation; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; } - export class Resource$Projects$Locations$Datastores$Models { + export class Resource$Projects$Locations$Datastores$Sessions { context: APIRequestContext; - operations: Resource$Projects$Locations$Datastores$Models$Operations; + answers: Resource$Projects$Locations$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.operations = - new Resource$Projects$Locations$Datastores$Models$Operations( + this.answers = + new Resource$Projects$Locations$Datastores$Sessions$Answers( this.context ); } - } - - export class Resource$Projects$Locations$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; options = {}; } @@ -25289,87 +28822,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; options = {}; } @@ -25383,11 +28917,8 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -25398,53 +28929,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -25452,57 +28947,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; options = {}; } @@ -25528,17 +29023,19 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -25546,57 +29043,57 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; options = {}; } @@ -25610,126 +29107,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( + url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores$Schemas { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Creates a Schema. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; options = {}; } @@ -25743,90 +29206,162 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; /** - * Deletes a Schema. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + } + + export class Resource$Projects$Locations$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - delete( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; options = {}; } @@ -25841,7 +29376,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -25852,75 +29387,97 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Gets a Schema. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine { + context: APIRequestContext; + targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.targetSites = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + ): GaxiosPromise; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + ): void; + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - callback: BodyResponseCallback + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + disableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - get( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -25934,89 +29491,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a list of Schemas. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + ): GaxiosPromise; + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, - callback: BodyResponseCallback + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + enableAdvancedSiteSearch( + callback: BodyResponseCallback ): void; - list( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -26030,70 +29587,67 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, callback: BodyResponseCallback ): void; - patch( + recrawlUris( callback: BodyResponseCallback ): void; - patch( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -26109,13 +29663,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -26129,15 +29683,18 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -26151,134 +29708,109 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch extends StandardParameters { /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - schemaId?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$List + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch extends StandardParameters { /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. */ - pageToken?: string; + siteSearchEngine?: string; + /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris extends StandardParameters { /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. */ - name?: string; + siteSearchEngine?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; } - export class Resource$Projects$Locations$Datastores$Servingconfigs { + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Answer query method. + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + batchCreate( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - answer( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -26292,92 +29824,89 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -26391,89 +29920,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -26487,92 +30017,87 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -26587,7 +30112,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -26598,77 +30123,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + list( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - recommend( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -26682,92 +30207,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - search( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -26781,179 +30306,256 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - pageToken?: string; + parent?: string; + /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */ name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaServingConfig; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List extends StandardParameters { /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */ - servingConfig?: string; - + pageSize?: number; /** - * Request body metadata + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. */ - servingConfig?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; } - export class Resource$Projects$Locations$Datastores$Sessions { + export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { context: APIRequestContext; - answers: Resource$Projects$Locations$Datastores$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Datastores$Sessions$Answers( - this.context + } + + /** + * Imports all SuggestionDenyListEntry for a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - create( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -26967,10 +30569,9 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -26982,73 +30583,103 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + extends StandardParameters { /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; + } + + export class Resource$Projects$Locations$Datastores$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + collect( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; options = {}; } @@ -27062,87 +30693,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; options = {}; } @@ -27156,89 +30790,90 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all Sessions by their parent DataStore. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + callback: BodyResponseCallback ): void; - list( + purge( + callback: BodyResponseCallback + ): void; + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; options = {}; } @@ -27252,11 +30887,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/sessions').replace( + url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -27267,77 +30902,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + write( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - patch( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; options = {}; } @@ -27351,104 +30984,201 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */ - parent?: string; - + ets?: string; /** - * Request body metadata + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete - extends StandardParameters { + parent?: string; /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * 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. */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get - extends StandardParameters { + uri?: string; /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */ - name?: string; + userEvent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` */ - orderBy?: string; + parent?: string; + /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Request body metadata */ - pageSize?: number; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge + extends StandardParameters { /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` */ - pageToken?: string; + parent?: string; + /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Request body metadata */ - parent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. */ - name?: string; + parent?: string; /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */ - updateMask?: string; + writeAsync?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; } - export class Resource$Projects$Locations$Datastores$Sessions$Answers { + export class Resource$Projects$Locations$Evaluations { context: APIRequestContext; + operations: Resource$Projects$Locations$Evaluations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = new Resource$Projects$Locations$Evaluations$Operations( + this.context + ); + } + + /** + * Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Evaluations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Evaluations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Evaluations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Evaluations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Gets a Answer. + * Gets a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -27456,57 +31186,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params?: Params$Resource$Projects$Locations$Evaluations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + params: Params$Resource$Projects$Locations$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Evaluations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + params = {} as Params$Resource$Projects$Locations$Evaluations$Get; options = {}; } @@ -27532,97 +31261,76 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine { - context: APIRequestContext; - targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.targetSites = - new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Downgrade from advanced site search to basic site search. + * Gets a list of Evaluations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params?: Params$Resource$Projects$Locations$Evaluations$List, options?: MethodOptions - ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Evaluations$List, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + params = {} as Params$Resource$Projects$Locations$Evaluations$List; options = {}; } @@ -27636,89 +31344,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/evaluations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Upgrade from basic site search to advanced site search. + * Gets a list of results for a given a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + listResults( + params?: Params$Resource$Projects$Locations$Evaluations$Listresults, options?: MethodOptions - ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + ): GaxiosPromise; + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, - callback: BodyResponseCallback + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - callback: BodyResponseCallback + listResults( + callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + listResults( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Listresults + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$Listresults; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Evaluations$Listresults; options = {}; } @@ -27732,67 +31443,127 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+evaluation}:listResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['evaluation'], + pathParams: ['evaluation'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Evaluations$Create + extends StandardParameters { /** - * Request on-demand recrawl for a list of URIs. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluation; + } + export interface Params$Resource$Projects$Locations$Evaluations$Get + extends StandardParameters { + /** + * Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$List + extends StandardParameters { + /** + * Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$Listresults + extends StandardParameters { + /** + * Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. + */ + evaluation?: string; + /** + * Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Evaluations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; - recrawlUris( + get( callback: BodyResponseCallback ): void; - recrawlUris( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | Params$Resource$Projects$Locations$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27808,13 +31579,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; options = {}; } @@ -27828,18 +31599,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -27853,109 +31621,80 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; + name?: string; } - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + export class Resource$Projects$Locations$Groundingconfigs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates TargetSite in a batch. + * Performs a grounding check. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + check( + params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): GaxiosPromise; + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + check( + callback: BodyResponseCallback ): void; - batchCreate( + check( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Groundingconfigs$Check + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; options = {}; } @@ -27969,67 +31708,102 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+groundingConfig}:check').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['groundingConfig'], + pathParams: ['groundingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Groundingconfigs$Check + extends StandardParameters { + /** + * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. + */ + groundingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; + } + + export class Resource$Projects$Locations$Identity_mapping_stores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Identity_mapping_stores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Identity_mapping_stores$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Identity_mapping_stores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Creates a TargetSite. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + get( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get, callback: BodyResponseCallback ): void; - create( + get( callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -28045,13 +31819,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get; options = {}; } @@ -28065,18 +31839,15 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -28090,65 +31861,65 @@ export namespace discoveryengine_v1alpha { } /** - * Deletes a TargetSite. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + list( + params?: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - delete( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List; options = {}; } @@ -28162,8 +31933,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -28174,17 +31948,53 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$Get + extends StandardParameters { /** - * Gets a TargetSite. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Identity_mapping_stores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28192,57 +32002,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -28268,19 +32077,17 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); - } else { - return createAPIRequest( - parameters - ); + } else { + return createAPIRequest(parameters); } } /** - * Gets a list of TargetSites. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28288,57 +32095,56 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + params: Params$Resource$Projects$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -28352,7 +32158,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/targetSites').replace( + url: (rootUrl + '/v1alpha/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -28362,82 +32168,115 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { /** - * Updates a TargetSite. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Rankingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Ranks a list of text records based on the given input query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + rank( + params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + ): GaxiosPromise; + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + rank( + callback: BodyResponseCallback ): void; - patch( + rank( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Rankingconfigs$Rank + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; options = {}; } @@ -28451,160 +32290,112 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1alpha/{+rankingConfig}:rank').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['rankingConfig'], + pathParams: ['rankingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank extends StandardParameters { /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. */ - name?: string; + rankingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSite; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest; } - export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + export class Resource$Projects$Locations$Requirements { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Check a particular requirement. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + checkRequirement( + params?: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + checkRequirement( + params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + checkRequirement( + callback: BodyResponseCallback ): void; - import( + checkRequirement( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Requirements$Checkrequirement + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Requirements$Checkrequirement; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Requirements$Checkrequirement; options = {}; } @@ -28619,7 +32410,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:import' + rootUrl + '/v1alpha/{+location}/requirements:checkRequirement' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -28627,80 +32418,112 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['location'], + pathParams: ['location'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Requirements$Checkrequirement + extends StandardParameters { /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` + */ + location?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest; + } + + export class Resource$Projects$Locations$Samplequerysets { + context: APIRequestContext; + operations: Resource$Projects$Locations$Samplequerysets$Operations; + sampleQueries: Resource$Projects$Locations$Samplequerysets$Samplequeries; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Samplequerysets$Operations( + this.context + ); + this.sampleQueries = + new Resource$Projects$Locations$Samplequerysets$Samplequeries( + this.context + ); + } + + /** + * Creates a SampleQuerySet * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Create, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - purge( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Samplequerysets$Create; options = {}; } @@ -28714,9 +32537,10 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -28728,103 +32552,73 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesRequest; - } - - export class Resource$Projects$Locations$Datastores$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Delete, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Samplequerysets$Delete; options = {}; } @@ -28838,90 +32632,86 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Gets a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Get, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Get; options = {}; } @@ -28935,90 +32725,88 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. + * Gets a list of SampleQuerySets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + {}) as Params$Resource$Projects$Locations$Samplequerysets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$List; options = {}; } @@ -29032,11 +32820,11 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:purge').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQuerySets').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -29047,75 +32835,76 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Updates a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Patch, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - write( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Patch; options = {}; } @@ -29129,105 +32918,93 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect + export interface Params$Resource$Projects$Locations$Samplequerysets$Create extends StandardParameters { /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. */ parent?: string; /** - * 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. + * Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - uri?: string; + sampleQuerySetId?: string; + /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + * Request body metadata */ - userEvent?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import + export interface Params$Resource$Projects$Locations$Samplequerysets$Delete extends StandardParameters { /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. */ - parent?: string; - + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Get + extends StandardParameters { /** - * Request body metadata + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge + export interface Params$Resource$Projects$Locations$Samplequerysets$List extends StandardParameters { /** - * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + * Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */ - parent?: string; - + pageSize?: number; /** - * Request body metadata + * A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest; + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write + export interface Params$Resource$Projects$Locations$Samplequerysets$Patch extends StandardParameters { /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + * Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - parent?: string; + name?: string; /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + * Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. */ - writeAsync?: boolean; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; - } - - export class Resource$Projects$Locations$Evaluations { - context: APIRequestContext; - operations: Resource$Projects$Locations$Evaluations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Projects$Locations$Evaluations$Operations( - this.context - ); - } + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuerySet; } - export class Resource$Projects$Locations$Evaluations$Operations { + export class Resource$Projects$Locations$Samplequerysets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -29242,27 +33019,27 @@ export namespace discoveryengine_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -29270,7 +33047,7 @@ export namespace discoveryengine_v1alpha { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Evaluations$Operations$Get + | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -29286,13 +33063,13 @@ export namespace discoveryengine_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; options = {}; } @@ -29328,7 +33105,7 @@ export namespace discoveryengine_v1alpha { } } - export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get + export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get extends StandardParameters { /** * The name of the operation resource. @@ -29336,72 +33113,72 @@ export namespace discoveryengine_v1alpha { name?: string; } - export class Resource$Projects$Locations$Groundingconfigs { + export class Resource$Projects$Locations$Samplequerysets$Samplequeries { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Performs a grounding check. + * Creates a SampleQuery * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions ): GaxiosPromise; - check( - params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options?: MethodOptions - ): GaxiosPromise; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + callback: BodyResponseCallback ): void; - check( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - check( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Groundingconfigs$Check - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; options = {}; } @@ -29415,7 +33192,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+groundingConfig}:check').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -29425,101 +33202,78 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['groundingConfig'], - pathParams: ['groundingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Groundingconfigs$Check - extends StandardParameters { - /** - * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. - */ - groundingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; options = {}; } @@ -29534,7 +33288,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -29545,74 +33299,75 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + callback: BodyResponseCallback ): void; - list( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; options = {}; } @@ -29626,10 +33381,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -29641,110 +33393,77 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Rankingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Ranks a list of text records based on the given input query. + * Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions ): GaxiosPromise; - rank( - params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + import( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options?: MethodOptions - ): GaxiosPromise; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, + callback: BodyResponseCallback ): void; - rank( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - rank( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Rankingconfigs$Rank - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; options = {}; } @@ -29758,7 +33477,7 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+rankingConfig}:rank').replace( + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -29768,102 +33487,80 @@ export namespace discoveryengine_v1alpha { options ), params, - requiredParams: ['rankingConfig'], - pathParams: ['rankingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank - extends StandardParameters { - /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. - */ - rankingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRankRequest; - } - - export class Resource$Projects$Locations$Requirements { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Check a particular requirement. + * Gets a list of SampleQuerys. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions ): GaxiosPromise; - checkRequirement( - params?: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options?: MethodOptions - ): GaxiosPromise; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - checkRequirement( - params: Params$Resource$Projects$Locations$Requirements$Checkrequirement, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + callback: BodyResponseCallback ): void; - checkRequirement( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - checkRequirement( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Requirements$Checkrequirement - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Requirements$Checkrequirement; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Requirements$Checkrequirement; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; options = {}; } @@ -29877,123 +33574,92 @@ export namespace discoveryengine_v1alpha { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1alpha/{+location}/requirements:checkRequirement' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1alpha/{+parent}/sampleQueries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['location'], - pathParams: ['location'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Requirements$Checkrequirement - extends StandardParameters { - /** - * Required. Full resource name of the location. Format `projects/{project_number_or_id\}/locations/{location\}` - */ - location?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest; - } - - export class Resource$Projects$Locations$Samplequerysets { - context: APIRequestContext; - operations: Resource$Projects$Locations$Samplequerysets$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Samplequerysets$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Samplequerysets$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Updates a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; options = {}; } @@ -30008,7 +33674,7 @@ export namespace discoveryengine_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -30019,22 +33685,90 @@ export namespace discoveryengine_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + parent?: string; + /** + * Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQueryId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + extends StandardParameters { + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List extends StandardParameters { /** - * The name of the operation resource. + * Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + extends StandardParameters { + /** + * Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; + /** + * Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSampleQuery; } export class Resource$Projects$Locations$Userevents { @@ -30270,6 +34004,244 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaUserEvent; } + export class Resource$Projects$Locations$Userstores { + context: APIRequestContext; + operations: Resource$Projects$Locations$Userstores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Userstores$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Userstores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Userstores$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Userstores$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Userstores$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Userstores$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Userstores$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Userstores$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Userstores$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Userstores$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Userstores$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Userstores$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Userstores$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Userstores$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Userstores$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Userstores$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export class Resource$Projects$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 72aabf0456..5397853839 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -357,6 +357,10 @@ export namespace discoveryengine_v1beta { * Chunk information. */ chunkInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo; + /** + * Structured document information. + */ + structuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo; /** * Unstructured document information. */ @@ -379,7 +383,7 @@ export namespace discoveryengine_v1beta { */ documentMetadata?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata; /** - * Relevance score. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ relevanceScore?: number | null; } @@ -408,6 +412,19 @@ export namespace discoveryengine_v1beta { */ uri?: string | null; } + /** + * Structured search information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo { + /** + * Document resource name. + */ + document?: string | null; + /** + * Structured search data. + */ + structData?: {[key: string]: any} | null; + } /** * Unstructured document information. */ @@ -445,6 +462,10 @@ export namespace discoveryengine_v1beta { * Page identifier. */ pageIdentifier?: string | null; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; } /** * Step information. @@ -502,6 +523,10 @@ export namespace discoveryengine_v1beta { * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ snippetInfo?: Schema$GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo[]; + /** + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . + */ + structData?: {[key: string]: any} | null; /** * Title. */ @@ -524,7 +549,7 @@ export namespace discoveryengine_v1beta { */ content?: string | null; /** - * Relevance score. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ relevanceScore?: number | null; } @@ -616,7 +641,7 @@ export namespace discoveryengine_v1beta { */ export interface Schema$GoogleCloudDiscoveryengineV1alphaControl { /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ associatedServingConfigIds?: string[] | null; /** @@ -730,6 +755,10 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Metadata for EvaluationService.CreateEvaluation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata {} /** * Metadata for Create Schema LRO. */ @@ -756,6 +785,15 @@ export namespace discoveryengine_v1beta { */ updateTime?: string | null; } + /** + * Defines custom fine tuning spec. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec { + /** + * Whether or not to enable and include custom fine tuned search adaptor model. + */ + enableSearchAdaptor?: boolean | null; + } /** * Metadata that describes a custom tuned model. */ @@ -768,6 +806,10 @@ export namespace discoveryengine_v1beta { * The display name of the model. */ displayName?: string | null; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; /** * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ @@ -837,6 +879,10 @@ export namespace discoveryengine_v1beta { * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ startingSchema?: Schema$GoogleCloudDiscoveryengineV1alphaSchema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig; } /** * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. @@ -924,7 +970,7 @@ export namespace discoveryengine_v1beta { */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */ parsingConfigOverrides?: { [ @@ -1216,6 +1262,65 @@ export namespace discoveryengine_v1beta { */ documentCount?: string | null; } + /** + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluation { + /** + * Output only. Timestamp the Evaluation was created at. + */ + createTime?: string | null; + /** + * Output only. Timestamp the Evaluation was completed at. + */ + endTime?: string | null; + /** + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. + */ + error?: Schema$GoogleRpcStatus; + /** + * Output only. A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Required. The specification of the evaluation. + */ + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec; + /** + * Identifier. The full resource name of the Evaluation, in the format of `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. + */ + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; + } + /** + * Describes the specification of the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec { + /** + * Required. The specification of the query set. + */ + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec; + /** + * Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id + */ + searchRequest?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + /** + * Describes the specification of the query set. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec { + /** + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. + */ + sampleQuerySet?: string | null; + } /** * Configurations for fields of a schema. For example, configuring a field is indexable, or searchable. */ @@ -1265,6 +1370,15 @@ export namespace discoveryengine_v1beta { */ searchableOption?: string | null; } + /** + * Response message for SiteSearchEngineService.GetUriPatternDocumentData method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse { + /** + * Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/x": { "Categories": ["category1", "category2"] \}, "www.url2.com/x": { "Categories": ["category3"] \} \} + */ + documentDataMap?: {[key: string]: {[key: string]: any}} | null; + } /** * Identity Provider Config. */ @@ -1368,6 +1482,44 @@ export namespace discoveryengine_v1beta { */ gcsPrefix?: string | null; } + /** + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata { + /** + * ImportSampleQueries operation create time. + */ + createTime?: string | null; + /** + * Count of SampleQuerys that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of SampleQuerys successfully imported. + */ + successCount?: string | null; + /** + * Total count of SampleQuerys that were processed. + */ + totalCount?: string | null; + /** + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } /** * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ @@ -1440,6 +1592,27 @@ export namespace discoveryengine_v1beta { */ unjoinedEventsCount?: string | null; } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaInterval { + /** + * Exclusive upper bound. + */ + exclusiveMaximum?: number | null; + /** + * Exclusive lower bound. + */ + exclusiveMinimum?: number | null; + /** + * Inclusive upper bound. + */ + maximum?: number | null; + /** + * Inclusive lower bound. + */ + minimum?: number | null; + } /** * Language info for DataStore. */ @@ -1644,6 +1817,52 @@ export namespace discoveryengine_v1beta { */ purgeCount?: string | null; } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetrics { + /** + * Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + docNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 + */ + docPrecision?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + docRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 + */ + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + /** + * Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics; + } + /** + * Stores the metric values at specific top-k levels. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics { + /** + * The top-1 value. + */ + top1?: number | null; + /** + * The top-10 value. + */ + top10?: number | null; + /** + * The top-3 value. + */ + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; + } /** * Defines a user inputed query. */ @@ -1751,2620 +1970,2744 @@ export namespace discoveryengine_v1beta { structSchema?: {[key: string]: any} | null; } /** - * External session proto definition. + * Request message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest { /** - * Output only. The time the session finished. + * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ - endTime?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */ - name?: string | null; + branch?: string | null; /** - * Output only. The time the session started. + * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ - startTime?: string | null; + canonicalFilter?: string | null; /** - * The state of the session. + * A specification for configuring the behavior of content search. */ - state?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec; /** - * Turns. + * Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec. */ - turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; + customFineTuningSpec?: Schema$GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec; /** - * A unique identifier for tracking users. + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */ - userPseudoId?: string | null; - } - /** - * Represents a turn, including a query from the user and a answer from service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec[]; /** - * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */ - answer?: string | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec; /** - * The user query. + * Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec[]; /** - * Site verification state indicating the ownership and validity. + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ - siteVerificationState?: string | null; + filter?: string | null; /** - * Latest site verification time. + * Raw image query. */ - verifyTime?: string | null; - } - /** - * A target site for the SiteSearchEngine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { + imageQuery?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery; /** - * 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. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */ - exactMatch?: boolean | null; + languageCode?: string | null; /** - * Output only. Failure reason. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Output only. This is system-generated based on the provided_uri_pattern. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - generatedUriPattern?: string | null; + offset?: number | null; /** - * Output only. Indexing status. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - indexingStatus?: string | null; + orderBy?: string | null; /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - name?: string | null; + pageSize?: number | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - providedUriPattern?: string | null; + pageToken?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ - rootDomainUri?: string | null; + params?: {[key: string]: any} | null; /** - * Output only. Site ownership and validity verification status. + * Raw search query. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; + query?: string | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - type?: string | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec; /** - * Output only. The target site's last updated time. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ - updateTime?: string | null; - } - /** - * Site search indexing failure reasons. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { + rankingExpression?: string | null; /** - * Failed due to insufficient quota. + * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { + regionCode?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */ - totalRequiredQuota?: string | null; - } - /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { + relevanceThreshold?: string | null; /** - * Operation create time. + * Whether to turn on safe search. This is only supported for website search. */ - createTime?: string | null; + safeSearch?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - updateTime?: string | null; - } - /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec; /** - * Echoes the destination for the complete errors in the request if set. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; + servingConfig?: string | null; /** - * A sample of errors encountered while processing the data. + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - errorSamples?: Schema$GoogleRpcStatus[]; + session?: string | null; /** - * The metrics of the trained model. + * Session specification. Can be used only when `session` is set. */ - metrics?: {[key: string]: number} | null; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec; /** - * Fully qualified name of the CustomTuningModel. + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - modelName?: string | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec; /** - * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - modelStatus?: string | null; + userInfo?: Schema$GoogleCloudDiscoveryengineV1alphaUserInfo; + /** + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + */ + userLabels?: {[key: string]: string} | null; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string | null; } /** - * Metadata associated with a tune operation. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ - engine?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * Response associated with a tune operation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} - /** - * Metadata for UpdateSchema LRO. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec { /** - * Operation create time. + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ - createTime?: string | null; + boost?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Complex specification for custom ranking based on customer defined attribute value. */ - updateTime?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + /** + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + */ + condition?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. */ - export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Operation create time. + * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */ - createTime?: string | null; + attributeType?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - updateTime?: string | null; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; + /** + * The name of the field whose value will be used to determine the boost amount. + */ + fieldName?: string | null; + /** + * The interpolation type to be applied to connect the control points listed below. + */ + interpolationType?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. + * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Operation create time. + * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */ - createTime?: string | null; + attributeValue?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - updateTime?: string | null; + boostAmount?: number | null; } /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec { /** - * TargetSites created. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec; + /** + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. + */ + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec; + /** + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + */ + searchResultMode?: string | null; + /** + * If `snippetSpec` is not specified, snippets are not included in the search response. + */ + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec; + /** + * If `summarySpec` is not specified, summaries are not included in the search response. + */ + summarySpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec; } /** - * AlloyDB source import data from. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec { /** - * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. + * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */ - clusterId?: string | null; + numNextChunks?: number | null; /** - * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. + * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */ - databaseId?: string | null; + numPreviousChunks?: number | null; + } + /** + * A specification for configuring the extractive content in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + * The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */ - gcsStagingDir?: string | null; + maxExtractiveAnswerCount?: number | null; /** - * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + * The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */ - locationId?: string | null; + maxExtractiveSegmentCount?: number | null; /** - * The project ID that the AlloyDB source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * Return at most `num_next_segments` segments after each selected segments. */ - projectId?: string | null; + numNextSegments?: number | null; /** - * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - tableId?: string | null; + numPreviousSegments?: number | null; + /** + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** - * Defines an answer. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec { /** - * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + * [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. */ - answerSkippedReasons?: string[] | null; + maxSnippetCount?: number | null; /** - * The textual answer. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - answerText?: string | null; + referenceOnly?: boolean | null; /** - * Citations. + * If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */ - citations?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation[]; + returnSnippet?: boolean | null; + } + /** + * A specification for configuring a summary returned in a search response. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec { /** - * Output only. Answer completed timestamp. + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ - completeTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Output only. Answer creation timestamp. + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ - createTime?: string | null; + ignoreLowRelevantContent?: boolean | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` + * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ - name?: string | null; + ignoreNonSummarySeekingQuery?: boolean | null; /** - * Query understanding information. + * Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */ - queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo; + includeCitations?: boolean | null; /** - * References. + * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */ - references?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReference[]; + languageCode?: string | null; /** - * Suggested related questions. + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - relatedQuestions?: string[] | null; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * The state of the answer generation. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - state?: string | null; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * Answer generation steps. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - steps?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStep[]; + summaryResultCount?: number | null; + /** + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. + */ + useSemanticChunks?: boolean | null; } /** - * Citation info for a segment. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * End of the attributed segment, exclusive. + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - endIndex?: string | null; + preamble?: string | null; + } + /** + * Specification of the model. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec { /** - * Citation sources for the attributed segment. + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). */ - sources?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource[]; + version?: string | null; + } + /** + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec { /** - * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - startIndex?: string | null; + dataStore?: string | null; } /** - * Citation source. + * The specification that uses customized query embedding vector to do semantic document retrieval. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec { /** - * ID of the citation source. + * The embedding vector used for retrieval. Limit to 1. */ - referenceId?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Request message for ConversationalSearchService.AnswerQuery method. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Answer generation specification. + * Embedding field path in schema. */ - answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec; + fieldPath?: string | null; /** - * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. + * Query embedding vector. */ - asynchronousMode?: boolean | null; + vector?: number[] | null; + } + /** + * A facet specification to perform faceted search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec { /** - * Required. Current user query. + * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */ - query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; + enableDynamicPosition?: boolean | null; /** - * Query understanding specification. + * List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec; + excludedFilterKeys?: string[] | null; /** - * Related questions specification. + * Required. The facet key specification. */ - relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec; + facetKey?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey; /** - * Model specification. + * Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - safetySpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec; + limit?: number | null; + } + /** + * Specifies how a facet is computed. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey { /** - * Search specification. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - searchSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec; + caseInsensitive?: boolean | null; /** - * The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. + * Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. */ - session?: string | null; - /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. - */ - userLabels?: {[key: string]: string} | null; - /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string | null; - } - /** - * Answer generation specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec { - /** - * Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. - */ - answerLanguageCode?: string | null; - /** - * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. - */ - ignoreAdversarialQuery?: boolean | null; + contains?: string[] | null; /** - * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. + * Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */ - ignoreLowRelevantContent?: boolean | null; + intervals?: Schema$GoogleCloudDiscoveryengineV1alphaInterval[]; /** - * Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - ignoreNonAnswerSeekingQuery?: boolean | null; + key?: string | null; /** - * Specifies whether to include citation metadata in the answer. The default value is `false`. + * The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. */ - includeCitations?: boolean | null; + orderBy?: string | null; /** - * Answer generation model specification. + * Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. */ - modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec; + prefixes?: string[] | null; /** - * Answer generation prompt specification. + * Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. */ - promptSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec; + restrictedValues?: string[] | null; } /** - * Answer Generation Model specification. + * Specifies the image query input. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery { /** - * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - modelVersion?: string | null; + imageBytes?: string | null; } /** - * Answer generation prompt specification. + * Specification to enable natural language understanding capabilities for search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * Customized preamble. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - preamble?: string | null; + filterExtractionCondition?: string | null; + /** + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. + */ + geoSearchQueryDetectionFieldNames?: string[] | null; } /** - * Query understanding specification. + * Specification to determine under which conditions query expansion should occur. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec { /** - * Query classification specification. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; + condition?: string | null; /** - * Query rephraser specification. + * Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */ - queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; + pinUnexpandedResults?: boolean | null; } /** - * Query classification specification. + * Specification for search as you type in search requests. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec { /** - * Enabled query classification types. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - types?: string[] | null; + condition?: string | null; } /** - * Query rephraser specification. + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec { /** - * Disable query rephraser. - */ - disable?: boolean | null; - /** - * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */ - maxRephraseSteps?: number | null; - } - /** - * Related questions specification. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec { + queryId?: string | null; /** - * Enable related questions feature if true. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */ - enable?: boolean | null; + searchResultPersistenceCount?: number | null; } /** - * Safety specification. + * The specification for query spell correction. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec { /** - * Enable the safety filtering on the answer response. It is false by default. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - enable?: boolean | null; + mode?: string | null; } /** - * Search specification. + * External session proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSession { /** - * Search parameters. + * Output only. The time the session finished. */ - searchParams?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams; + endTime?: string | null; /** - * Search result list. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - searchResultList?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList; - } - /** - * Search parameters. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams { + name?: string | null; /** - * Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + * Output only. The time the session started. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + startTime?: string | null; /** - * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. + * The state of the session. */ - dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + state?: string | null; /** - * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * Turns. */ - filter?: string | null; + turns?: Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn[]; /** - * Number of search results to return. The default value is 10. + * A unique identifier for tracking users. */ - maxReturnResults?: number | null; + userPseudoId?: string | null; + } + /** + * Represents a turn, including a query from the user and a answer from service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSessionTurn { /** - * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */ - orderBy?: string | null; + answer?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + * The user query. */ - searchResultMode?: string | null; + query?: Schema$GoogleCloudDiscoveryengineV1alphaQuery; } /** - * Search result list. + * Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata { /** - * Search results. + * Operation create time. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Search result. + * Response message for SiteSearchEngineService.SetUriPatternDocumentData method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult { + export interface Schema$GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse {} + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo { /** - * Chunk information. + * Site verification state indicating the ownership and validity. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; + siteVerificationState?: string | null; /** - * Unstructured document information. + * Latest site verification time. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; + verifyTime?: string | null; } /** - * Chunk information. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSite { /** - * Chunk resource name. + * 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. */ - chunk?: string | null; + exactMatch?: boolean | null; /** - * Chunk textual content. + * Output only. Failure reason. */ - content?: string | null; - } - /** - * Unstructured document information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { + failureReason?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason; /** - * Document resource name. + * Output only. This is system-generated based on the provided_uri_pattern. */ - document?: string | null; + generatedUriPattern?: string | null; /** - * List of document contexts. + * Output only. Indexing status. */ - documentContexts?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; + indexingStatus?: string | null; /** - * List of extractive answers. + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. */ - extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; + name?: string | null; /** - * List of extractive segments. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; + providedUriPattern?: string | null; /** - * Title. + * Output only. Root domain of the provided_uri_pattern. */ - title?: string | null; + rootDomainUri?: string | null; /** - * URI for the document. + * Output only. Site ownership and validity verification status. */ - uri?: string | null; - } - /** - * Document context. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo; /** - * Document content. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - content?: string | null; + type?: string | null; /** - * Page identifier. + * Output only. The target site's last updated time. */ - pageIdentifier?: string | null; + updateTime?: string | null; } /** - * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) + * Site search indexing failure reasons. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason { /** - * Extractive answer content. + * Failed due to insufficient quota. */ - content?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure { /** - * Page identifier. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - pageIdentifier?: string | null; + totalRequiredQuota?: string | null; } /** - * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata { /** - * Extractive segment content. + * Operation create time. */ - content?: string | null; + createTime?: string | null; /** - * Page identifier. + * Operation last update time. If the operation is done, this is also the finish time. */ - pageIdentifier?: string | null; + updateTime?: string | null; } /** - * Response message for ConversationalSearchService.AnswerQuery method. + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse { /** - * Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + * Echoes the destination for the complete errors in the request if set. */ - answer?: Schema$GoogleCloudDiscoveryengineV1betaAnswer; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1alphaImportErrorConfig; /** - * A global unique ID used for logging. + * A sample of errors encountered while processing the data. */ - answerQueryToken?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. + * The metrics of the trained model. */ - session?: Schema$GoogleCloudDiscoveryengineV1betaSession; + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; } /** - * Query understanding information. + * Metadata associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata { /** - * Query classification information. + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` */ - queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo[]; + engine?: string | null; } /** - * Query classification information. + * Response associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaTuneEngineResponse {} + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata { /** - * Classification output. + * Operation create time. */ - positive?: boolean | null; + createTime?: string | null; /** - * Query classification type. + * Operation last update time. If the operation is done, this is also the finish time. */ - type?: string | null; + updateTime?: string | null; } /** - * Reference. + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReference { + export interface Schema$GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata { /** - * Chunk information. + * Operation create time. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo; + createTime?: string | null; /** - * Unstructured document information. + * Operation last update time. If the operation is done, this is also the finish time. */ - unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo; + updateTime?: string | null; } /** - * Chunk information. + * Information of an end user. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo { + export interface Schema$GoogleCloudDiscoveryengineV1alphaUserInfo { /** - * Chunk resource name. + * 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. */ - chunk?: string | null; + userAgent?: string | null; /** - * Chunk textual content. + * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - content?: string | null; + userId?: string | null; + } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaWorkspaceConfig { /** - * Document metadata. + * Obfuscated Dasher customer ID. */ - documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata; + dasherCustomerId?: string | null; /** - * Relevance score. + * The Google Workspace data source. */ - relevanceScore?: number | null; + type?: string | null; } /** - * Document metadata. + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata { /** - * Document resource name. + * Operation create time. */ - document?: string | null; + createTime?: string | null; /** - * Page identifier. + * Operation last update time. If the operation is done, this is also the finish time. */ - pageIdentifier?: string | null; + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse { /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * TargetSites created. */ - structData?: {[key: string]: any} | null; + targetSites?: Schema$GoogleCloudDiscoveryengineV1TargetSite[]; + } + /** + * AlloyDB source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource { /** - * Title. + * Required. The AlloyDB cluster to copy the data from with a length limit of 256 characters. */ - title?: string | null; + clusterId?: string | null; /** - * URI for the document. + * Required. The AlloyDB database to copy the data from with a length limit of 256 characters. */ - uri?: string | null; + databaseId?: string | null; + /** + * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the AlloyDB export to a specific Cloud Storage directory. Ensure that the AlloyDB service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + */ + gcsStagingDir?: string | null; + /** + * Required. The AlloyDB location to copy the data from with a length limit of 256 characters. + */ + locationId?: string | null; + /** + * The project ID that contains the AlloyDB source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + */ + projectId?: string | null; + /** + * Required. The AlloyDB table to copy the data from with a length limit of 256 characters. + */ + tableId?: string | null; } /** - * Unstructured document information. + * Defines an answer. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswer { /** - * List of cited chunk contents derived from document content. + * Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */ - chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[]; + answerSkippedReasons?: string[] | null; /** - * Document resource name. + * The textual answer. */ - document?: string | null; + answerText?: string | null; /** - * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. + * Citations. */ - structData?: {[key: string]: any} | null; + citations?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation[]; /** - * Title. + * Output only. Answer completed timestamp. */ - title?: string | null; + completeTime?: string | null; /** - * URI for the document. + * Output only. Answer creation timestamp. */ - uri?: string | null; - } - /** - * Chunk content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent { + createTime?: string | null; /** - * Chunk textual content. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x/answers/x` */ - content?: string | null; + name?: string | null; /** - * Page identifier. + * Query understanding information. */ - pageIdentifier?: string | null; - } - /** - * Step information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStep { + queryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo; /** - * Actions. + * References. */ - actions?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction[]; + references?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReference[]; /** - * The description of the step. + * Suggested related questions. */ - description?: string | null; + relatedQuestions?: string[] | null; /** - * The state of the step. + * The state of the answer generation. */ state?: string | null; /** - * The thought of the step. + * Answer generation steps. */ - thought?: string | null; + steps?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStep[]; } /** - * Action. + * Citation info for a segment. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitation { /** - * Observation. + * End of the attributed segment, exclusive. */ - observation?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation; + endIndex?: string | null; /** - * Search action. + * Citation sources for the attributed segment. */ - searchAction?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction; + sources?: Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource[]; + /** + * Index indicates the start of the segment, measured in bytes (UTF-8 unicode). + */ + startIndex?: string | null; } /** - * Observation. + * Citation source. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerCitationSource { /** - * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. + * ID of the citation source. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult[]; + referenceId?: string | null; } - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult { + /** + * Request message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest { /** - * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. + * Answer generation specification. */ - chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo[]; + answerGenerationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec; /** - * Document resource name. + * Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */ - document?: string | null; + asynchronousMode?: boolean | null; /** - * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. + * Required. Current user query. */ - snippetInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[]; + query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; /** - * Title. + * Query understanding specification. */ - title?: string | null; + queryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec; /** - * URI for the document. + * Related questions specification. */ - uri?: string | null; - } - /** - * Chunk information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo { + relatedQuestionsSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec; /** - * Chunk resource name. + * Model specification. */ - chunk?: string | null; + safetySpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec; /** - * Chunk textual content. + * Search specification. */ - content?: string | null; + searchSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec; /** - * Relevance score. + * The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */ - relevanceScore?: number | null; - } - /** - * Snippet information. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo { + session?: string | null; /** - * Snippet content. + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - snippet?: string | null; + userLabels?: {[key: string]: string} | null; /** - * Status of the snippet defined by the search team. + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - snippetStatus?: string | null; + userPseudoId?: string | null; } /** - * Search action. + * Answer generation specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpec { /** - * The query to search. + * Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */ - query?: string | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { + answerLanguageCode?: string | null; /** - * Operation create time. + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating answers for adversarial queries and return fallback messages instead. */ - createTime?: string | null; + ignoreAdversarialQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Specifies whether to filter out queries that have low relevance. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true` or unset, the behavior will be determined automatically by the service. */ - updateTime?: string | null; + ignoreLowRelevantContent?: boolean | null; + /** + * Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. + */ + ignoreNonAnswerSeekingQuery?: boolean | null; + /** + * Specifies whether to include citation metadata in the answer. The default value is `false`. + */ + includeCitations?: boolean | null; + /** + * Answer generation model specification. + */ + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec; + /** + * Answer generation prompt specification. + */ + promptSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec; } /** - * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + * Answer Generation Model specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecModelSpec { /** - * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. + * Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. */ - requests?: Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest[]; + modelVersion?: string | null; } /** - * Response message for SiteSearchEngineService.BatchCreateTargetSites method. + * Answer generation prompt specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestAnswerGenerationSpecPromptSpec { /** - * TargetSites created. + * Customized preamble. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + preamble?: string | null; } /** - * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {} - /** - * BigQuery source import data from. + * Query understanding specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource { - /** - * 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. - */ - dataSchema?: string | null; - /** - * Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. - */ - datasetId?: string | null; - /** - * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. - */ - gcsStagingDir?: string | null; - /** - * BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. - */ - partitionDate?: Schema$GoogleTypeDate; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpec { /** - * The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * Query classification specification. */ - projectId?: string | null; + queryClassificationSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec; /** - * Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. + * Query rephraser specification. */ - tableId?: string | null; + queryRephraserSpec?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec; } /** - * The Bigtable Options object that contains information to support the import. + * Query classification specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions { - /** - * The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. - */ - families?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily; - } | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec { /** - * The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. + * Enabled query classification types. */ - keyFieldName?: string | null; + types?: string[] | null; } /** - * The column of the Bigtable. + * Query rephraser specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec { /** - * The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. + * Disable query rephraser. */ - encoding?: string | null; + disable?: boolean | null; /** - * The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. + * Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. */ - fieldName?: string | null; + maxRephraseSteps?: number | null; + } + /** + * Related questions specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestRelatedQuestionsSpec { /** - * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. + * Enable related questions feature if true. */ - qualifier?: string | null; + enable?: boolean | null; + } + /** + * Safety specification. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSafetySpec { /** - * The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. + * Enable the safety filtering on the answer response. It is false by default. */ - type?: string | null; + enable?: boolean | null; } /** - * The column family of the Bigtable. + * Search specification. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpec { /** - * The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. + * Search parameters. */ - columns?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[]; + searchParams?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams; /** - * The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. + * Search result list. */ - encoding?: string | null; + searchResultList?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList; + } + /** + * Search parameters. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchParams { /** - * The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. + * Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */ - fieldName?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */ - type?: string | null; - } - /** - * The Cloud Bigtable source for importing data. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableSource { + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ - bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions; + filter?: string | null; /** - * Required. The instance ID of the Cloud Bigtable that needs to be imported. + * Number of search results to return. The default value is 10. */ - instanceId?: string | null; + maxReturnResults?: number | null; /** - * The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - projectId?: string | null; + orderBy?: string | null; /** - * Required. The table ID of the Cloud Bigtable that needs to be imported. + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) */ - tableId?: string | null; + searchResultMode?: string | null; } /** - * Request message for GroundedGenerationService.CheckGrounding method. + * Search result list. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest { - /** - * Answer candidate to check. Can have a maximum length of 1024 characters. - */ - answerCandidate?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultList { /** - * List of facts for the grounding check. We support up to 200 facts. + * Search results. */ - facts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[]; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult[]; + } + /** + * Search result. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResult { /** - * Configuration of the grounding check. + * Chunk information. */ - groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec; + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo; /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + * Unstructured document information. */ - userLabels?: {[key: string]: string} | null; + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo; } /** - * Response message for the GroundedGenerationService.CheckGrounding method. + * Chunk information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse { - /** - * List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. - */ - citedChunks?: Schema$GoogleCloudDiscoveryengineV1betaFactChunk[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo { /** - * Claim texts and citation info across all claims in the answer candidate. + * Chunk resource name. */ - claims?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[]; + chunk?: string | null; /** - * The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. + * Chunk textual content. */ - supportScore?: number | null; + content?: string | null; } /** - * Text and citation info for a claim in the answer candidate. + * Unstructured document information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo { /** - * A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. + * Document resource name. */ - citationIndices?: number[] | null; + document?: string | null; /** - * Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. + * List of document contexts. */ - claimText?: string | null; + documentContexts?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[]; /** - * Position indicating the end of the claim in the answer candidate, exclusive. + * List of extractive answers. */ - endPos?: number | null; + extractiveAnswers?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[]; /** - * Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. + * List of extractive segments. */ - groundingCheckRequired?: boolean | null; + extractiveSegments?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[]; /** - * Position indicating the start of the claim in the answer candidate, measured in bytes. + * Title. */ - startPos?: number | null; + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; } /** - * Specification for the grounding check. + * Document context. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext { /** - * The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. + * Document content. */ - citationThreshold?: number | null; + content?: string | null; + /** + * Page identifier. + */ + pageIdentifier?: string | null; } /** - * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. + * Extractive answer. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#get-answers) */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunk { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer { /** - * Output only. Metadata of the current chunk. + * Extractive answer content. */ - chunkMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata; + content?: string | null; /** - * Content is a string from a document (parsed content). + * Page identifier. */ - content?: string | null; + pageIdentifier?: string | null; + } + /** + * Extractive segment. [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments) + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment { /** - * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + * Extractive segment content. */ - derivedStructData?: {[key: string]: any} | null; + content?: string | null; /** - * Metadata of the document from the current chunk. + * Page identifier. */ - documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata; + pageIdentifier?: string | null; + } + /** + * Response message for ConversationalSearchService.AnswerQuery method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryResponse { /** - * Unique chunk ID of the current chunk. + * Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */ - id?: string | null; + answer?: Schema$GoogleCloudDiscoveryengineV1betaAnswer; /** - * The full resource name of the chunk. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}/chunks/{chunk_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * A global unique ID used for logging. */ - name?: string | null; + answerQueryToken?: string | null; /** - * Page span of the chunk. + * Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */ - pageSpan?: Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan; + session?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + /** + * Query understanding information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfo { /** - * Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. + * Query classification information. */ - relevanceScore?: number | null; + queryClassificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo[]; } /** - * Metadata of the current chunk. This field is only populated on SearchService.Search API. + * Query classification information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryUnderstandingInfoQueryClassificationInfo { /** - * The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. + * Classification output. */ - nextChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; + positive?: boolean | null; /** - * The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. + * Query classification type. */ - previousChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; + type?: string | null; } /** - * Document metadata contains the information of the document of the current chunk. + * Reference. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReference { /** - * Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * Chunk information. */ - structData?: {[key: string]: any} | null; + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo; /** - * Title of the document. + * Structured document information. */ - title?: string | null; + structuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo; /** - * Uri of the document. + * Unstructured document information. */ - uri?: string | null; + unstructuredDocumentInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo; } /** - * Page span of the chunk. + * Chunk information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfo { /** - * The end page of the chunk. + * Chunk resource name. */ - pageEnd?: number | null; + chunk?: string | null; /** - * The start page of the chunk. + * Chunk textual content. */ - pageStart?: number | null; + content?: string | null; + /** + * Document metadata. + */ + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata; + /** + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. + */ + relevanceScore?: number | null; } /** - * Cloud SQL source import data from. + * Document metadata. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource { - /** - * Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. - */ - databaseId?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceChunkInfoDocumentMetadata { /** - * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + * Document resource name. */ - gcsStagingDir?: string | null; + document?: string | null; /** - * Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. + * Page identifier. */ - instanceId?: string | null; + pageIdentifier?: string | null; /** - * Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */ - offload?: boolean | null; + structData?: {[key: string]: any} | null; /** - * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * Title. */ - projectId?: string | null; + title?: string | null; /** - * Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. + * URI for the document. */ - tableId?: string | null; + uri?: string | null; } /** - * Response message for CompletionService.CompleteQuery method. + * Structured search information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceStructuredDocumentInfo { /** - * Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. + * Document resource name. */ - querySuggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion[]; + document?: string | null; /** - * True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. + * Structured search data. */ - tailMatchTriggered?: boolean | null; + structData?: {[key: string]: any} | null; } /** - * Suggestions as search queries. + * Unstructured document information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfo { /** - * The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. + * List of cited chunk contents derived from document content. */ - completableFieldPaths?: string[] | null; + chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent[]; /** - * The suggestion for the query. + * Document resource name. */ - suggestion?: string | null; - } - /** - * Detailed completion information including completion attribution token and clicked completion info. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo { + document?: string | null; /** - * End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. + * The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result. */ - selectedPosition?: number | null; + structData?: {[key: string]: any} | null; /** - * End user selected CompleteQueryResponse.QuerySuggestion.suggestion. + * Title. */ - selectedSuggestion?: string | null; + title?: string | null; + /** + * URI for the document. + */ + uri?: string | null; } /** - * Autocomplete suggestions that are imported from Customer. + * Chunk content. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerReferenceUnstructuredDocumentInfoChunkContent { /** - * Alternative matching phrases for this suggestion. + * Chunk textual content. */ - alternativePhrases?: string[] | null; + content?: string | null; /** - * Frequency of this suggestion. Will be used to rank suggestions when score is not available. + * Page identifier. */ - frequency?: string | null; + pageIdentifier?: string | null; /** - * Global score of this suggestion. Control how this suggestion would be scored / ranked. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ - globalScore?: number | null; + relevanceScore?: number | null; + } + /** + * Step information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStep { /** - * If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions. + * Actions. */ - groupId?: string | null; + actions?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction[]; /** - * The score of this suggestion within its group. + * The description of the step. */ - groupScore?: number | null; + description?: string | null; /** - * BCP-47 language code of this suggestion. + * The state of the step. */ - languageCode?: string | null; + state?: string | null; /** - * Required. The suggestion text. + * The thought of the step. */ - suggestion?: string | null; + thought?: string | null; } /** - * Defines circumstances to be checked before allowing a behavior + * Action. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepAction { /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + * Observation. */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; + observation?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation; /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * Search action. */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; + searchAction?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction; } /** - * Matcher for search request query + * Observation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { - /** - * Whether the search query needs to exactly match the query term. - */ - fullMatch?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservation { /** - * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + * Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. */ - value?: string | null; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult[]; } - /** - * Used for time-dependent conditions. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResult { /** - * End of time range. Range is inclusive. Must be in the future. + * If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. */ - endTime?: string | null; + chunkInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo[]; /** - * Start of time range. Range is inclusive. + * Document resource name. */ - startTime?: string | null; - } - /** - * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControl { + document?: string | null; /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */ - associatedServingConfigIds?: string[] | null; + snippetInfo?: Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo[]; /** - * Defines a boost-type control + * Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; + structData?: {[key: string]: any} | null; /** - * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. + * Title. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; + title?: string | null; /** - * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. + * URI for the document. */ - displayName?: string | null; + uri?: string | null; + } + /** + * Chunk information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultChunkInfo { /** - * Defines a filter-type control Currently not supported by Recommendation + * Chunk resource name. */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; + chunk?: string | null; /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Chunk textual content. */ - name?: string | null; + content?: string | null; /** - * Defines a redirect-type control. + * The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; + relevanceScore?: number | null; + } + /** + * Snippet information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionObservationSearchResultSnippetInfo { /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * Snippet content. */ - solutionType?: string | null; + snippet?: string | null; /** - * Treats a group of terms as synonyms of one another. + * Status of the snippet defined by the search team. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; + snippetStatus?: string | null; + } + /** + * Search action. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaAnswerStepActionSearchAction { /** - * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. + * The query to search. */ - useCases?: string[] | null; + query?: string | null; } /** - * Adjusts order of products in returned list. + * Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * Operation create time. */ - boost?: number | null; + createTime?: string | null; /** - * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * Operation last update time. If the operation is done, this is also the finish time. */ - dataStore?: string | null; + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.BatchCreateTargetSites method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest { /** - * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch. */ - filter?: string | null; + requests?: Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest[]; } /** - * Specified which products may be included in results. Uses same filter as boost. + * Response message for SiteSearchEngineService.BatchCreateTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse { /** - * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * TargetSites created. */ - dataStore?: string | null; + targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + } + /** + * Response message for DocumentService.BatchGetDocumentsMetadata method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponse { /** - * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * The metadata of the Documents. */ - filter?: string | null; + documentsMetadata?: Schema$GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata[]; } /** - * Redirects a shopper to the provided URI. + * The metadata of a Document. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadata { /** - * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * The timestamp of the last time the Document was last indexed. */ - redirectUri?: string | null; + lastRefreshedTime?: string | null; + /** + * The value of the matcher that was used to match the Document. + */ + matcherValue?: Schema$GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue; + /** + * The status of the document. + */ + status?: string | null; } /** - * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". + * The value of the matcher that was used to match the Document. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchGetDocumentsMetadataResponseDocumentMetadataMatcherValue { /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * If match by URI, the URI of the Document. */ - synonyms?: string[] | null; + uri?: string | null; } /** - * External conversation proto definition. + * Request message for SiteSearchEngineService.BatchVerifyTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConversation { + export interface Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest {} + /** + * BigQuery source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource { /** - * Output only. The time the conversation finished. + * 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. */ - endTime?: string | null; + dataSchema?: string | null; /** - * Conversation messages. + * Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters. */ - messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[]; + datasetId?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory. */ - name?: string | null; + gcsStagingDir?: string | null; /** - * Output only. The time the conversation started. + * BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. */ - startTime?: string | null; + partitionDate?: Schema$GoogleTypeDate; /** - * The state of the Conversation. + * The project ID or the project number that contains the BigQuery source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - state?: string | null; + projectId?: string | null; /** - * A unique identifier for tracking users. + * Required. The BigQuery table to copy the data from with a length limit of 1,024 characters. */ - userPseudoId?: string | null; + tableId?: string | null; } /** - * Defines context of the conversation + * The Bigtable Options object that contains information to support the import. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConversationContext { + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions { /** - * The current active document the user opened. It contains the document resource reference. + * The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored. */ - activeDocument?: string | null; + families?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily; + } | null; /** - * The current list of documents the user is seeing. It contains the document resource references. + * The field name used for saving row key value in the document. The name has to match the pattern `a-zA-Z0-9*`. */ - contextDocuments?: string[] | null; + keyFieldName?: string | null; } /** - * Defines a conversation message. + * The column of the Bigtable. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConversationMessage { + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn { /** - * Output only. Message creation timestamp. + * The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. */ - createTime?: string | null; + encoding?: string | null; /** - * Search reply. + * The field name to use for this column in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. */ - reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; + fieldName?: string | null; /** - * User text input. + * Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead. */ - userInput?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; + qualifier?: string | null; + /** + * The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. + */ + type?: string | null; } /** - * Request message for ConversationalSearchService.ConverseConversation method. + * The column family of the Bigtable. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumnFamily { /** - * Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) + * The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + columns?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptionsBigtableColumn[]; /** - * The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. + * The encoding mode of the values when the type is not STRING. Acceptable encoding values are: * `TEXT`: indicates values are alphanumeric text strings. * `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it. */ - conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + encoding?: string | null; /** - * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * The field name to use for this column family in the document. The name has to match the pattern `a-zA-Z0-9*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined. */ - filter?: string | null; + fieldName?: string | null; /** - * Required. Current user input. + * The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`. */ - query?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; + type?: string | null; + } + /** + * The Cloud Bigtable source for importing data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaBigtableSource { /** - * Whether to turn on safe search. + * Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations. */ - safeSearch?: boolean | null; + bigtableOptions?: Schema$GoogleCloudDiscoveryengineV1betaBigtableOptions; /** - * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. + * Required. The instance ID of the Cloud Bigtable that needs to be imported. */ - servingConfig?: string | null; + instanceId?: string | null; /** - * A specification for configuring the summary returned in the response. + * The project ID that contains the Bigtable source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; + projectId?: string | null; /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + * Required. The table ID of the Cloud Bigtable that needs to be imported. */ - userLabels?: {[key: string]: string} | null; + tableId?: string | null; } /** - * Response message for ConversationalSearchService.ConverseConversation method. + * Request message for GroundedGenerationService.CheckGrounding method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest { /** - * Updated conversation including the answer. + * Answer candidate to check. Can have a maximum length of 1024 characters. */ - conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + answerCandidate?: string | null; /** - * Suggested related questions. + * List of facts for the grounding check. We support up to 200 facts. */ - relatedQuestions?: string[] | null; + facts?: Schema$GoogleCloudDiscoveryengineV1betaGroundingFact[]; /** - * Answer to the current query. + * Configuration of the grounding check. */ - reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; + groundingSpec?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec; /** - * Search Results. + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; + userLabels?: {[key: string]: string} | null; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Response message for the GroundedGenerationService.CheckGrounding method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponse { /** - * Operation create time. + * List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */ - createTime?: string | null; + citedChunks?: Schema$GoogleCloudDiscoveryengineV1betaFactChunk[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Claim texts and citation info across all claims in the answer candidate. */ - updateTime?: string | null; + claims?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim[]; + /** + * The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. + */ + supportScore?: number | null; } /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Text and citation info for a claim in the answer candidate. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingResponseClaim { /** - * Operation create time. + * A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. */ - createTime?: string | null; + citationIndices?: number[] | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. */ - updateTime?: string | null; - } - /** - * Metadata for Create Schema LRO. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { + claimText?: string | null; /** - * Operation create time. + * Position indicating the end of the claim in the answer candidate, exclusive. */ - createTime?: string | null; + endPos?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { + groundingCheckRequired?: boolean | null; /** - * Operation create time. + * Confidence score for the claim in the answer candidate, in the range of [0, 1]. */ - createTime?: string | null; + score?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Position indicating the start of the claim in the answer candidate, measured in bytes. */ - updateTime?: string | null; + startPos?: number | null; } /** - * Request message for SiteSearchEngineService.CreateTargetSite method. + * Specification for the grounding check. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingSpec { /** - * Required. The TargetSite to create. + * The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */ - targetSite?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + citationThreshold?: number | null; } /** - * A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent. + * Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute { + export interface Schema$GoogleCloudDiscoveryengineV1betaChunk { /** - * The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Output only. Metadata of the current chunk. */ - numbers?: number[] | null; + chunkMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata; /** - * The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Content is a string from a document (parsed content). */ - text?: string[] | null; - } - /** - * Metadata that describes a custom tuned model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { + content?: string | null; /** - * Timestamp the Model was created at. + * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ - createTime?: string | null; + derivedStructData?: {[key: string]: any} | null; /** - * The display name of the model. + * Metadata of the document from the current chunk. */ - displayName?: string | null; + documentMetadata?: Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata; /** - * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). + * Unique chunk ID of the current chunk. */ - modelState?: string | null; + id?: string | null; /** - * The version of the model. + * The full resource name of the chunk. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}/chunks/{chunk_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - modelVersion?: string | null; + name?: string | null; /** - * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. + * Page span of the chunk. */ - name?: string | null; + pageSpan?: Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan; /** - * Timestamp the model training was initiated. + * Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. */ - trainingStartTime?: string | null; + relevanceScore?: number | null; } /** - * DataStore captures global settings and configs at the DataStore level. + * Metadata of the current chunk. This field is only populated on SearchService.Search API. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { - /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. - */ - contentConfig?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkChunkMetadata { /** - * Output only. Timestamp the DataStore was created at. + * The next chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks. This field is only populated on SearchService.Search API. */ - createTime?: string | null; + nextChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; /** - * Output only. The id of the default Schema asscociated to this data store. + * The previous chunks of the current chunk. The number is controlled by SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks. This field is only populated on SearchService.Search API. */ - defaultSchemaId?: string | null; + previousChunks?: Schema$GoogleCloudDiscoveryengineV1betaChunk[]; + } + /** + * Document metadata contains the information of the document of the current chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkDocumentMetadata { /** - * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Data representation. The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ - displayName?: string | null; + structData?: {[key: string]: any} | null; /** - * Configuration for Document understanding and enrichment. + * Title of the document. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; + title?: string | null; /** - * Immutable. The industry vertical that the data store registers. + * Uri of the document. */ - industryVertical?: string | null; + uri?: string | null; + } + /** + * Page span of the chunk. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaChunkPageSpan { /** - * Language info for DataStore. + * The end page of the chunk. */ - languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; + pageEnd?: number | null; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * The start page of the chunk. */ - name?: string | null; + pageStart?: number | null; + } + /** + * Cloud SQL source import data from. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource { /** - * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. + * Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */ - solutionTypes?: string[] | null; + databaseId?: string | null; /** - * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { + gcsStagingDir?: string | null; /** - * Operation create time. + * Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters. */ - createTime?: string | null; + instanceId?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Option for serverless export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/sql/pricing#serverless). */ - updateTime?: string | null; - } - /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { + offload?: boolean | null; /** - * Operation create time. + * The project ID that contains the Cloud SQL source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - createTime?: string | null; + projectId?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */ - updateTime?: string | null; + tableId?: string | null; } /** - * Metadata for DeleteSchema LRO. + * Response message for CompletionService.CompleteQuery method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponse { /** - * Operation create time. + * Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */ - createTime?: string | null; + querySuggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * True if the returned suggestions are all tail suggestions. For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query. */ - updateTime?: string | null; + tailMatchTriggered?: boolean | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Suggestions as search queries. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompleteQueryResponseQuerySuggestion { /** - * Operation create time. + * The unique document field paths that serve as the source of this suggestion if it was generated from completable fields. This field is only populated for the document-completable model. */ - createTime?: string | null; + completableFieldPaths?: string[] | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The suggestion for the query. */ - updateTime?: string | null; + suggestion?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Detailed completion information including completion attribution token and clicked completion info. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo { /** - * Operation create time. + * End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0. */ - createTime?: string | null; + selectedPosition?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * End user selected CompleteQueryResponse.QuerySuggestion.suggestion. */ - updateTime?: string | null; + selectedSuggestion?: string | null; } /** - * Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest {} - /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} - /** - * Document captures all raw metadata information of items to be recommended or searched. + * Autocomplete suggestions that are imported from Customer. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocument { + export interface Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion { /** - * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. + * Alternative matching phrases for this suggestion. */ - content?: Schema$GoogleCloudDiscoveryengineV1betaDocumentContent; + alternativePhrases?: string[] | null; /** - * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. + * Frequency of this suggestion. Will be used to rank suggestions when score is not available. */ - derivedStructData?: {[key: string]: any} | null; + frequency?: string | null; /** - * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + * Global score of this suggestion. Control how this suggestion would be scored / ranked. */ - id?: string | null; + globalScore?: number | null; /** - * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. + * If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions. */ - indexTime?: string | null; + groupId?: string | null; /** - * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * The score of this suggestion within its group. */ - jsonData?: string | null; + groupScore?: number | null; /** - * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * BCP-47 language code of this suggestion. */ - name?: string | null; + languageCode?: string | null; /** - * The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + * Required. The suggestion text. */ - parentDocumentId?: string | null; + suggestion?: string | null; + } + /** + * Defines circumstances to be checked before allowing a behavior + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCondition { /** - * The identifier of the schema located in the same data store. + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. */ - schemaId?: string | null; + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange[]; /** - * The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. + * Search only A list of terms to match the query on. Maximum of 10 query terms. */ - structData?: {[key: string]: any} | null; + queryTerms?: Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm[]; } /** - * Unstructured data linked to this document. + * Matcher for search request query */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentContent { + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionQueryTerm { /** - * The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. + * Whether the search query needs to exactly match the query term. */ - mimeType?: string | null; + fullMatch?: boolean | null; /** - * The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. + * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. */ - rawBytes?: string | null; + value?: string | null; + } + /** + * Used for time-dependent conditions. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConditionTimeRange { /** - * The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. + * End of time range. Range is inclusive. Must be in the future. */ - uri?: string | null; + endTime?: string | null; + /** + * Start of time range. Range is inclusive. + */ + startTime?: string | null; } /** - * Detailed document information associated with a user event. + * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaControl { /** - * The Document resource ID. + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. */ - id?: string | null; + associatedServingConfigIds?: string[] | null; /** - * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` - */ - name?: string | null; - /** - * The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. - */ - promotionIds?: string[] | null; - /** - * Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` + * Defines a boost-type control */ - quantity?: number | null; + boostAction?: Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction; /** - * The Document URI - only allowed for website data stores. + * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. */ - uri?: string | null; - } - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { + conditions?: Schema$GoogleCloudDiscoveryengineV1betaCondition[]; /** - * Whether chunking mode is enabled. + * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; + displayName?: string | null; /** - * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + * Defines a filter-type control Currently not supported by Recommendation */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + filterAction?: Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` */ name?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Defines a redirect-type control. */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; - } | null; - } - /** - * Configuration for chunking config. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { + redirectAction?: Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction; /** - * Configuration for the layout based chunking. + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; - } - /** - * Configuration for the layout based chunking. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + solutionType?: string | null; /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * Treats a group of terms as synonyms of one another. */ - chunkSize?: number | null; + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. */ - includeAncestorHeadings?: boolean | null; + useCases?: string[] | null; } /** - * Related configurations applied to a specific type of document parser. + * Adjusts order of products in returned list. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlBoostAction { /** - * Configurations applied to digital parser. + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; + boost?: number | null; /** - * Configurations applied to layout parser. + * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + dataStore?: string | null; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; + filter?: string | null; } /** - * The digital parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} - /** - * The layout parsing configurations for documents. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} - /** - * The OCR parsing configurations for documents. + * Specified which products may be included in results. Uses same filter as boost. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlFilterAction { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store */ - enhancedDocumentElements?: string[] | null; + dataStore?: string | null; /** - * If true, will use native text instead of OCR text on pages containing native text. + * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - useNativeText?: boolean | null; + filter?: string | null; } /** - * Double list. + * Redirects a shopper to the provided URI. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaDoubleList { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlRedirectAction { /** - * Double values. + * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. */ - values?: number[] | null; + redirectUri?: string | null; } /** - * Defines embedding config, used for bring your own embeddings feature. + * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaControlSynonymsAction { /** - * Full field path in the schema mapped as embedding field. + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. */ - fieldPath?: string | null; + synonyms?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * External conversation proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaConversation { /** - * Operation create time. + * Output only. The time the conversation finished. */ - createTime?: string | null; + endTime?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Conversation messages. */ - updateTime?: string | null; + messages?: Schema$GoogleCloudDiscoveryengineV1betaConversationMessage[]; + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string | null; + /** + * Output only. The time the conversation started. + */ + startTime?: string | null; + /** + * The state of the Conversation. + */ + state?: string | null; + /** + * A unique identifier for tracking users. + */ + userPseudoId?: string | null; } /** - * Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest {} - /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} - /** - * Metadata that describes the training and serving parameters of an Engine. + * Defines context of the conversation */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { + export interface Schema$GoogleCloudDiscoveryengineV1betaConversationContext { /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * The current active document the user opened. It contains the document resource reference. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; + activeDocument?: string | null; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * The current list of documents the user is seeing. It contains the document resource references. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; + contextDocuments?: string[] | null; + } + /** + * Defines a conversation message. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConversationMessage { /** - * Common config spec that specifies the metadata of the engine. + * Output only. Message creation timestamp. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; + createTime?: string | null; /** - * Output only. Timestamp the Recommendation Engine was created at. + * Search reply. */ - createTime?: string | null; + reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * User text input. */ - dataStoreIds?: string[] | null; + userInput?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; + } + /** + * Request message for ConversationalSearchService.ConverseConversation method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest { /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */ - displayName?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + * The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session. */ - industryVertical?: string | null; + conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ - name?: string | null; + filter?: string | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * Required. Current user input. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; + query?: Schema$GoogleCloudDiscoveryengineV1betaTextInput; /** - * Required. The solutions of the engine. + * Whether to turn on safe search. */ - solutionType?: string | null; + safeSearch?: boolean | null; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * The resource name of the Serving Config to use. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/servingConfigs/{serving_config_id\}` If this is not set, the default serving config will be used. */ - updateTime?: string | null; - } - /** - * Configurations for a Chat Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { + servingConfig?: string | null; /** - * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + * A specification for configuring the summary returned in the response. */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; /** - * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - dialogflowAgentToLink?: string | null; + userLabels?: {[key: string]: string} | null; } /** - * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + * Response message for ConversationalSearchService.ConverseConversation method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaConverseConversationResponse { /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * Updated conversation including the answer. */ - business?: string | null; + conversation?: Schema$GoogleCloudDiscoveryengineV1betaConversation; /** - * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + * Suggested related questions. */ - defaultLanguageCode?: string | null; + relatedQuestions?: string[] | null; /** - * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + * Answer to the current query. */ - location?: string | null; + reply?: Schema$GoogleCloudDiscoveryengineV1betaReply; /** - * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + * Search Results. */ - timeZone?: string | null; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; } /** - * Additional information of a Chat Engine. Fields in this message are output only. + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata { /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * Operation create time. */ - dialogflowAgent?: string | null; - } - /** - * Common configurations for an Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { + createTime?: string | null; /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * Operation last update time. If the operation is done, this is also the finish time. */ - companyName?: string | null; + updateTime?: string | null; } /** - * Configurations for a Search Engine. + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEngineMetadata { /** - * The add-on that this search engine enables. + * Operation create time. */ - searchAddOns?: string[] | null; + createTime?: string | null; /** - * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + * Operation last update time. If the operation is done, this is also the finish time. */ - searchTier?: string | null; + updateTime?: string | null; } /** - * Fact Chunk. + * Metadata for EvaluationService.CreateEvaluation method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFactChunk { + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata {} + /** + * Metadata for Create Schema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata { /** - * Text content of the fact chunk. Can be at most 10K characters long. + * Operation create time. */ - chunkText?: string | null; + createTime?: string | null; /** - * The index of this chunk. Currently, only used for the streaming mode. + * Operation last update time. If the operation is done, this is also the finish time. */ - index?: number | null; + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata { /** - * Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. + * Operation create time. */ - source?: string | null; + createTime?: string | null; /** - * More fine-grained information for the source reference. + * Operation last update time. If the operation is done, this is also the finish time. */ - sourceMetadata?: {[key: string]: string} | null; + updateTime?: string | null; } /** - * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. + * Request message for SiteSearchEngineService.CreateTargetSite method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse { - /** - * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaCreateTargetSiteRequest { /** - * List of TargetSites containing the site verification status. + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. */ - targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; + parent?: string | null; /** - * The total number of items matching the request. This will always be populated in the response. + * Required. The TargetSite to create. */ - totalSize?: number | null; + targetSite?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; } /** - * Cloud FhirStore source import data from. + * A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute { /** - * Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}`. + * The numerical values of this custom attribute. For example, `[2.3, 15.4]` when the key is "lengths_cm". Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - fhirStore?: string | null; + numbers?: number[] | null; /** - * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. + * The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - gcsStagingDir?: string | null; + text?: string[] | null; } /** - * Firestore source import data from. + * Metadata that describes a custom tuned model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel { /** - * Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. + * Timestamp the Model was created at. */ - collectionId?: string | null; + createTime?: string | null; /** - * Required. The Firestore database to copy the data from with a length limit of 256 characters. + * The display name of the model. */ - databaseId?: string | null; + displayName?: string | null; /** - * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. + * The metrics of the trained model. */ - gcsStagingDir?: string | null; + metrics?: {[key: string]: number} | null; /** - * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */ - projectId?: string | null; - } - /** - * Cloud Storage location for input content. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource { + modelState?: string | null; /** - * 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 the GENERIC Data Store vertical. * `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 the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. + * The version of the model. */ - dataSchema?: string | null; + modelVersion?: string | null; /** - * Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/x.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). + * Required. The fully qualified resource name of the model. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/customTuningModels/{custom_tuning_model\}` model must be an alpha-numerical string with limit of 40 characters. */ - inputUris?: string[] | null; + name?: string | null; + /** + * Timestamp the model training was initiated. + */ + trainingStartTime?: string | null; } /** - * Grounding Fact. + * DataStore captures global settings and configs at the DataStore level. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact { + export interface Schema$GoogleCloudDiscoveryengineV1betaDataStore { /** - * Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */ - attributes?: {[key: string]: string} | null; + contentConfig?: string | null; /** - * Text content of the fact. Can be at most 10K characters long. + * Output only. Timestamp the DataStore was created at. */ - factText?: string | null; - } - /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { + createTime?: string | null; /** - * Operation create time. + * Output only. The id of the default Schema asscociated to this data store. */ - createTime?: string | null; + defaultSchemaId?: string | null; /** - * Count of CompletionSuggestions that failed to be imported. + * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ - failureCount?: string | null; + displayName?: string | null; /** - * Count of CompletionSuggestions successfully imported. + * Configuration for Document understanding and enrichment. */ - successCount?: string | null; + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Immutable. The industry vertical that the data store registers. */ - updateTime?: string | null; - } - /** - * Request message for CompletionService.ImportCompletionSuggestions method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest { + industryVertical?: string | null; /** - * BigQuery input source. + * Language info for DataStore. */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; + languageInfo?: Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo; /** - * The desired location of errors incurred during the Import. + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + name?: string | null; /** - * Cloud Storage location for the input content. + * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + solutionTypes?: string[] | null; /** - * The Inline source for suggestion entries. + * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource; + startingSchema?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig; } /** - * The inline source for CompletionSuggestions. + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata { /** - * Required. A list of all denylist entries to import. Max of 1000 items. + * Operation create time. */ - suggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion[]; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata { /** - * The desired location of errors incurred during the Import. + * Operation create time. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + createTime?: string | null; /** - * A sample of errors encountered while processing the request. + * Operation last update time. If the operation is done, this is also the finish time. */ - errorSamples?: Schema$GoogleRpcStatus[]; + updateTime?: string | null; } /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata for DeleteSchema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata { /** * Operation create time. */ createTime?: string | null; /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. + * Operation last update time. If the operation is done, this is also the finish time. */ - successCount?: string | null; + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata { /** - * Total count of entries that were processed. + * Operation create time. */ - totalCount?: string | null; + createTime?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for Import methods. + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata { /** - * AlloyDB input source. + * Operation create time. */ - alloyDbSource?: Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource; + createTime?: string | null; /** - * 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. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + * Operation last update time. If the operation is done, this is also the finish time. */ - autoGenerateIds?: boolean | null; + updateTime?: string | null; + } + /** + * Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest {} + /** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse {} + /** + * Document captures all raw metadata information of items to be recommended or searched. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocument { /** - * BigQuery input source. + * The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store. */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; + content?: Schema$GoogleCloudDiscoveryengineV1betaDocumentContent; /** - * Cloud Bigtable input source. + * Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. */ - bigtableSource?: Schema$GoogleCloudDiscoveryengineV1betaBigtableSource; + derivedStructData?: {[key: string]: any} | null; /** - * Cloud SQL input source. + * Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ - cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource; + id?: string | null; /** - * The desired location of errors incurred during the Import. + * Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + indexTime?: string | null; /** - * FhirStore input source. + * The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ - fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource; + jsonData?: string | null; /** - * Firestore input source. + * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - firestoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource; + name?: string | null; /** - * Cloud Storage location for the input content. + * The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + parentDocumentId?: string | null; /** - * The field indicates the ID field or column to be used as 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 others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table 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 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. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. + * The identifier of the schema located in the same data store. */ - idField?: string | null; + schemaId?: string | null; /** - * The Inline source for the input content for documents. + * The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource; + structData?: {[key: string]: any} | null; + } + /** + * Unstructured data linked to this document. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentContent { /** - * The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. + * The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml. */ - reconciliationMode?: string | null; + mimeType?: string | null; /** - * Spanner input source. + * The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json. */ - spannerSource?: Schema$GoogleCloudDiscoveryengineV1betaSpannerSource; + rawBytes?: string | null; /** - * Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. + * The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats. */ - updateMask?: string | null; + uri?: string | null; } /** - * The inline source for the input config for ImportDocuments method. + * Detailed document information associated with a user event. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo { /** - * Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. + * The Document resource ID. */ - documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; + id?: string | null; + /** + * Output only. Whether the referenced Document can be found in the data store. + */ + joined?: boolean | null; + /** + * The Document resource full name, of the form: `projects/{project_id\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/branches/{branch_id\}/documents/{document_id\}` + */ + name?: string | null; + /** + * The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. + */ + promotionIds?: string[] | null; + /** + * Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` + */ + quantity?: number | null; + /** + * The Document URI - only allowed for website data stores. + */ + uri?: string | null; } /** - * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig { /** - * Echoes the destination for the complete errors in the request if set. + * Whether chunking mode is enabled. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig; /** - * A sample of errors encountered while processing the request. + * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. */ - errorSamples?: Schema$GoogleRpcStatus[]; + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string | null; + /** + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + */ + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig; + } | null; } /** - * Configuration of destination for Import related errors. + * Configuration for chunking config. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig { /** - * 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. + * Configuration for the layout based chunking. */ - gcsPrefix?: string | null; + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; } /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Configuration for the layout based chunking. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { /** - * Operation create time. + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. */ - createTime?: string | null; + chunkSize?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. */ - updateTime?: string | null; + includeAncestorHeadings?: boolean | null; } /** - * Request message for CompletionService.ImportSuggestionDenyListEntries method. + * Related configurations applied to a specific type of document parser. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig { /** - * Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line. + * Configurations applied to digital parser. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig; /** - * The Inline source for the input content for suggestion deny list entries. + * Configurations applied to layout parser. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource; + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig; + /** + * Configurations applied to OCR parser. Currently it only applies to PDFs. + */ + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig; } /** - * The inline source for SuggestionDenyListEntry. + * The digital parsing configurations for documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig { /** - * Required. A list of all denylist entries to import. Max of 1000 items. + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. */ - entries?: Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry[]; + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * Double list. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaDoubleList { /** - * Count of deny list entries that failed to be imported. + * Double values. */ - failedEntriesCount?: string | null; + values?: number[] | null; + } + /** + * Defines embedding config, used for bring your own embeddings feature. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig { /** - * Count of deny list entries successfully imported. + * Full field path in the schema mapped as embedding field. */ - importedEntriesCount?: string | null; + fieldPath?: string | null; } /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata { /** * Operation create time. */ createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were processed successfully. - */ - successCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for the ImportUserEvents request. + * Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest {} + /** + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngine { /** - * BigQuery input source. + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig; /** - * The desired location of errors incurred during the Import. Cannot be set for inline user event imports. + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata; /** - * Cloud Storage location for the input content. + * Common config spec that specifies the metadata of the engine. */ - gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + commonConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig; /** - * The Inline source for the input content for UserEvents. + * Output only. Timestamp the Recommendation Engine was created at. */ - inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource; - } - /** - * The inline source for the input config for ImportUserEvents method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource { + createTime?: string | null; /** - * Required. A list of user events to import. Recommended max of 10k items. + * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. */ - userEvents?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent[]; - } - /** - * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { + dataStoreIds?: string[] | null; /** - * Echoes the destination for the complete errors if this field was set in the request. + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + displayName?: string | null; /** - * A sample of errors encountered while processing the request. + * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */ - errorSamples?: Schema$GoogleRpcStatus[]; + industryVertical?: string | null; /** - * Count of user events imported with complete existing Documents. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ - joinedEventsCount?: string | null; + name?: string | null; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. */ - unjoinedEventsCount?: string | null; - } - /** - * A floating point interval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig; /** - * Exclusive upper bound. + * Required. The solutions of the engine. */ - exclusiveMaximum?: number | null; + solutionType?: string | null; /** - * Exclusive lower bound. + * Output only. Timestamp the Recommendation Engine was last updated. */ - exclusiveMinimum?: number | null; + updateTime?: string | null; + } + /** + * Configurations for a Chat Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig { /** - * Inclusive upper bound. + * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */ - maximum?: number | null; + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig; /** - * Inclusive lower bound. + * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. */ - minimum?: number | null; + dialogflowAgentToLink?: string | null; } /** - * Language info for DataStore. + * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig { /** - * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. */ - language?: string | null; + business?: string | null; /** - * The language code for the DataStore. + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. */ - languageCode?: string | null; + defaultLanguageCode?: string | null; /** - * Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`. + * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. */ - normalizedLanguageCode?: string | null; + location?: string | null; /** - * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. + * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */ - region?: string | null; + timeZone?: string | null; } /** - * Response for ListControls method. + * Additional information of a Chat Engine. Fields in this message are output only. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListControlsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata { /** - * All the Controls for a given data store. + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. */ - controls?: Schema$GoogleCloudDiscoveryengineV1betaControl[]; + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineCommonConfig { /** - * Pagination token, if not returned indicates the last page. + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. */ - nextPageToken?: string | null; + companyName?: string | null; } /** - * Response for ListConversations method. + * Configurations for a Search Engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig { /** - * All the Conversations for a given data store. + * The add-on that this search engine enables. */ - conversations?: Schema$GoogleCloudDiscoveryengineV1betaConversation[]; + searchAddOns?: string[] | null; /** - * Pagination token, if not returned indicates the last page. + * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */ - nextPageToken?: string | null; + searchTier?: string | null; } /** - * Response message for SearchTuningService.ListCustomModels method. + * An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluation { /** - * List of custom tuning models. + * Output only. Timestamp the Evaluation was created at. */ - models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; - } - /** - * Response message for DataStoreService.ListDataStores method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse { + createTime?: string | null; /** - * All the customer's DataStores. + * Output only. Timestamp the Evaluation was completed at. */ - dataStores?: Schema$GoogleCloudDiscoveryengineV1betaDataStore[]; + endTime?: string | null; /** - * A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + * Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED. */ - nextPageToken?: string | null; - } - /** - * Response message for DocumentService.ListDocuments method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListDocumentsResponse { + error?: Schema$GoogleRpcStatus; /** - * The Documents. + * Output only. A sample of errors encountered while processing the request. */ - documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + * Required. The specification of the evaluation. */ - nextPageToken?: string | null; - } - /** - * Response message for EngineService.ListEngines method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse { + evaluationSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec; /** - * All the customer's Engines. + * Identifier. The full resource name of the Evaluation, in the format of `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - engines?: Schema$GoogleCloudDiscoveryengineV1betaEngine[]; + name?: string | null; /** - * Not supported. + * Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */ - nextPageToken?: string | null; + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; + /** + * Output only. The state of the evaluation. + */ + state?: string | null; } /** - * Response message for SchemaService.ListSchemas method. + * Describes the specification of the evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListSchemasResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec { /** - * A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + * Required. The specification of the query set. */ - nextPageToken?: string | null; + querySetSpec?: Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec; /** - * The Schemas. + * Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id */ - schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[]; + searchRequest?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; } /** - * Response for ListServingConfigs method. + * Describes the specification of the query set. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse { - /** - * Pagination token, if not returned indicates the last page. - */ - nextPageToken?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec { /** - * All the ServingConfigs for a given dataStore. + * Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[]; + sampleQuerySet?: string | null; } /** - * Response for ListSessions method. + * Fact Chunk. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaFactChunk { /** - * Pagination token, if not returned indicates the last page. + * Text content of the fact chunk. Can be at most 10K characters long. */ - nextPageToken?: string | null; + chunkText?: string | null; /** - * All the Sessions for a given data store. + * The index of this chunk. Currently, only used for the streaming mode. */ - sessions?: Schema$GoogleCloudDiscoveryengineV1betaSession[]; + index?: number | null; + /** + * Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. + */ + source?: string | null; + /** + * More fine-grained information for the source reference. + */ + sourceMetadata?: {[key: string]: string} | null; } /** - * Response message for SiteSearchEngineService.ListTargetSites method. + * Response message for SiteSearchEngineService.FetchDomainVerificationStatus method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaFetchDomainVerificationStatusResponse { /** * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ nextPageToken?: string | null; /** - * List of TargetSites. + * List of TargetSites containing the site verification status. */ targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; /** @@ -4373,137 +4716,137 @@ export namespace discoveryengine_v1beta { totalSize?: number | null; } /** - * Media-specific user event information. + * Cloud FhirStore source import data from. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaMediaInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource { /** - * The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. + * Required. The full resource name of the FHIR store to import data from, in the format of `projects/{project\}/locations/{location\}/datasets/{dataset\}/fhirStores/{fhir_store\}`. */ - mediaProgressDuration?: string | null; + fhirStore?: string | null; /** - * Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. + * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */ - mediaProgressPercentage?: number | null; + gcsStagingDir?: string | null; + /** + * The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. + */ + resourceTypes?: string[] | null; } /** - * Detailed page information. + * Firestore source import data from. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPageInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource { /** - * The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, 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. + * Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */ - pageCategory?: string | null; + collectionId?: string | null; /** - * 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. + * Required. The Firestore database to copy the data from with a length limit of 256 characters. */ - pageviewId?: string | null; + databaseId?: string | null; /** - * The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty. + * Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory. */ - referrerUri?: string | null; + gcsStagingDir?: string | null; /** - * Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters. + * The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - uri?: string | null; + projectId?: string | null; } /** - * Detailed panel information associated with a user event. + * Cloud Storage location for input content. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPanelInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaGcsSource { /** - * The display name of the panel. + * 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 the GENERIC Data Store vertical. * `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 the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. */ - displayName?: string | null; + dataSchema?: string | null; /** - * Required. The panel ID. + * Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/x.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */ - panelId?: string | null; + inputUris?: string[] | null; + } + /** + * Grounding Fact. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaGroundingFact { /** - * The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. + * Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. */ - panelPosition?: number | null; + attributes?: {[key: string]: string} | null; /** - * The total number of panels, including this one, shown to the user. Must be set if panel_position is set. + * Text content of the fact. Can be at most 10K characters long. */ - totalPanels?: number | null; + factText?: string | null; } /** - * Request for pausing training of an engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {} - /** - * Metadata and configurations for a Google Cloud project in the service. + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProject { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata { /** - * Output only. The timestamp when this project is created. + * Operation create time. */ createTime?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Count of CompletionSuggestions that failed to be imported. */ - name?: string | null; + failureCount?: string | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * Count of CompletionSuggestions successfully imported. */ - provisionCompletionTime?: string | null; + successCount?: string | null; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * Operation last update time. If the operation is done, this is also the finish time. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; - } | null; + updateTime?: string | null; } /** - * Metadata about the terms of service. + * Request message for CompletionService.ImportCompletionSuggestions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { - /** - * The last time when the project agreed to the terms of service. - */ - acceptTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest { /** - * The last time when the project declined or revoked the agreement to terms of service. + * BigQuery input source. */ - declineTime?: string | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. + * The desired location of errors incurred during the Import. */ - id?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * Cloud Storage location for the input content. */ - state?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * The Inline source for suggestion entries. */ - version?: string | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource; } /** - * Metadata associated with a project provision operation. + * The inline source for CompletionSuggestions. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequestInlineSource { + /** + * Required. A list of all denylist entries to import. Max of 1000 items. + */ + suggestions?: Schema$GoogleCloudDiscoveryengineV1betaCompletionSuggestion[]; + } /** - * Request for ProjectService.ProvisionProject method. + * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse { /** - * Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). + * The desired location of errors incurred during the Import. */ - acceptDataUseTerms?: boolean | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. + * A sample of errors encountered while processing the request. */ - dataUseTermsVersion?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Request message for CompletionService.PurgeCompletionSuggestions method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest {} - /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata { /** * Operation create time. */ @@ -4513,2249 +4856,2342 @@ export namespace discoveryengine_v1beta { */ failureCount?: string | null; /** - * Count of entries that were ignored as entries were not found. + * Count of entries that were processed successfully. */ - ignoredCount?: string | null; + successCount?: string | null; /** - * Count of entries that were deleted successfully. + * Total count of entries that were processed. */ - successCount?: string | null; + totalCount?: string | null; /** * Operation last update time. If the operation is done, this is also the finish time. */ updateTime?: string | null; } /** - * Request message for DocumentService.PurgeDocuments method. + * Request message for Import methods. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest { /** - * Required. Filter matching documents to purge. Only currently supported value is `*` (all items). + * AlloyDB input source. */ - filter?: string | null; + alloyDbSource?: Schema$GoogleCloudDiscoveryengineV1betaAlloyDbSource; /** - * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. + * 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. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */ - force?: boolean | null; - } - /** - * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { + autoGenerateIds?: boolean | null; /** - * The total count of documents purged as a result of the operation. + * BigQuery input source. */ - purgeCount?: string | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. + * Cloud Bigtable input source. */ - purgeSample?: string[] | null; - } - /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { + bigtableSource?: Schema$GoogleCloudDiscoveryengineV1betaBigtableSource; /** - * Operation create time. + * Cloud SQL input source. */ - createTime?: string | null; + cloudSqlSource?: Schema$GoogleCloudDiscoveryengineV1betaCloudSqlSource; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The desired location of errors incurred during the Import. */ - updateTime?: string | null; - } - /** - * Request message for CompletionService.PurgeSuggestionDenyListEntries method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {} - /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * A sample of errors encountered while processing the request. + * FhirStore input source. */ - errorSamples?: Schema$GoogleRpcStatus[]; + fhirStoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFhirStoreSource; /** - * Number of suggestion deny list entries purged. + * Firestore input source. */ - purgeCount?: string | null; - } - /** - * Defines a user inputed query. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaQuery { + firestoreSource?: Schema$GoogleCloudDiscoveryengineV1betaFirestoreSource; /** - * Unique Id for the query. + * Cloud Storage location for the input content. */ - queryId?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * Plain text. + * The field indicates the ID field or column to be used as 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 others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table 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 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. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * FirestoreSource. * BigtableSource. */ - text?: string | null; - } - /** - * Record message for RankService.Rank method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRankingRecord { + idField?: string | null; /** - * The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. + * The Inline source for the input content for documents. */ - content?: string | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource; /** - * The unique ID to represent the record. + * The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. */ - id?: string | null; + reconciliationMode?: string | null; /** - * The score of this record based on the given query and selected model. + * Spanner input source. */ - score?: number | null; + spannerSource?: Schema$GoogleCloudDiscoveryengineV1betaSpannerSource; /** - * The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. + * Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. */ - title?: string | null; + updateMask?: string | null; } /** - * Request message for RankService.Rank method. + * The inline source for the input config for ImportDocuments method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRankRequest { - /** - * If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. - */ - ignoreRecordDetailsInResponse?: boolean | null; - /** - * The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. - */ - model?: string | null; - /** - * The query to use. - */ - query?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource { /** - * Required. A list of records to rank. At most 200 records to rank. + * Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items. */ - records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; + documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; + } + /** + * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsResponse { /** - * The number of results to return. If this is unset or no bigger than zero, returns all results. + * Echoes the destination for the complete errors in the request if set. */ - topN?: number | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + * A sample of errors encountered while processing the request. */ - userLabels?: {[key: string]: string} | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Response message for RankService.Rank method. + * Configuration of destination for Import related errors. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRankResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig { /** - * A list of records sorted by descending score. + * 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. */ - records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; + gcsPrefix?: string | null; } /** - * Request message for Recommend method. + * Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest { - /** - * Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. - */ - filter?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata { /** - * Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. + * ImportSampleQueries operation create time. */ - pageSize?: number | null; + createTime?: string | null; /** - * Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. + * Count of SampleQuerys that failed to be imported. */ - params?: {[key: string]: any} | null; + failureCount?: string | null; /** - * Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset. + * Count of SampleQuerys successfully imported. */ - userEvent?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; + successCount?: string | null; /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + * Total count of SampleQuerys that were processed. */ - userLabels?: {[key: string]: string} | null; + totalCount?: string | null; /** - * Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. + * ImportSampleQueries operation last update time. If the operation is done, this is also the finish time. */ - validateOnly?: boolean | null; + updateTime?: string | null; } /** - * Response message for Recommend method. + * Request message for SampleQueryService.ImportSampleQueries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest { /** - * A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. + * BigQuery input source. */ - attributionToken?: string | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. + * The desired location of errors incurred during the Import. */ - missingIds?: string[] | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). + * Cloud Storage location for the input content. */ - results?: Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult[]; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * True if RecommendRequest.validate_only was set. + * The Inline source for sample query entries. */ - validateOnly?: boolean | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource; } /** - * RecommendationResult represents a generic recommendation result with associated metadata. + * The inline source for SampleQuerys. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource { /** - * Set if `returnDocument` is set to true in RecommendRequest.params. + * Required. A list of SampleQuerys to import. Max of 1000 items. */ - document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery[]; + } + /** + * Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse { /** - * Resource ID of the recommended Document. + * The desired location of errors incurred during the Import. */ - id?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. + * A sample of errors encountered while processing the request. */ - metadata?: {[key: string]: any} | null; + errorSamples?: Schema$GoogleRpcStatus[]; } /** - * Request message for SiteSearchEngineService.RecrawlUris method. + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata { /** - * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. + * Operation create time. */ - uris?: string[] | null; + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Defines a reply message to user. + * Request message for CompletionService.ImportSuggestionDenyListEntries method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaReply { - /** - * References in the reply. - */ - references?: Schema$GoogleCloudDiscoveryengineV1betaReplyReference[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest { /** - * DEPRECATED: use `summary` instead. Text reply. + * Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line. */ - reply?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * Summary based on search results. + * The Inline source for the input content for suggestion deny list entries. */ - summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource; } /** - * Defines reference in reply. + * The inline source for SuggestionDenyListEntry. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaReplyReference { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequestInlineSource { /** - * Anchor text. + * Required. A list of all denylist entries to import. Max of 1000 items. */ - anchorText?: string | null; + entries?: Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry[]; + } + /** + * Response message for CompletionService.ImportSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse { /** - * Anchor text end index. + * A sample of errors encountered while processing the request. */ - end?: number | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Anchor text start index. + * Count of deny list entries that failed to be imported. */ - start?: number | null; + failedEntriesCount?: string | null; /** - * URI link reference. + * Count of deny list entries successfully imported. */ - uri?: string | null; + importedEntriesCount?: string | null; } /** - * Request for resuming training of an engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest {} - /** - * Defines the structure and layout of a type of document data. + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata { /** - * The JSON representation of the schema. + * Operation create time. */ - jsonSchema?: string | null; + createTime?: string | null; /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Count of entries that encountered errors while processing. */ - name?: string | null; + failureCount?: string | null; /** - * The structured representation of the schema. + * Count of entries that were processed successfully. */ - structSchema?: {[key: string]: any} | null; + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Detailed search information. + * Request message for the ImportUserEvents request. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest { /** - * 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. + * BigQuery input source. */ - offset?: number | null; + bigquerySource?: Schema$GoogleCloudDiscoveryengineV1betaBigQuerySource; /** - * 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. + * The desired location of errors incurred during the Import. Cannot be set for inline user event imports. */ - orderBy?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * 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. + * Cloud Storage location for the input content. */ - searchQuery?: string | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; + /** + * The Inline source for the input content for UserEvents. + */ + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource; } /** - * Request message for SearchService.Search method. + * The inline source for the input config for ImportUserEvents method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequestInlineSource { /** - * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) + * Required. A list of user events to import. Recommended max of 10k items. */ - boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; + userEvents?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent[]; + } + /** + * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsResponse { /** - * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. + * Echoes the destination for the complete errors if this field was set in the request. */ - branch?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. + * A sample of errors encountered while processing the request. */ - canonicalFilter?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * A specification for configuring the behavior of content search. + * Count of user events imported with complete existing Documents. */ - contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; + joinedEventsCount?: string | null; /** - * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. + * Count of user events imported, but with Document information not found in the existing Branch. */ - dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; + unjoinedEventsCount?: string | null; + } + /** + * A floating point interval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaInterval { /** - * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. + * Exclusive upper bound. */ - embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; + exclusiveMaximum?: number | null; /** - * Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Exclusive lower bound. */ - facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; + exclusiveMinimum?: number | null; /** - * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) + * Inclusive upper bound. */ - filter?: string | null; + maximum?: number | null; /** - * Raw image query. + * Inclusive lower bound. */ - imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; + minimum?: number | null; + } + /** + * Language info for DataStore. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaLanguageInfo { /** - * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. + * Output only. Language part of normalized_language_code. E.g.: `en-US` -\> `en`, `zh-Hans-HK` -\> `zh`, `en` -\> `en`. */ - languageCode?: string | null; + language?: string | null; /** - * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. + * The language code for the DataStore. */ - offset?: number | null; + languageCode?: string | null; /** - * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. + * Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`. */ - orderBy?: string | null; + normalizedLanguageCode?: string | null; /** - * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. + * Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -\> `US`, `zh-Hans-HK` -\> `HK`, `en` -\> ``. */ - pageSize?: number | null; + region?: string | null; + } + /** + * Response for ListControls method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListControlsResponse { /** - * A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * All the Controls for a given data store. */ - pageToken?: string | null; + controls?: Schema$GoogleCloudDiscoveryengineV1betaControl[]; /** - * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` + * Pagination token, if not returned indicates the last page. */ - params?: {[key: string]: any} | null; + nextPageToken?: string | null; + } + /** + * Response for ListConversations method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListConversationsResponse { /** - * Raw search query. + * All the Conversations for a given data store. */ - query?: string | null; + conversations?: Schema$GoogleCloudDiscoveryengineV1betaConversation[]; /** - * The query expansion specification that specifies the conditions under which query expansion occurs. + * Pagination token, if not returned indicates the last page. */ - queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; + nextPageToken?: string | null; + } + /** + * Response message for SearchTuningService.ListCustomModels method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListCustomModelsResponse { /** - * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joint by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: `relevance_score`: pre-defined keywords, used for measure relevance between query and document. `embedding_field_path`: the document embedding field used with query embedding vector. `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. + * List of custom tuning models. */ - rankingExpression?: string | null; + models?: Schema$GoogleCloudDiscoveryengineV1betaCustomTuningModel[]; + } + /** + * Response message for DataStoreService.ListDataStores method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListDataStoresResponse { /** - * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. + * All the customer's DataStores. */ - regionCode?: string | null; + dataStores?: Schema$GoogleCloudDiscoveryengineV1betaDataStore[]; /** - * Whether to turn on safe search. This is only supported for website search. + * A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - safeSearch?: boolean | null; + nextPageToken?: string | null; + } + /** + * Response message for DocumentService.ListDocuments method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListDocumentsResponse { /** - * The spell correction specification that specifies the mode under which spell correction takes effect. + * The Documents. */ - spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; + documents?: Schema$GoogleCloudDiscoveryengineV1betaDocument[]; /** - * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. + * A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + nextPageToken?: string | null; + } + /** + * Response message for EngineService.ListEngines method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListEnginesResponse { /** - * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + * All the customer's Engines. */ - userLabels?: {[key: string]: string} | null; + engines?: Schema$GoogleCloudDiscoveryengineV1betaEngine[]; /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Not supported. */ - userPseudoId?: string | null; + nextPageToken?: string | null; } /** - * Boost specification to boost certain documents. + * Response message for EvaluationService.ListEvaluationResults method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse { /** - * Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. + * The EvaluationResults. */ - conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; + evaluationResults?: Schema$GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult[]; + /** + * A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; } /** - * Boost applies to documents which match a condition. + * Represents the results of an evaluation for a single SampleQuery. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult { /** - * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. - */ - boost?: number | null; - /** - * Complex specification for custom ranking based on customer defined attribute value. + * Output only. The metrics produced by the evaluation, for a given SampleQuery. */ - boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; + qualityMetrics?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics; /** - * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` + * Output only. The SampleQuery that was evaluated. */ - condition?: string | null; + sampleQuery?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery; } /** - * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. + * Response message for EvaluationService.ListEvaluations method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListEvaluationsResponse { /** - * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). + * The Evaluations. */ - attributeType?: string | null; + evaluations?: Schema$GoogleCloudDiscoveryengineV1betaEvaluation[]; /** - * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. + * A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; + nextPageToken?: string | null; + } + /** + * Response message for SampleQueryService.ListSampleQueries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse { /** - * The name of the field whose value will be used to determine the boost amount. + * A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - fieldName?: string | null; + nextPageToken?: string | null; /** - * The interpolation type to be applied to connect the control points listed below. + * The SampleQuerys. */ - interpolationType?: string | null; + sampleQueries?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery[]; } /** - * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). + * Response message for SampleQuerySetService.ListSampleQuerySets method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { + export interface Schema$GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse { /** - * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. + * A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - attributeValue?: string | null; + nextPageToken?: string | null; /** - * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. + * The SampleQuerySets. */ - boostAmount?: number | null; + sampleQuerySets?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet[]; } /** - * A specification for configuring the behavior of content search. + * Response message for SchemaService.ListSchemas method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { - /** - * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS - */ - chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; + export interface Schema$GoogleCloudDiscoveryengineV1betaListSchemasResponse { /** - * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. + * A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; + nextPageToken?: string | null; /** - * Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + * The Schemas. */ - searchResultMode?: string | null; + schemas?: Schema$GoogleCloudDiscoveryengineV1betaSchema[]; + } + /** + * Response for ListServingConfigs method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaListServingConfigsResponse { /** - * If `snippetSpec` is not specified, snippets are not included in the search response. + * Pagination token, if not returned indicates the last page. */ - snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; + nextPageToken?: string | null; /** - * If `summarySpec` is not specified, summaries are not included in the search response. + * All the ServingConfigs for a given dataStore. */ - summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; + servingConfigs?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig[]; } /** - * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS + * Response for ListSessions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListSessionsResponse { /** - * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. + * Pagination token, if not returned indicates the last page. */ - numNextChunks?: number | null; + nextPageToken?: string | null; /** - * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. + * All the Sessions for a given data store. */ - numPreviousChunks?: number | null; + sessions?: Schema$GoogleCloudDiscoveryengineV1betaSession[]; } /** - * A specification for configuring the extractive content in a search response. + * Response message for SiteSearchEngineService.ListTargetSites method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaListTargetSitesResponse { /** - * The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. + * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - maxExtractiveAnswerCount?: number | null; + nextPageToken?: string | null; /** - * The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. + * List of TargetSites. */ - maxExtractiveSegmentCount?: number | null; + targetSites?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite[]; /** - * Return at most `num_next_segments` segments after each selected segments. + * The total number of items matching the request. This will always be populated in the response. */ - numNextSegments?: number | null; + totalSize?: number | null; + } + /** + * Media-specific user event information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaMediaInfo { /** - * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. + * The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. */ - numPreviousSegments?: number | null; + mediaProgressDuration?: string | null; /** - * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. + * Media progress should be computed using only the media_progress_duration relative to the media total length. This value must be between `[0, 1.0]` inclusive. If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset. */ - returnExtractiveSegmentScore?: boolean | null; + mediaProgressPercentage?: number | null; } /** - * A specification for configuring snippets in a search response. + * Detailed page information. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPageInfo { /** - * [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. + * The most specific category associated with a category page. To represent full path of category, use '\>' sign to separate different hierarchies. If '\>' is part of the category name, 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. */ - maxSnippetCount?: number | null; + pageCategory?: string | null; /** - * [DEPRECATED] This field is deprecated and will have no affect on the snippet. + * 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. */ - referenceOnly?: boolean | null; + pageviewId?: string | null; /** - * If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. + * The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty. */ - returnSnippet?: boolean | null; + referrerUri?: string | null; + /** + * Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters. + */ + uri?: string | null; } /** - * A specification for configuring a summary returned in a search response. + * Detailed panel information associated with a user event. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPanelInfo { /** - * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. + * The display name of the panel. */ - ignoreAdversarialQuery?: boolean | null; + displayName?: string | null; /** - * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. + * Required. The panel ID. */ - ignoreNonSummarySeekingQuery?: boolean | null; + panelId?: string | null; /** - * Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. + * The ordered position of the panel, if shown to the user with other panels. If set, then total_panels must also be set. */ - includeCitations?: boolean | null; + panelPosition?: number | null; /** - * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. + * The total number of panels, including this one, shown to the user. Must be set if panel_position is set. */ - languageCode?: string | null; + totalPanels?: number | null; + } + /** + * Request for pausing training of an engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest {} + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProject { /** - * If specified, the spec will be used to modify the prompt provided to the LLM. + * Output only. The timestamp when this project is created. */ - modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; + createTime?: string | null; /** - * If specified, the spec will be used to modify the model specification provided to the LLM. + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. */ - modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; + name?: string | null; /** - * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. */ - summaryResultCount?: number | null; + provisionCompletionTime?: string | null; /** - * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. */ - useSemanticChunks?: boolean | null; + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms; + } | null; } /** - * Specification of the prompt to use with the model. + * Metadata about the terms of service. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaProjectServiceTerms { /** - * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. + * The last time when the project agreed to the terms of service. */ - preamble?: string | null; - } - /** - * Specification of the model. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { + acceptTime?: string | null; /** - * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + * The last time when the project declined or revoked the agreement to terms of service. */ - version?: string | null; - } - /** - * A struct to define data stores to filter on in a search call and configurations for those data stores. A maximum of 1 DataStoreSpec per data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { + declineTime?: string | null; /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. + * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. */ - dataStore?: string | null; - } - /** - * The specification that uses customized query embedding vector to do semantic document retrieval. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { + id?: string | null; /** - * The embedding vector used for retrieval. Limit to 1. + * Whether the project has accepted/rejected the service terms or it is still pending. */ - embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; + state?: string | null; + /** + * The version string of the terms of service. For acceptable values, see the comments for id above. + */ + version?: string | null; } /** - * Embedding vector. + * Metadata associated with a project provision operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { + export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata {} + /** + * Request for ProjectService.ProvisionProject method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest { /** - * Embedding field path in schema. + * Required. Set to `true` to specify that caller has read and would like to give consent to the [Terms for data use](https://cloud.google.com/retail/data-use-terms). */ - fieldPath?: string | null; + acceptDataUseTerms?: boolean | null; /** - * Query embedding vector. + * Required. The version of the [Terms for data use](https://cloud.google.com/retail/data-use-terms) that caller has read and would like to give consent to. Acceptable version is `2022-11-23`, and this may change over time. */ - vector?: number[] | null; + dataUseTermsVersion?: string | null; } /** - * A facet specification to perform faceted search. + * Request message for CompletionService.PurgeCompletionSuggestions method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest {} + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata { /** - * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. + * Operation create time. */ - enableDynamicPosition?: boolean | null; + createTime?: string | null; /** - * List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Count of entries that encountered errors while processing. */ - excludedFilterKeys?: string[] | null; + failureCount?: string | null; /** - * Required. The facet key specification. + * Count of entries that were ignored as entries were not found. */ - facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; + ignoredCount?: string | null; /** - * Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. + * Count of entries that were deleted successfully. */ - limit?: number | null; + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; } /** - * Specifies how a facet is computed. + * Request message for DocumentService.PurgeDocuments method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { - /** - * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. - */ - caseInsensitive?: boolean | null; - /** - * Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. - */ - contains?: string[] | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest { /** - * Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. + * The desired location of errors incurred during the purge. */ - intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaPurgeErrorConfig; /** - * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. + * Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */ - key?: string | null; + filter?: string | null; /** - * The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. + * Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */ - orderBy?: string | null; + force?: boolean | null; /** - * Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. + * Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */ - prefixes?: string[] | null; + gcsSource?: Schema$GoogleCloudDiscoveryengineV1betaGcsSource; /** - * Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. + * Inline source for the input content for purge. */ - restrictedValues?: string[] | null; + inlineSource?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource; } /** - * Specifies the image query input. + * The inline source for the input config for DocumentService.PurgeDocuments method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequestInlineSource { /** - * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. + * Required. A list of full resource name of documents to purge. In the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. Recommended max of 100 items. */ - imageBytes?: string | null; + documents?: string[] | null; } /** - * Specification to determine under which conditions query expansion should occur. + * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse { /** - * The condition under which query expansion should occur. Default to Condition.DISABLED. + * The total count of documents purged as a result of the operation. */ - condition?: string | null; + purgeCount?: string | null; /** - * Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. + * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */ - pinUnexpandedResults?: boolean | null; + purgeSample?: string[] | null; } /** - * The specification for query spell correction. + * Configuration of destination for Purge related errors. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeErrorConfig { /** - * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. + * Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */ - mode?: string | null; + gcsPrefix?: string | null; } /** - * Response message for SearchService.Search method. + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponse { - /** - * Controls applied as part of the Control service. - */ - appliedControls?: string[] | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata { /** - * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. + * Operation create time. */ - attributionToken?: string | null; + createTime?: string | null; /** - * Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. + * Operation last update time. If the operation is done, this is also the finish time. */ - correctedQuery?: string | null; + updateTime?: string | null; + } + /** + * Request message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest {} + /** + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse { /** - * Results of facets requested by user. + * A sample of errors encountered while processing the request. */ - facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[]; - geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[]; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * Guided search result. + * Number of suggestion deny list entries purged. */ - guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult; + purgeCount?: string | null; + } + /** + * Request message for PurgeUserEvents method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest { /** - * A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + * Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \> "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `eventType = "search"` * Deleting all events for a specific visitor: `userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. */ - nextPageToken?: string | null; + filter?: string | null; /** - * Query expansion information for the returned results. + * The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. */ - queryExpansionInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo; + force?: boolean | null; + } + /** + * Describes the metrics produced by the evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetrics { /** - * The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. + * Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 */ - redirectUri?: string | null; + docNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * A list of matched documents. The order represents the ranking. + * Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8 */ - results?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; + docPrecision?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. + * Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6 */ - summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; + docRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; /** - * The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. + * Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693 */ - totalSize?: number | null; + pageNdcg?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; + /** + * Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6 + */ + pageRecall?: Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics; } /** - * A facet result. + * Stores the metric values at specific top-k levels. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet { + export interface Schema$GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics { /** - * Whether the facet is dynamically generated. + * The top-1 value. */ - dynamicFacet?: boolean | null; + top1?: number | null; /** - * The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. + * The top-10 value. */ - key?: string | null; + top10?: number | null; /** - * The facet values for this field. + * The top-3 value. */ - values?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue[]; + top3?: number | null; + /** + * The top-5 value. + */ + top5?: number | null; } /** - * A facet value which contains value names and their count. + * Defines a user inputed query. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue { - /** - * Number of items that have this facet value. - */ - count?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaQuery { /** - * Interval value for a facet, such as 10, 20) for facet "price". It matches [SearchRequest.FacetSpec.FacetKey.intervals. + * Unique Id for the query. */ - interval?: Schema$GoogleCloudDiscoveryengineV1betaInterval; + queryId?: string | null; /** - * Text value of a facet, such as "Black" for facet "colors". + * Plain text. */ - value?: string | null; + text?: string | null; } /** - * Debug information specifically related to forward geocoding issues arising from Geolocation Search. + * Record message for RankService.Rank method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaRankingRecord { /** - * The error produced. + * The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */ - errorMessage?: string | null; + content?: string | null; /** - * The address from which forward geocoding ingestion produced issues. + * The unique ID to represent the record. */ - originalAddressQuery?: string | null; - } - /** - * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult { + id?: string | null; /** - * Suggested follow-up questions. + * The score of this record based on the given query and selected model. */ - followUpQuestions?: string[] | null; + score?: number | null; /** - * A list of ranked refinement attributes. + * The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */ - refinementAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute[]; + title?: string | null; } /** - * Useful attribute for search result refinements. + * Request message for RankService.Rank method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute { + export interface Schema$GoogleCloudDiscoveryengineV1betaRankRequest { /** - * Attribute key used to refine the results. For example, `"movie_type"`. + * If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */ - attributeKey?: string | null; + ignoreRecordDetailsInResponse?: boolean | null; /** - * Attribute value used to refine the results. For example, `"drama"`. + * The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */ - attributeValue?: string | null; + model?: string | null; + /** + * The query to use. + */ + query?: string | null; + /** + * Required. A list of records to rank. At most 200 records to rank. + */ + records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; + /** + * The number of results to return. If this is unset or no bigger than zero, returns all results. + */ + topN?: number | null; + /** + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + */ + userLabels?: {[key: string]: string} | null; } /** - * Information describing query expansion including whether expansion has occurred. + * Response message for RankService.Rank method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo { - /** - * Bool describing whether query expansion has occurred. - */ - expandedQuery?: boolean | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaRankResponse { /** - * Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. + * A list of records sorted by descending score. */ - pinnedResultCount?: string | null; + records?: Schema$GoogleCloudDiscoveryengineV1betaRankingRecord[]; } /** - * Represents the search results. + * Request message for Recommend method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest { /** - * The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. + * Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. */ - chunk?: Schema$GoogleCloudDiscoveryengineV1betaChunk; + filter?: string | null; /** - * The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. + * Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. */ - document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + pageSize?: number | null; /** - * Document.id of the searched Document. + * Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. */ - id?: string | null; + params?: {[key: string]: any} | null; /** - * Google provided available scores. + * Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset. */ - modelScores?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaDoubleList; - } | null; + userEvent?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; + /** + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. + */ + userLabels?: {[key: string]: string} | null; + /** + * Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. + */ + validateOnly?: boolean | null; } /** - * Summary of the top N search results specified by the summary spec. + * Response message for Recommend method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponse { /** - * A collection of Safety Attribute categories and their associated confidence scores. + * A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. */ - safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes; + attributionToken?: string | null; /** - * Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. + * IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig. */ - summarySkippedReasons?: string[] | null; + missingIds?: string[] | null; /** - * The summary content. + * A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least). */ - summaryText?: string | null; + results?: Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult[]; /** - * Summary with metadata information. + * True if RecommendRequest.validate_only was set. */ - summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata; + validateOnly?: boolean | null; } /** - * Citation info for a segment. + * RecommendationResult represents a generic recommendation result with associated metadata. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecommendResponseRecommendationResult { /** - * End of the attributed segment, exclusive. + * Set if `returnDocument` is set to true in RecommendRequest.params. */ - endIndex?: string | null; + document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; /** - * Citation sources for the attributed segment. + * Resource ID of the recommended Document. */ - sources?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[]; + id?: string | null; /** - * Index indicates the start of the segment, measured in bytes/unicode. + * Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */ - startIndex?: string | null; + metadata?: {[key: string]: any} | null; } /** - * Citation metadata. + * Request message for SiteSearchEngineService.RecrawlUris method. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest { /** - * Citations for segments. + * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. */ - citations?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[]; + uris?: string[] | null; } /** - * Citation source. + * Defines a reply message to user. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource { + export interface Schema$GoogleCloudDiscoveryengineV1betaReply { /** - * Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. + * References in the reply. */ - referenceIndex?: string | null; + references?: Schema$GoogleCloudDiscoveryengineV1betaReplyReference[]; + /** + * DEPRECATED: use `summary` instead. Text reply. + */ + reply?: string | null; + /** + * Summary based on search results. + */ + summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; } /** - * Document reference. + * Defines reference in reply. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference { + export interface Schema$GoogleCloudDiscoveryengineV1betaReplyReference { /** - * List of cited chunk contents derived from document content. + * Anchor text. */ - chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[]; + anchorText?: string | null; /** - * Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. + * Anchor text end index. */ - document?: string | null; + end?: number | null; /** - * Title of the document. + * Anchor text start index. */ - title?: string | null; + start?: number | null; /** - * Cloud Storage or HTTP uri for the document. + * URI link reference. */ uri?: string | null; } /** - * Chunk content. + * Request for resuming training of an engine. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent { + export interface Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest {} + /** + * Sample Query captures metadata to be used for evaluation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQuery { /** - * Chunk textual content. + * Output only. Timestamp the SampleQuery was created at. */ - content?: string | null; + createTime?: string | null; /** - * Page identifier. + * Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - pageIdentifier?: string | null; + name?: string | null; + /** + * The query entry. + */ + queryEntry?: Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry; } /** - * Safety Attribute categories and their associated confidence scores. + * Query Entry captures metadata to be used for search evaluation. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes { + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry { /** - * The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. + * Required. The query. */ - categories?: string[] | null; + query?: string | null; /** - * The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. + * List of targets for the query. */ - scores?: number[] | null; + targets?: Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget[]; } /** - * Summary with metadata information. + * Defines the parameters of the query's expected outcome. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget { /** - * Citation metadata for given summary. + * Expected page numbers of the target. Each page number must be non negative. */ - citationMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata; + pageNumbers?: number[] | null; /** - * Document References. + * Relevance score of the target. */ - references?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[]; + score?: number | null; /** - * Summary text with no citation information. + * Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`. */ - summary?: string | null; + uri?: string | null; } /** - * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. + * A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet { /** - * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. + * Output only. Timestamp the SampleQuerySet was created at. */ - boostControlIds?: string[] | null; + createTime?: string | null; /** - * Output only. ServingConfig created timestamp. + * The description of the SampleQuerySet. */ - createTime?: string | null; + description?: string | null; /** - * Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. */ displayName?: string | null; /** - * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + * Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - dissociateControlIds?: string[] | null; + name?: string | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSchema { /** - * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * The JSON representation of the schema. */ - diversityLevel?: string | null; + jsonSchema?: string | null; /** - * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config. + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig; + name?: string | null; /** - * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. + * The structured representation of the schema. */ - filterControlIds?: string[] | null; + structSchema?: {[key: string]: any} | null; + } + /** + * Detailed search information. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchInfo { /** - * The GenericConfig of the serving configuration. + * 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. */ - genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig; + offset?: number | null; /** - * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. + * 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. */ - ignoreControlIds?: string[] | null; + orderBy?: string | null; /** - * The MediaConfig of the serving configuration. + * 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. */ - mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig; + searchQuery?: string | null; + } + /** + * Request message for SearchService.Search method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequest { /** - * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */ - modelId?: string | null; + boostSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec; /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * The branch resource name, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */ - name?: string | null; + branch?: string | null; /** - * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + * The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter. */ - onewaySynonymsControlIds?: string[] | null; + canonicalFilter?: string | null; /** - * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: relevance_score: pre-defined keywords, used for measure relevance between query and document. embedding_field_path: the document embedding field used with query embedding vector. dotProduct: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be 0.5 * relevance_score + 0.3 * dotProduct(doc_embedding). + * A specification for configuring the behavior of content search. */ - rankingExpression?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; /** - * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + * Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */ - redirectControlIds?: string[] | null; + dataStoreSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[]; /** - * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + * Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path. */ - replacementControlIds?: string[] | null; + embeddingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec; /** - * Required. Immutable. Specifies the solution type that a serving config can be associated with. + * Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - solutionType?: string | null; + facetSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec[]; /** - * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + * The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --\> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */ - synonymsControlIds?: string[] | null; + filter?: string | null; /** - * Output only. ServingConfig updated timestamp. + * Raw image query. */ - updateTime?: string | null; - } - /** - * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig { + imageQuery?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery; /** - * Specifies the expected behavior of content search. Only valid for content-search enabled data store. + * The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. */ - contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; - } - /** - * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig { + languageCode?: string | null; /** - * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. + * If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. */ - contentFreshnessCutoffDays?: number | null; + naturalLanguageQueryUnderstandingSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec; /** - * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. + * A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - contentWatchedPercentageThreshold?: number | null; + offset?: number | null; /** - * Specifies the content watched minutes threshold for demotion. + * The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */ - contentWatchedSecondsThreshold?: number | null; + orderBy?: string | null; /** - * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. + * Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - demotionEventType?: string | null; - } - /** - * External session proto definition. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSession { + pageSize?: number | null; /** - * Output only. The time the session finished. + * A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - endTime?: string | null; + pageToken?: string | null; /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */ - name?: string | null; + params?: {[key: string]: any} | null; /** - * Output only. The time the session started. + * Raw search query. */ - startTime?: string | null; + query?: string | null; /** - * The state of the session. + * The query expansion specification that specifies the conditions under which query expansion occurs. */ - state?: string | null; + queryExpansionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec; /** - * Turns. + * The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ - turns?: Schema$GoogleCloudDiscoveryengineV1betaSessionTurn[]; + rankingExpression?: string | null; /** - * A unique identifier for tracking users. + * The Unicode country/region code (CLDR) of a location, such as "US" and "419". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided. */ - userPseudoId?: string | null; - } - /** - * Represents a turn, including a query from the user and a answer from service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSessionTurn { + regionCode?: string | null; /** - * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. + * The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information. */ - answer?: string | null; + relevanceThreshold?: string | null; /** - * The user query. + * Whether to turn on safe search. This is only supported for website search. */ - query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; - } - /** - * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine { + safeSearch?: boolean | null; /** - * The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine` + * Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical. */ - name?: string | null; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { + searchAsYouTypeSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec; /** - * Site verification state indicating the ownership and validity. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - siteVerificationState?: string | null; + servingConfig?: string | null; /** - * Latest site verification time. + * The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - verifyTime?: string | null; - } - /** - * The Spanner source for importing data - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSpannerSource { + session?: string | null; /** - * Required. The database ID of the source Spanner table. + * Session specification. Can be used only when `session` is set. */ - databaseId?: string | null; + sessionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec; /** - * Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas). + * The spell correction specification that specifies the mode under which spell correction takes effect. */ - enableDataBoost?: boolean | null; + spellCorrectionSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec; /** - * Required. The instance ID of the source Spanner table. + * Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */ - instanceId?: string | null; + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; /** - * The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request. + * The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */ - projectId?: string | null; + userLabels?: {[key: string]: string} | null; /** - * Required. The table name of the Spanner database that needs to be imported. + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - tableId?: string | null; + userPseudoId?: string | null; } /** - * Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase. + * Boost specification to boost certain documents. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry { - /** - * Required. Phrase to block from suggestions served. Can be maximum 125 characters. - */ - blockPhrase?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec { /** - * Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. + * Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */ - matchOperator?: string | null; + conditionBoostSpecs?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec[]; } /** - * A target site for the SiteSearchEngine. + * Boost applies to documents which match a condition. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { - /** - * 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?: boolean | null; - /** - * Output only. Failure reason. - */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; - /** - * Output only. This is system-generated based on the provided_uri_pattern. - */ - generatedUriPattern?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec { /** - * Output only. Indexing status. + * Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied. */ - indexingStatus?: string | null; + boost?: number | null; /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Complex specification for custom ranking based on customer defined attribute value. */ - name?: string | null; + boostControlSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))` */ - providedUriPattern?: string | null; + condition?: string | null; + } + /** + * Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec { /** - * Output only. Root domain of the provided_uri_pattern. + * The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */ - rootDomainUri?: string | null; + attributeType?: string | null; /** - * Output only. Site ownership and validity verification status. + * The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; + controlPoints?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint[]; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * The name of the field whose value will be used to determine the boost amount. */ - type?: string | null; + fieldName?: string | null; /** - * Output only. The target site's last updated time. + * The interpolation type to be applied to connect the control points listed below. */ - updateTime?: string | null; + interpolationType?: string | null; } /** - * Site search indexing failure reasons. + * The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable). */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint { /** - * Failed due to insufficient quota. + * Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; - } - /** - * Failed due to insufficient quota. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { + attributeValue?: string | null; /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. + * The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */ - totalRequiredQuota?: string | null; + boostAmount?: number | null; } /** - * Defines text input. + * A specification for configuring the behavior of content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTextInput { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec { /** - * Conversation context of the input. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext; + chunkSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec; /** - * Text input. + * If there is no extractive_content_spec provided, there will be no extractive answer in the search response. */ - input?: string | null; + extractiveContentSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec; + /** + * Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. + */ + searchResultMode?: string | null; + /** + * If `snippetSpec` is not specified, snippets are not included in the search response. + */ + snippetSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec; + /** + * If `summarySpec` is not specified, summaries are not included in the search response. + */ + summarySpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec; } /** - * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + * Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec { /** - * Operation create time. + * The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. */ - createTime?: string | null; + numNextChunks?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned. */ - updateTime?: string | null; + numPreviousChunks?: number | null; } /** - * Request message for SearchTuningService.TrainCustomModel method. + * A specification for configuring the extractive content in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec { /** - * The desired location of errors incurred during the data ingestion and training. + * The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; + maxExtractiveAnswerCount?: number | null; /** - * Cloud Storage training input. + * The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`. */ - gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput; + maxExtractiveSegmentCount?: number | null; /** - * If not provided, a UUID will be generated. + * Return at most `num_next_segments` segments after each selected segments. */ - modelId?: string | null; + numNextSegments?: number | null; /** - * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. + * Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. */ - modelType?: string | null; + numPreviousSegments?: number | null; + /** + * Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. + */ + returnExtractiveSegmentScore?: boolean | null; } /** - * Cloud Storage training data input. + * A specification for configuring snippets in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput { - /** - * The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}` - */ - corpusDataPath?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec { /** - * The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\} + * [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count \> 0. */ - queryDataPath?: string | null; + maxSnippetCount?: number | null; /** - * Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. + * [DEPRECATED] This field is deprecated and will have no affect on the snippet. */ - testDataPath?: string | null; + referenceOnly?: boolean | null; /** - * Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` + * If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. */ - trainDataPath?: string | null; + returnSnippet?: boolean | null; } /** - * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + * A specification for configuring a summary returned in a search response. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { - /** - * Echoes the destination for the complete errors in the request if set. - */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; - /** - * A sample of errors encountered while processing the data. - */ - errorSamples?: Schema$GoogleRpcStatus[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec { /** - * The metrics of the trained model. + * Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */ - metrics?: {[key: string]: number} | null; + ignoreAdversarialQuery?: boolean | null; /** - * Fully qualified name of the CustomTuningModel. + * Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */ - modelName?: string | null; + ignoreLowRelevantContent?: boolean | null; /** - * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + * Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */ - modelStatus?: string | null; - } - /** - * A transaction represents the entire purchase transaction. - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo { + ignoreNonSummarySeekingQuery?: boolean | null; /** - * All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost + * Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */ - cost?: number | null; + includeCitations?: boolean | null; /** - * Required. Currency code. Use three-character ISO-4217 code. + * Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */ - currency?: string | null; + languageCode?: string | null; /** - * The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost + * If specified, the spec will be used to modify the prompt provided to the LLM. */ - discountValue?: number | null; + modelPromptSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec; /** - * All the taxes associated with the transaction. + * If specified, the spec will be used to modify the model specification provided to the LLM. */ - tax?: number | null; + modelSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec; /** - * The transaction ID with a length limit of 128 characters. + * The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - transactionId?: string | null; + summaryResultCount?: number | null; /** - * Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. + * If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list. */ - value?: number | null; + useSemanticChunks?: boolean | null; } /** - * Metadata associated with a tune operation. + * Specification of the prompt to use with the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec { /** - * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + * Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide. */ - engine?: string | null; + preamble?: string | null; } /** - * Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen). - */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest {} - /** - * Response associated with a tune operation. + * Specification of the model. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec { + /** + * The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). + */ + version?: string | null; + } /** - * Metadata for UpdateSchema LRO. + * A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec { /** - * Operation create time. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. */ - createTime?: string | null; + dataStore?: string | null; + } + /** + * The specification that uses customized query embedding vector to do semantic document retrieval. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The embedding vector used for retrieval. Limit to 1. */ - updateTime?: string | null; + embeddingVectors?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * Embedding vector. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector { /** - * Operation create time. + * Embedding field path in schema. */ - createTime?: string | null; + fieldPath?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Query embedding vector. */ - updateTime?: string | null; + vector?: number[] | null; } /** - * UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. + * A facet specification to perform faceted search. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec { /** - * 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. + * Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false. */ - attributes?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute; - } | null; + enableDynamicPosition?: boolean | null; /** - * 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. + * List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - attributionToken?: string | null; + excludedFilterKeys?: string[] | null; /** - * 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. + * Required. The facet key specification. */ - completionInfo?: Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo; + facetKey?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey; /** - * The DataStore resource full name, of the form `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. + * Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned. */ - dataStore?: string | null; + limit?: number | null; + } + /** + * Specifies how a facet is computed. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey { /** - * 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. + * True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */ - directUserRequest?: boolean | null; + caseInsensitive?: boolean | null; /** - * List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired. + * Only get facet values that contain the given strings. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "contains" to "2022", the "category" facet only contains "Action \> 2022" and "Sci-Fi \> 2022". Only supported on textual fields. Maximum is 10. */ - documents?: Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo[]; + contains?: string[] | null; /** - * The Engine resource name, in the form of `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. Optional. Only required for Engine produced user events. For example, user events from blended search. + * Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */ - engine?: string | null; + intervals?: Schema$GoogleCloudDiscoveryengineV1betaInterval[]; /** - * Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. + * Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive. */ - eventTime?: string | null; + key?: string | null; /** - * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. + * The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals. */ - eventType?: string | null; + orderBy?: string | null; /** - * 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 RecommendRequest, this field may be populated directly from 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. + * Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "prefixes" to "Action", the "category" facet only contains "Action \> 2022" and "Action \> 2021". Only supported on textual fields. Maximum is 10. */ - filter?: string | null; + prefixes?: string[] | null; /** - * Media-specific info. + * Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action \> 2022", "Action \> 2021" and "Sci-Fi \> 2022". If set "restricted_values" to "Action \> 2022", the "category" facet only contains "Action \> 2022". Only supported on textual fields. Maximum is 10. */ - mediaInfo?: Schema$GoogleCloudDiscoveryengineV1betaMediaInfo; + restrictedValues?: string[] | null; + } + /** + * Specifies the image query input. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery { /** - * Page metadata such as categories and other critical information for certain event types such as `view-category-page`. + * Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP. */ - pageInfo?: Schema$GoogleCloudDiscoveryengineV1betaPageInfo; - /** - * Panel metadata associated with this user event. - */ - panel?: Schema$GoogleCloudDiscoveryengineV1betaPanelInfo; - /** - * The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. - */ - promotionIds?: string[] | null; - /** - * SearchService.Search details related to the event. This field should be set for `search` event. - */ - searchInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchInfo; + imageBytes?: string | null; + } + /** + * Specification to enable natural language understanding capabilities for search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec { /** - * 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. + * The condition under which filter extraction should occur. Default to Condition.DISABLED. */ - sessionId?: string | null; + filterExtractionCondition?: string | null; /** - * A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. + * Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. */ - tagIds?: string[] | null; + geoSearchQueryDetectionFieldNames?: string[] | null; + } + /** + * Specification to determine under which conditions query expansion should occur. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec { /** - * The transaction metadata (if any) associated with this user event. + * The condition under which query expansion should occur. Default to Condition.DISABLED. */ - transactionInfo?: Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo; + condition?: string | null; /** - * Information about the end user. + * Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results. */ - userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + pinUnexpandedResults?: boolean | null; + } + /** + * Specification for search as you type in search requests. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec { /** - * 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. + * The condition under which search as you type should occur. Default to Condition.DISABLED. */ - userPseudoId?: string | null; + condition?: string | null; } /** - * Information of an end user. + * Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */ - export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec { /** - * 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. + * If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" \} answer: "Foo is ..." \} turns { query { text: "How about bar then?" query_id: ".../questions/zzz" \} \} \} The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" \} Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. */ - userAgent?: string | null; + queryId?: string | null; /** - * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode. */ - userId?: string | null; + searchResultPersistenceCount?: number | null; } /** - * Defines circumstances to be checked before allowing a behavior + * The specification for query spell correction. */ - export interface Schema$GoogleCloudDiscoveryengineV1Condition { - /** - * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. - */ - activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec { /** - * Search only A list of terms to match the query on. Maximum of 10 query terms. + * The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */ - queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; + mode?: string | null; } /** - * Matcher for search request query + * Response message for SearchService.Search method. */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponse { /** - * Whether the search query needs to exactly match the query term. + * Controls applied as part of the Control service. */ - fullMatch?: boolean | null; + appliedControls?: string[] | null; /** - * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + * A unique search token. This should be included in the UserEvent logs resulting from this search, which enables accurate attribution of search model performance. */ - value?: string | null; - } - /** - * Used for time-dependent conditions. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { + attributionToken?: string | null; /** - * End of time range. Range is inclusive. Must be in the future. + * Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search. */ - endTime?: string | null; + correctedQuery?: string | null; /** - * Start of time range. Range is inclusive. + * Results of facets requested by user. */ - startTime?: string | null; - } - /** - * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. - */ - export interface Schema$GoogleCloudDiscoveryengineV1Control { + facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[]; + geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[]; /** - * Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes. + * Guided search result. */ - associatedServingConfigIds?: string[] | null; + guidedSearchResult?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult; /** - * Defines a boost-type control + * Natural language query understanding information for the returned results. */ - boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; + naturalLanguageQueryUnderstandingInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo; /** - * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. + * A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. */ - conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; + nextPageToken?: string | null; /** - * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. + * A list of One Box results. There can be multiple One Box results of different types. */ - displayName?: string | null; + oneBoxResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult[]; /** - * Defines a filter-type control Currently not supported by Recommendation + * Query expansion information for the returned results. */ - filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; + queryExpansionInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo; /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only redirect_uri and attribution_token are set in the response. */ - name?: string | null; + redirectUri?: string | null; /** - * Defines a redirect-type control. + * A list of matched documents. The order represents the ranking. */ - redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; + results?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; /** - * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + * Session information. Only set if SearchRequest.session is provided. See its description for more details. */ - solutionType?: string | null; + sessionInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo; /** - * Treats a group of terms as synonyms of one another. + * A summary as part of the search results. This field is only returned if SearchRequest.ContentSearchSpec.summary_spec is set. */ - synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + summary?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary; /** - * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. + * The estimated total count of matched items irrespective of pagination. The count of results returned by pagination may be less than the total_size that matches. */ - useCases?: string[] | null; + totalSize?: number | null; } /** - * Adjusts order of products in returned list. + * A facet result. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet { /** - * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + * Whether the facet is dynamically generated. */ - boost?: number | null; + dynamicFacet?: boolean | null; /** - * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */ - dataStore?: string | null; + key?: string | null; /** - * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * The facet values for this field. */ - filter?: string | null; + values?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue[]; } /** - * Specified which products may be included in results. Uses same filter as boost. + * A facet value which contains value names and their count. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacetFacetValue { /** - * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + * Number of items that have this facet value. */ - dataStore?: string | null; + count?: string | null; /** - * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * Interval value for a facet, such as 10, 20) for facet "price". It matches [SearchRequest.FacetSpec.FacetKey.intervals. */ - filter?: string | null; - } - /** - * Redirects a shopper to the provided URI. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { + interval?: Schema$GoogleCloudDiscoveryengineV1betaInterval; /** - * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. + * Text value of a facet, such as "Black" for facet "colors". */ - redirectUri?: string | null; + value?: string | null; } /** - * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". + * Debug information specifically related to forward geocoding issues arising from Geolocation Search. */ - export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo { /** - * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + * The error produced. */ - synonyms?: string[] | null; + errorMessage?: string | null; + /** + * The address from which forward geocoding ingestion produced issues. + */ + originalAddressQuery?: string | null; } /** - * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult { /** - * Operation create time. + * Suggested follow-up questions. */ - createTime?: string | null; + followUpQuestions?: string[] | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A list of ranked refinement attributes. */ - updateTime?: string | null; + refinementAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute[]; } /** - * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Useful attribute for search result refinements. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResultRefinementAttribute { /** - * Operation create time. + * Attribute key used to refine the results. For example, `"movie_type"`. */ - createTime?: string | null; + attributeKey?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Attribute value used to refine the results. For example, `"drama"`. */ - updateTime?: string | null; + attributeValue?: string | null; } /** - * Metadata for Create Schema LRO. + * Information describing what natural language understanding was done on the input query. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfo { /** - * Operation create time. + * The filters that were extracted from the input query. */ - createTime?: string | null; + extractedFilters?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Rewritten input query minus the extracted filters. */ - updateTime?: string | null; + rewrittenQuery?: string | null; + /** + * The filters that were extracted from the input query represented in a structured form. + */ + structuredExtractedFilter?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter; } /** - * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * The filters that were extracted from the input query represented in a structured form. */ - export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilter { /** - * Operation create time. + * The expression denoting the filter that was extracted from the input query in a structured form. It can be a simple expression denoting a single string, numerical or geolocation constraint or a compound expression which is a combination of multiple expressions connected using logical (OR and AND) operators. */ - createTime?: string | null; + expression?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression; + } + /** + * Logical `And` operator. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The expressions that were ANDed together. */ - updateTime?: string | null; + expressions?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; } /** - * DataStore captures global settings and configs at the DataStore level. + * The expression denoting the filter that was extracted from the input query. */ - export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression { /** - * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + * Logical "And" compound operator connecting multiple expressions. */ - contentConfig?: string | null; + andExpr?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterAndExpression; /** - * Output only. Timestamp the DataStore was created at. + * Geolocation constraint expression. */ - createTime?: string | null; + geolocationConstraint?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint; /** - * Output only. The id of the default Schema asscociated to this data store. + * Numerical constraint expression. */ - defaultSchemaId?: string | null; + numberConstraint?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint; /** - * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Logical "Or" compound operator connecting multiple expressions. */ - displayName?: string | null; + orExpr?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression; /** - * Configuration for Document understanding and enrichment. + * String constraint expression. */ - documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + stringConstraint?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint; + } + /** + * Constraint of a geolocation field. Name of the geolocation field as defined in the schema. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterGeolocationConstraint { /** - * Immutable. The industry vertical that the data store registers. + * The reference address that was inferred from the input query. The proximity of the reference address to the geolocation field will be used to filter the results. */ - industryVertical?: string | null; + address?: string | null; /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * The name of the geolocation field as defined in the schema. */ - name?: string | null; + fieldName?: string | null; /** - * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. + * The latitude of the geolocation inferred from the input query. */ - solutionTypes?: string[] | null; + latitude?: number | null; /** - * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + * The longitude of the geolocation inferred from the input query. */ - startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + longitude?: number | null; + /** + * The radius in meters around the address. The record is returned if the location of the geolocation field is within the radius. + */ + radiusInMeters?: number | null; } /** - * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + * Constraint expression of a number field. Example: price < 100. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterNumberConstraint { /** - * Operation create time. + * The comparison operation performed between the field value and the value specified in the constraint. */ - createTime?: string | null; + comparison?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Name of the numerical field as defined in the schema. */ - updateTime?: string | null; + fieldName?: string | null; + /** + * The value specified in the numerical constraint. + */ + value?: number | null; } /** - * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + * Logical `Or` operator. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { - /** - * Operation create time. - */ - createTime?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterOrExpression { /** - * Operation last update time. If the operation is done, this is also the finish time. + * The expressions that were ORed together. */ - updateTime?: string | null; + expressions?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterExpression[]; } /** - * Metadata for DeleteSchema LRO. + * Constraint expression of a string field. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseNaturalLanguageQueryUnderstandingInfoStructuredExtractedFilterStringConstraint { /** - * Operation create time. + * Name of the string field as defined in the schema. */ - createTime?: string | null; + fieldName?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Identifies the keywords within the search query that match a filter. */ - updateTime?: string | null; + querySegment?: string | null; + /** + * Values of the string field. The record will only be returned if the field value matches one of the values specified here. + */ + values?: string[] | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + * OneBoxResult is a holder for all results of specific type that we want to display in UI differently. */ - export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseOneBoxResult { /** - * Operation create time. + * The type of One Box result. */ - createTime?: string | null; + oneBoxType?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The search results for this One Box. */ - updateTime?: string | null; + searchResults?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult[]; } /** - * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Information describing query expansion including whether expansion has occurred. */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseQueryExpansionInfo { /** - * Operation create time. + * Bool describing whether query expansion has occurred. */ - createTime?: string | null; + expandedQuery?: boolean | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true. */ - updateTime?: string | null; + pinnedResultCount?: string | null; } /** - * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} - /** - * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + * Represents the search results. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSearchResult { /** - * Whether chunking mode is enabled. + * The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS. */ - chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; + chunk?: Schema$GoogleCloudDiscoveryengineV1betaChunk; /** - * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + * The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */ - defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + document?: Schema$GoogleCloudDiscoveryengineV1betaDocument; /** - * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + * Document.id of the searched Document. */ - name?: string | null; + id?: string | null; /** - * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and or layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported. + * Google provided available scores. */ - parsingConfigOverrides?: { - [ - key: string - ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + modelScores?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaDoubleList; } | null; } /** - * Configuration for chunking config. + * Information about the session. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSessionInfo { /** - * Configuration for the layout based chunking. + * Name of the session. If the auto-session mode is used (when SearchRequest.session ends with "-"), this field holds the newly generated session name. */ - layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + name?: string | null; + /** + * Query ID that corresponds to this search API call. One session can have multiple turns, each with a unique query ID. By specifying the session name and this query ID in the Answer API call, the answer generation happens in the context of the search results from this search call. + */ + queryId?: string | null; } /** - * Configuration for the layout based chunking. + * Summary of the top N search results specified by the summary spec. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummary { /** - * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + * A collection of Safety Attribute categories and their associated confidence scores. */ - chunkSize?: number | null; + safetyAttributes?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes; /** - * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + * Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */ - includeAncestorHeadings?: boolean | null; + summarySkippedReasons?: string[] | null; + /** + * The summary content. + */ + summaryText?: string | null; + /** + * Summary with metadata information. + */ + summaryWithMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata; } /** - * Related configurations applied to a specific type of document parser. + * Citation info for a segment. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation { /** - * Configurations applied to digital parser. + * End of the attributed segment, exclusive. */ - digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + endIndex?: string | null; /** - * Configurations applied to layout parser. + * Citation sources for the attributed segment. */ - layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + sources?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource[]; /** - * Configurations applied to OCR parser. Currently it only applies to PDFs. + * Index indicates the start of the segment, measured in bytes/unicode. */ - ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + startIndex?: string | null; } /** - * The digital parsing configurations for documents. + * Citation metadata. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata { + /** + * Citations for segments. + */ + citations?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitation[]; + } /** - * The layout parsing configurations for documents. + * Citation source. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationSource { + /** + * Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly. + */ + referenceIndex?: string | null; + } /** - * The OCR parsing configurations for documents. + * Document reference. */ - export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference { /** - * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + * List of cited chunk contents derived from document content. */ - enhancedDocumentElements?: string[] | null; + chunkContents?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent[]; /** - * If true, will use native text instead of OCR text on pages containing native text. + * Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/x/locations/x/collections/x/dataStores/x/branches/x/documents/x`. */ - useNativeText?: boolean | null; + document?: string | null; + /** + * Title of the document. + */ + title?: string | null; + /** + * Cloud Storage or HTTP uri for the document. + */ + uri?: string | null; } /** - * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + * Chunk content. */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReferenceChunkContent { /** - * Operation create time. + * Chunk textual content. */ - createTime?: string | null; + content?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Page identifier. */ - updateTime?: string | null; + pageIdentifier?: string | null; } /** - * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + * Safety Attribute categories and their associated confidence scores. */ - export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySafetyAttributes { + /** + * The display names of Safety Attribute categories associated with the generated content. Order matches the Scores. + */ + categories?: string[] | null; + /** + * The confidence scores of the each category, higher value means higher confidence. Order matches the Categories. + */ + scores?: number[] | null; + } /** - * Metadata that describes the training and serving parameters of an Engine. + * Summary with metadata information. */ - export interface Schema$GoogleCloudDiscoveryengineV1Engine { + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummarySummaryWithMetadata { /** - * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * Citation metadata for given summary. */ - chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; + citationMetadata?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryCitationMetadata; /** - * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + * Document References. */ - chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; + references?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseSummaryReference[]; /** - * Common config spec that specifies the metadata of the engine. + * Summary text with no citation information. */ - commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + summary?: string | null; + } + /** + * Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions). The ServingConfig is passed in the search and predict request and generates results. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfig { /** - * Output only. Timestamp the Recommendation Engine was created at. + * Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. */ - createTime?: string | null; + boostControlIds?: string[] | null; /** - * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + * Output only. ServingConfig created timestamp. */ - dataStoreIds?: string[] | null; + createTime?: string | null; /** - * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + * Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ displayName?: string | null; /** - * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + * Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */ - industryVertical?: string | null; + dissociateControlIds?: string[] | null; /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + * How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */ - name?: string | null; + diversityLevel?: string | null; /** - * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + * Bring your own embedding config. The config is used for search semantic retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embeddings that are provided by this EmbeddingConfig. If SearchRequest.EmbeddingSpec.EmbeddingVector.vector is provided, it overrides this ServingConfig.embedding_config. */ - searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + embeddingConfig?: Schema$GoogleCloudDiscoveryengineV1betaEmbeddingConfig; /** - * Required. The solutions of the engine. + * Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. */ - solutionType?: string | null; + filterControlIds?: string[] | null; /** - * Output only. Timestamp the Recommendation Engine was last updated. + * The GenericConfig of the serving configuration. */ - updateTime?: string | null; - } - /** - * Configurations for a Chat Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { + genericConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig; /** - * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + * Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. */ - agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + ignoreControlIds?: string[] | null; /** - * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + * The MediaConfig of the serving configuration. */ - dialogflowAgentToLink?: string | null; - } - /** - * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + mediaConfig?: Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig; /** - * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + * The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. */ - business?: string | null; + modelId?: string | null; /** - * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ - defaultLanguageCode?: string | null; + name?: string | null; /** - * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + * Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */ - location?: string | null; + onewaySynonymsControlIds?: string[] | null; /** - * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + * The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if SearchRequest.ranking_expression is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function \}; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. */ - timeZone?: string | null; - } - /** - * Additional information of a Chat Engine. Fields in this message are output only. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + rankingExpression?: string | null; /** - * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + * IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */ - dialogflowAgent?: string | null; - } - /** - * Common configurations for an Engine. - */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + redirectControlIds?: string[] | null; /** - * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + * Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. */ - companyName?: string | null; + replacementControlIds?: string[] | null; + /** + * Required. Immutable. Specifies the solution type that a serving config can be associated with. + */ + solutionType?: string | null; + /** + * Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. + */ + synonymsControlIds?: string[] | null; + /** + * Output only. ServingConfig updated timestamp. + */ + updateTime?: string | null; } /** - * Configurations for a Search Engine. + * Specifies the configurations needed for Generic Discovery.Currently we support: * `content_search_spec`: configuration for generic content search. */ - export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { - /** - * The add-on that this search engine enables. - */ - searchAddOns?: string[] | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigGenericConfig { /** - * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + * Specifies the expected behavior of content search. Only valid for content-search enabled data store. */ - searchTier?: string | null; + contentSearchSpec?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec; } /** - * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + * Specifies the configurations needed for Media Discovery. Currently we support: * `demote_content_watched`: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result. * `promote_fresh_content`: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaServingConfigMediaConfig { /** - * Operation create time. + * Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. */ - createTime?: string | null; + contentFreshnessCutoffDays?: number | null; /** - * Count of CompletionSuggestions that failed to be imported. + * Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive. */ - failureCount?: string | null; + contentWatchedPercentageThreshold?: number | null; /** - * Count of CompletionSuggestions successfully imported. + * Specifies the content watched minutes threshold for demotion. */ - successCount?: string | null; + contentWatchedSecondsThreshold?: number | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Specifies the event type used for demoting recommendation result. Currently supported values: * `view-item`: Item viewed. * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. If unset, watch history demotion will not be applied. Content freshness demotion will still be applied. */ - updateTime?: string | null; + demotionEventType?: string | null; } /** - * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + * External session proto definition. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { - /** - * The desired location of errors incurred during the Import. - */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + export interface Schema$GoogleCloudDiscoveryengineV1betaSession { /** - * A sample of errors encountered while processing the request. + * Output only. The time the session finished. */ - errorSamples?: Schema$GoogleRpcStatus[]; - } - /** - * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + endTime?: string | null; /** - * Operation create time. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ - createTime?: string | null; + name?: string | null; /** - * Count of entries that encountered errors while processing. + * Output only. The time the session started. */ - failureCount?: string | null; + startTime?: string | null; /** - * Count of entries that were processed successfully. + * The state of the session. */ - successCount?: string | null; + state?: string | null; /** - * Total count of entries that were processed. + * Turns. */ - totalCount?: string | null; + turns?: Schema$GoogleCloudDiscoveryengineV1betaSessionTurn[]; /** - * Operation last update time. If the operation is done, this is also the finish time. + * A unique identifier for tracking users. */ - updateTime?: string | null; + userPseudoId?: string | null; } /** - * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + * Represents a turn, including a query from the user and a answer from service. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSessionTurn { /** - * Echoes the destination for the complete errors in the request if set. + * The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + answer?: string | null; /** - * A sample of errors encountered while processing the request. + * The user query. */ - errorSamples?: Schema$GoogleRpcStatus[]; + query?: Schema$GoogleCloudDiscoveryengineV1betaQuery; } /** - * Configuration of destination for Import related errors. + * SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + export interface Schema$GoogleCloudDiscoveryengineV1betaSiteSearchEngine { /** - * 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. + * The fully qualified resource name of the site search engine. Format: `projects/x/locations/x/dataStores/x/siteSearchEngine` */ - gcsPrefix?: string | null; + name?: string | null; } /** - * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Verification information for target sites in advanced site search. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo { /** - * Operation create time. + * Site verification state indicating the ownership and validity. */ - createTime?: string | null; + siteVerificationState?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Latest site verification time. */ - updateTime?: string | null; + verifyTime?: string | null; } /** - * Response message for CompletionService.ImportSuggestionDenyListEntries method. + * The Spanner source for importing data */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaSpannerSource { /** - * A sample of errors encountered while processing the request. + * Required. The database ID of the source Spanner table. */ - errorSamples?: Schema$GoogleRpcStatus[]; + databaseId?: string | null; /** - * Count of deny list entries that failed to be imported. + * Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found [here](https://cloud.google.com/spanner/docs/databoost/databoost-overview#billing_and_quotas). */ - failedEntriesCount?: string | null; + enableDataBoost?: boolean | null; /** - * Count of deny list entries successfully imported. + * Required. The instance ID of the source Spanner table. */ - importedEntriesCount?: string | null; - } - /** - * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + instanceId?: string | null; /** - * Operation create time. + * The project ID that contains the Spanner source. Has a length limit of 128 characters. If not specified, inherits the project ID from the parent request. */ - createTime?: string | null; + projectId?: string | null; /** - * Count of entries that encountered errors while processing. + * Required. The table name of the Spanner database that needs to be imported. */ - failureCount?: string | null; + tableId?: string | null; + } + /** + * Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry { /** - * Count of entries that were processed successfully. + * Required. Phrase to block from suggestions served. Can be maximum 125 characters. */ - successCount?: string | null; + blockPhrase?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase. */ - updateTime?: string | null; + matchOperator?: string | null; } /** - * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + * A target site for the SiteSearchEngine. */ - export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { - /** - * Echoes the destination for the complete errors if this field was set in the request. - */ - errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSite { /** - * A sample of errors encountered while processing the request. + * 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. */ - errorSamples?: Schema$GoogleRpcStatus[]; + exactMatch?: boolean | null; /** - * Count of user events imported with complete existing Documents. + * Output only. Failure reason. */ - joinedEventsCount?: string | null; + failureReason?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason; /** - * Count of user events imported, but with Document information not found in the existing Branch. + * Output only. This is system-generated based on the provided_uri_pattern. */ - unjoinedEventsCount?: string | null; - } - /** - * Metadata and configurations for a Google Cloud project in the service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1Project { + generatedUriPattern?: string | null; /** - * Output only. The timestamp when this project is created. + * Output only. Indexing status. */ - createTime?: string | null; + indexingStatus?: string | null; /** - * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. */ name?: string | null; /** - * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */ - provisionCompletionTime?: string | null; + providedUriPattern?: string | null; /** - * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + * Output only. Root domain of the provided_uri_pattern. */ - serviceTermsMap?: { - [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; - } | null; - } - /** - * Metadata about the terms of service. - */ - export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { + rootDomainUri?: string | null; /** - * The last time when the project agreed to the terms of service. + * Output only. Site ownership and validity verification status. */ - acceptTime?: string | null; + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1betaSiteVerificationInfo; /** - * The last time when the project declined or revoked the agreement to terms of service. + * The type of the target site, e.g., whether the site is to be included or excluded. */ - declineTime?: string | null; + type?: string | null; /** - * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. + * Output only. The target site's last updated time. */ - id?: string | null; + updateTime?: string | null; + } + /** + * Site search indexing failure reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReason { /** - * Whether the project has accepted/rejected the service terms or it is still pending. + * Failed due to insufficient quota. */ - state?: string | null; + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTargetSiteFailureReasonQuotaFailure { /** - * The version string of the terms of service. For acceptable values, see the comments for id above. + * This number is an estimation on how much total quota this project needs to successfully complete indexing. */ - version?: string | null; + totalRequiredQuota?: string | null; } /** - * Metadata associated with a project provision operation. + * Defines text input. */ - export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} + export interface Schema$GoogleCloudDiscoveryengineV1betaTextInput { + /** + * Conversation context of the input. + */ + context?: Schema$GoogleCloudDiscoveryengineV1betaConversationContext; + /** + * Text input. + */ + input?: string | null; + } /** - * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelMetadata { /** * Operation create time. */ @@ -6766,179 +7202,122 @@ export namespace discoveryengine_v1beta { updateTime?: string | null; } /** - * Response message for CompletionService.PurgeCompletionSuggestions method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { - /** - * A sample of errors encountered while processing the request. - */ - errorSamples?: Schema$GoogleRpcStatus[]; - /** - * Whether the completion suggestions were successfully purged. - */ - purgeSucceeded?: boolean | null; - } - /** - * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + * Request message for SearchTuningService.TrainCustomModel method. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { - /** - * Operation create time. - */ - createTime?: string | null; - /** - * Count of entries that encountered errors while processing. - */ - failureCount?: string | null; - /** - * Count of entries that were ignored as entries were not found. - */ - ignoredCount?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest { /** - * Count of entries that were deleted successfully. + * The desired location of errors incurred during the data ingestion and training. */ - successCount?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Operation last update time. If the operation is done, this is also the finish time. + * Cloud Storage training input. */ - updateTime?: string | null; - } - /** - * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. - */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + gcsTrainingInput?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput; /** - * The total count of documents purged as a result of the operation. + * If not provided, a UUID will be generated. */ - purgeCount?: string | null; + modelId?: string | null; /** - * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. + * Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */ - purgeSample?: string[] | null; + modelType?: string | null; } /** - * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + * Cloud Storage training data input. */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput { /** - * Operation create time. + * The Cloud Storage corpus data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id, title and text. Example: `{"_id": "doc1", title: "relevant doc", "text": "relevant text"\}` */ - createTime?: string | null; + corpusDataPath?: string | null; /** - * Operation last update time. If the operation is done, this is also the finish time. + * The gcs query data which could be associated in train data. The data path format is `gs:///`. A newline delimited jsonl/ndjson file. For search-tuning model, each line should have the _id and text. Example: {"_id": "query1", "text": "example query"\} */ - updateTime?: string | null; - } - /** - * Response message for CompletionService.PurgeSuggestionDenyListEntries method. - */ - export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + queryDataPath?: string | null; /** - * A sample of errors encountered while processing the request. + * Cloud Storage test data. Same format as train_data_path. If not provided, a random 80/20 train/test split will be performed on train_data_path. */ - errorSamples?: Schema$GoogleRpcStatus[]; + testDataPath?: string | null; /** - * Number of suggestion deny list entries purged. + * Cloud Storage training data path whose format should be `gs:///`. The file should be in tsv format. Each line should have the doc_id and query_id and score (number). For search-tuning model, it should have the query-id corpus-id score as tsv file header. The score should be a number in `[0, inf+)`. The larger the number is, the more relevant the pair is. Example: * `query-id\tcorpus-id\tscore` * `query1\tdoc1\t1` */ - purgeCount?: string | null; + trainDataPath?: string | null; } /** - * Defines the structure and layout of a type of document data. + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. */ - export interface Schema$GoogleCloudDiscoveryengineV1Schema { + export interface Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelResponse { /** - * The JSON representation of the schema. + * Echoes the destination for the complete errors in the request if set. */ - jsonSchema?: string | null; + errorConfig?: Schema$GoogleCloudDiscoveryengineV1betaImportErrorConfig; /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * A sample of errors encountered while processing the data. */ - name?: string | null; + errorSamples?: Schema$GoogleRpcStatus[]; /** - * The structured representation of the schema. + * The metrics of the trained model. */ - structSchema?: {[key: string]: any} | null; - } - /** - * Verification information for target sites in advanced site search. - */ - export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + metrics?: {[key: string]: number} | null; /** - * Site verification state indicating the ownership and validity. + * Fully qualified name of the CustomTuningModel. */ - siteVerificationState?: string | null; + modelName?: string | null; /** - * Latest site verification time. + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */ - verifyTime?: string | null; + modelStatus?: string | null; } /** - * A target site for the SiteSearchEngine. + * A transaction represents the entire purchase transaction. */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { - /** - * 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?: boolean | null; - /** - * Output only. Failure reason. - */ - failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; - /** - * Output only. This is system-generated based on the provided_uri_pattern. - */ - generatedUriPattern?: string | null; - /** - * Output only. Indexing status. - */ - indexingStatus?: string | null; + export interface Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo { /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: * Profit = value - tax - cost */ - name?: string | null; + cost?: number | null; /** - * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + * Required. Currency code. Use three-character ISO-4217 code. */ - providedUriPattern?: string | null; + currency?: string | null; /** - * Output only. Root domain of the provided_uri_pattern. + * The total discount(s) value applied to this transaction. This figure should be excluded from TransactionInfo.value For example, if a user paid TransactionInfo.value amount, then nominal (pre-discount) value of the transaction is the sum of TransactionInfo.value and TransactionInfo.discount_value This means that profit is calculated the same way, regardless of the discount value, and that TransactionInfo.discount_value can be larger than TransactionInfo.value: * Profit = value - tax - cost */ - rootDomainUri?: string | null; + discountValue?: number | null; /** - * Output only. Site ownership and validity verification status. + * All the taxes associated with the transaction. */ - siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + tax?: number | null; /** - * The type of the target site, e.g., whether the site is to be included or excluded. + * The transaction ID with a length limit of 128 characters. */ - type?: string | null; + transactionId?: string | null; /** - * Output only. The target site's last updated time. + * Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include. */ - updateTime?: string | null; + value?: number | null; } /** - * Site search indexing failure reasons. + * Metadata associated with a tune operation. */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineMetadata { /** - * Failed due to insufficient quota. + * Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` */ - quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; + engine?: string | null; } /** - * Failed due to insufficient quota. + * Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen). */ - export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { - /** - * This number is an estimation on how much total quota this project needs to successfully complete indexing. - */ - totalRequiredQuota?: string | null; - } + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest {} + /** + * Response associated with a tune operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaTuneEngineResponse {} /** * Metadata for UpdateSchema LRO. */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateSchemaMetadata { /** * Operation create time. */ @@ -6951,7 +7330,7 @@ export namespace discoveryengine_v1beta { /** * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. */ - export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + export interface Schema$GoogleCloudDiscoveryengineV1betaUpdateTargetSiteMetadata { /** * Operation create time. */ @@ -6962,134 +7341,3308 @@ export namespace discoveryengine_v1beta { updateTime?: string | null; } /** - * The request message for Operations.CancelOperation. - */ - export interface Schema$GoogleLongrunningCancelOperationRequest {} - /** - * The response message for Operations.ListOperations. + * UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with your website. */ - export interface Schema$GoogleLongrunningListOperationsResponse { + export interface Schema$GoogleCloudDiscoveryengineV1betaUserEvent { /** - * The standard List next-page token. + * 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. */ - nextPageToken?: string | null; + attributes?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1betaCustomAttribute; + } | null; /** - * A list of operations that matches the specified filter in the request. + * 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. */ - operations?: Schema$GoogleLongrunningOperation[]; - } - /** - * This resource represents a long-running operation that is the result of a network API call. - */ - export interface Schema$GoogleLongrunningOperation { + attributionToken?: string | null; /** - * 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. + * 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. */ - done?: boolean | null; + completionInfo?: Schema$GoogleCloudDiscoveryengineV1betaCompletionInfo; /** - * The error result of the operation in case of failure or cancellation. + * The DataStore resource full name, of the form `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. */ - error?: Schema$GoogleRpcStatus; + dataStore?: string | null; /** - * 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. + * 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. */ - metadata?: {[key: string]: any} | null; + directUserRequest?: boolean | null; /** - * 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\}`. + * List of Documents associated with this user event. This field is optional except for the following event types: * `view-item` * `add-to-cart` * `purchase` * `media-play` * `media-complete` In a `search` event, this field represents the documents returned to the end user on the current page (the end user may have not finished browsing the whole page yet). When a new page is returned to the end user, after pagination/filtering/ordering even for the same query, a new `search` event with different UserEvent.documents is desired. */ - name?: string | null; + documents?: Schema$GoogleCloudDiscoveryengineV1betaDocumentInfo[]; /** - * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + * The Engine resource name, in the form of `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. Optional. Only required for Engine produced user events. For example, user events from blended search. */ - response?: {[key: string]: any} | null; - } - /** - * 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); \} - */ - export interface Schema$GoogleProtobufEmpty {} - /** - * 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). - */ - export interface Schema$GoogleRpcStatus { + engine?: string | null; /** - * The status code, which should be an enum value of google.rpc.Code. + * Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */ - code?: number | null; + eventTime?: string | null; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home \> Men \> Jeans Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */ - details?: Array<{[key: string]: any}> | null; + eventType?: string | null; /** - * 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. + * 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 RecommendRequest, this field may be populated directly from 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. */ - message?: string | null; - } - /** - * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - */ - export interface Schema$GoogleTypeDate { + filter?: string | null; /** - * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + * Media-specific info. */ - day?: number | null; + mediaInfo?: Schema$GoogleCloudDiscoveryengineV1betaMediaInfo; /** - * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + * Page metadata such as categories and other critical information for certain event types such as `view-category-page`. */ - month?: number | null; + pageInfo?: Schema$GoogleCloudDiscoveryengineV1betaPageInfo; /** - * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + * Panel metadata associated with this user event. */ - year?: number | null; - } - - export class Resource$Projects { - context: APIRequestContext; + panel?: Schema$GoogleCloudDiscoveryengineV1betaPanelInfo; + /** + * The promotion IDs if this is an event associated with promotions. Currently, this field is restricted to at most one ID. + */ + promotionIds?: string[] | null; + /** + * SearchService.Search details related to the event. This field should be set for `search` event. + */ + searchInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchInfo; + /** + * 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. + */ + sessionId?: string | null; + /** + * A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. + */ + tagIds?: string[] | null; + /** + * The transaction metadata (if any) associated with this user event. + */ + transactionInfo?: Schema$GoogleCloudDiscoveryengineV1betaTransactionInfo; + /** + * Information about the end user. + */ + userInfo?: Schema$GoogleCloudDiscoveryengineV1betaUserInfo; + /** + * 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. + */ + userPseudoId?: string | null; + } + /** + * Information of an end user. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaUserInfo { + /** + * 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 | null; + /** + * Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userId?: string | null; + } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaWorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } + /** + * Defines circumstances to be checked before allowing a behavior + */ + export interface Schema$GoogleCloudDiscoveryengineV1Condition { + /** + * Range of time(s) specifying when condition is active. Maximum of 10 time ranges. + */ + activeTimeRange?: Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange[]; + /** + * Search only A list of terms to match the query on. Maximum of 10 query terms. + */ + queryTerms?: Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm[]; + } + /** + * Matcher for search request query + */ + export interface Schema$GoogleCloudDiscoveryengineV1ConditionQueryTerm { + /** + * Whether the search query needs to exactly match the query term. + */ + fullMatch?: boolean | null; + /** + * The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. + */ + value?: string | null; + } + /** + * Used for time-dependent conditions. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ConditionTimeRange { + /** + * End of time range. Range is inclusive. Must be in the future. + */ + endTime?: string | null; + /** + * Start of time range. Range is inclusive. + */ + startTime?: string | null; + } + /** + * Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Control { + /** + * Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. + */ + associatedServingConfigIds?: string[] | null; + /** + * Defines a boost-type control + */ + boostAction?: Schema$GoogleCloudDiscoveryengineV1ControlBoostAction; + /** + * Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. + */ + conditions?: Schema$GoogleCloudDiscoveryengineV1Condition[]; + /** + * Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + displayName?: string | null; + /** + * Defines a filter-type control Currently not supported by Recommendation + */ + filterAction?: Schema$GoogleCloudDiscoveryengineV1ControlFilterAction; + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string | null; + /** + * Defines a redirect-type control. + */ + redirectAction?: Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction; + /** + * Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. + */ + solutionType?: string | null; + /** + * Treats a group of terms as synonyms of one another. + */ + synonymsAction?: Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction; + /** + * Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. + */ + useCases?: string[] | null; + } + /** + * Adjusts order of products in returned list. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ControlBoostAction { + /** + * Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). + */ + boost?: number | null; + /** + * Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + */ + dataStore?: string | null; + /** + * Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + filter?: string | null; + } + /** + * Specified which products may be included in results. Uses same filter as boost. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ControlFilterAction { + /** + * Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store + */ + dataStore?: string | null; + /** + * Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + filter?: string | null; + } + /** + * Redirects a shopper to the provided URI. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ControlRedirectAction { + /** + * Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. + */ + redirectUri?: string | null; + } + /** + * Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". + */ + export interface Schema$GoogleCloudDiscoveryengineV1ControlSynonymsAction { + /** + * Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. + */ + synonyms?: string[] | null; + } + /** + * Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for Create Schema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * DataStore captures global settings and configs at the DataStore level. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DataStore { + /** + * Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. + */ + contentConfig?: string | null; + /** + * Output only. Timestamp the DataStore was created at. + */ + createTime?: string | null; + /** + * Output only. The id of the default Schema asscociated to this data store. + */ + defaultSchemaId?: string | null; + /** + * Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + displayName?: string | null; + /** + * Configuration for Document understanding and enrichment. + */ + documentProcessingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig; + /** + * Immutable. The industry vertical that the data store registers. + */ + industryVertical?: string | null; + /** + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled. + */ + solutionTypes?: string[] | null; + /** + * The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema). + */ + startingSchema?: Schema$GoogleCloudDiscoveryengineV1Schema; + /** + * Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE. + */ + workspaceConfig?: Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig; + } + /** + * Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteEngineMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata for DeleteSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse {} + /** + * A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfig { + /** + * Whether chunking mode is enabled. + */ + chunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig; + /** + * Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing. + */ + defaultParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + /** + * The full resource name of the Document Processing Config. Format: `projects/x/locations/x/collections/x/dataStores/x/documentProcessingConfig`. + */ + name?: string | null; + /** + * Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. + */ + parsingConfigOverrides?: { + [ + key: string + ]: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig; + } | null; + } + /** + * Configuration for chunking config. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig { + /** + * Configuration for the layout based chunking. + */ + layoutBasedChunkingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig; + } + /** + * Configuration for the layout based chunking. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig { + /** + * The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. + */ + chunkSize?: number | null; + /** + * Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False. + */ + includeAncestorHeadings?: boolean | null; + } + /** + * Related configurations applied to a specific type of document parser. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig { + /** + * Configurations applied to digital parser. + */ + digitalParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig; + /** + * Configurations applied to layout parser. + */ + layoutParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig; + /** + * Configurations applied to OCR parser. Currently it only applies to PDFs. + */ + ocrParsingConfig?: Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig; + } + /** + * The digital parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {} + /** + * The layout parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {} + /** + * The OCR parsing configurations for documents. + */ + export interface Schema$GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig { + /** + * [DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`. + */ + enhancedDocumentElements?: string[] | null; + /** + * If true, will use native text instead of OCR text on pages containing native text. + */ + useNativeText?: boolean | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse {} + /** + * Metadata that describes the training and serving parameters of an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Engine { + /** + * Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + */ + chatEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig; + /** + * Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. + */ + chatEngineMetadata?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata; + /** + * Common config spec that specifies the metadata of the engine. + */ + commonConfig?: Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig; + /** + * Output only. Timestamp the Recommendation Engine was created at. + */ + createTime?: string | null; + /** + * The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations. + */ + dataStoreIds?: string[] | null; + /** + * Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. + */ + displayName?: string | null; + /** + * The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. + */ + industryVertical?: string | null; + /** + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. + */ + name?: string | null; + /** + * Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. + */ + searchEngineConfig?: Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig; + /** + * Required. The solutions of the engine. + */ + solutionType?: string | null; + /** + * Output only. Timestamp the Recommendation Engine was last updated. + */ + updateTime?: string | null; + } + /** + * Configurations for a Chat Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfig { + /** + * The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + agentCreationConfig?: Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig; + /** + * The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created. + */ + dialogflowAgentToLink?: string | null; + } + /** + * Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig { + /** + * Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. + */ + business?: string | null; + /** + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + */ + defaultLanguageCode?: string | null; + /** + * Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default. + */ + location?: string | null; + /** + * Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. + */ + timeZone?: string | null; + } + /** + * Additional information of a Chat Engine. Fields in this message are output only. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineChatEngineMetadata { + /** + * The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`. + */ + dialogflowAgent?: string | null; + } + /** + * Common configurations for an Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineCommonConfig { + /** + * The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. + */ + companyName?: string | null; + } + /** + * Configurations for a Search Engine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1EngineSearchEngineConfig { + /** + * The add-on that this search engine enables. + */ + searchAddOns?: string[] | null; + /** + * The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. + */ + searchTier?: string | null; + } + /** + * Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of CompletionSuggestions that failed to be imported. + */ + failureCount?: string | null; + /** + * Count of CompletionSuggestions successfully imported. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse { + /** + * The desired location of errors incurred during the Import. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Total count of entries that were processed. + */ + totalCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportDocumentsResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + } + /** + * Configuration of destination for Import related errors. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig { + /** + * 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. + */ + gcsPrefix?: string | null; + } + /** + * Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.ImportSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of deny list entries that failed to be imported. + */ + failedEntriesCount?: string | null; + /** + * Count of deny list entries successfully imported. + */ + importedEntriesCount?: string | null; + } + /** + * Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were processed successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ImportUserEventsResponse { + /** + * Echoes the destination for the complete errors if this field was set in the request. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Count of user events imported with complete existing Documents. + */ + joinedEventsCount?: string | null; + /** + * Count of user events imported, but with Document information not found in the existing Branch. + */ + unjoinedEventsCount?: string | null; + } + /** + * Metadata and configurations for a Google Cloud project in the service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Project { + /** + * Output only. The timestamp when this project is created. + */ + createTime?: string | null; + /** + * Output only. Full resource name of the project, for example `projects/{project_number\}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number. + */ + name?: string | null; + /** + * Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use. + */ + provisionCompletionTime?: string | null; + /** + * Output only. A map of terms of services. The key is the `id` of ServiceTerms. + */ + serviceTermsMap?: { + [key: string]: Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms; + } | null; + } + /** + * Metadata about the terms of service. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProjectServiceTerms { + /** + * The last time when the project agreed to the terms of service. + */ + acceptTime?: string | null; + /** + * The last time when the project declined or revoked the agreement to terms of service. + */ + declineTime?: string | null; + /** + * The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`. + */ + id?: string | null; + /** + * Whether the project has accepted/rejected the service terms or it is still pending. + */ + state?: string | null; + /** + * The version string of the terms of service. For acceptable values, see the comments for id above. + */ + version?: string | null; + } + /** + * Metadata associated with a project provision operation. + */ + export interface Schema$GoogleCloudDiscoveryengineV1ProvisionProjectMetadata {} + /** + * Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeCompletionSuggestions method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Whether the completion suggestions were successfully purged. + */ + purgeSucceeded?: boolean | null; + } + /** + * Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Count of entries that encountered errors while processing. + */ + failureCount?: string | null; + /** + * Count of entries that were ignored as entries were not found. + */ + ignoredCount?: string | null; + /** + * Count of entries that were deleted successfully. + */ + successCount?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeDocumentsResponse { + /** + * The total count of documents purged as a result of the operation. + */ + purgeCount?: string | null; + /** + * A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. + */ + purgeSample?: string[] | null; + } + /** + * Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response message for CompletionService.PurgeSuggestionDenyListEntries method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse { + /** + * A sample of errors encountered while processing the request. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * Number of suggestion deny list entries purged. + */ + purgeCount?: string | null; + } + /** + * Defines the structure and layout of a type of document data. + */ + export interface Schema$GoogleCloudDiscoveryengineV1Schema { + /** + * The JSON representation of the schema. + */ + jsonSchema?: string | null; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string | null; + /** + * The structured representation of the schema. + */ + structSchema?: {[key: string]: any} | null; + } + /** + * Verification information for target sites in advanced site search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo { + /** + * Site verification state indicating the ownership and validity. + */ + siteVerificationState?: string | null; + /** + * Latest site verification time. + */ + verifyTime?: string | null; + } + /** + * A target site for the SiteSearchEngine. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSite { + /** + * 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?: boolean | null; + /** + * Output only. Failure reason. + */ + failureReason?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason; + /** + * Output only. This is system-generated based on the provided_uri_pattern. + */ + generatedUriPattern?: string | null; + /** + * Output only. Indexing status. + */ + indexingStatus?: string | null; + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string | null; + /** + * Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. + */ + providedUriPattern?: string | null; + /** + * Output only. Root domain of the provided_uri_pattern. + */ + rootDomainUri?: string | null; + /** + * Output only. Site ownership and validity verification status. + */ + siteVerificationInfo?: Schema$GoogleCloudDiscoveryengineV1SiteVerificationInfo; + /** + * The type of the target site, e.g., whether the site is to be included or excluded. + */ + type?: string | null; + /** + * Output only. The target site's last updated time. + */ + updateTime?: string | null; + } + /** + * Site search indexing failure reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReason { + /** + * Failed due to insufficient quota. + */ + quotaFailure?: Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure; + } + /** + * Failed due to insufficient quota. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure { + /** + * This number is an estimation on how much total quota this project needs to successfully complete indexing. + */ + totalRequiredQuota?: string | null; + } + /** + * Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1TrainCustomModelResponse { + /** + * Echoes the destination for the complete errors in the request if set. + */ + errorConfig?: Schema$GoogleCloudDiscoveryengineV1ImportErrorConfig; + /** + * A sample of errors encountered while processing the data. + */ + errorSamples?: Schema$GoogleRpcStatus[]; + /** + * The metrics of the trained model. + */ + metrics?: {[key: string]: number} | null; + /** + * Fully qualified name of the CustomTuningModel. + */ + modelName?: string | null; + /** + * The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. + */ + modelStatus?: string | null; + } + /** + * Metadata for UpdateSchema LRO. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateSchemaMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + } + /** + * Config to store data store type configuration for workspace data + */ + export interface Schema$GoogleCloudDiscoveryengineV1WorkspaceConfig { + /** + * Obfuscated Dasher customer ID. + */ + dasherCustomerId?: string | null; + /** + * The Google Workspace data source. + */ + type?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$GoogleLongrunningCancelOperationRequest {} + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$GoogleLongrunningOperation { + /** + * 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?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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?: {[key: string]: any} | null; + /** + * 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 | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * 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); \} + */ + export interface Schema$GoogleProtobufEmpty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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 | null; + } + /** + * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp + */ + export interface Schema$GoogleTypeDate { + /** + * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + + export class Resource$Projects { + context: APIRequestContext; locations: Resource$Projects$Locations; operations: Resource$Projects$Operations; constructor(context: APIRequestContext) { this.context = context; - this.locations = new Resource$Projects$Locations(this.context); - this.operations = new Resource$Projects$Operations(this.context); + this.locations = new Resource$Projects$Locations(this.context); + this.operations = new Resource$Projects$Operations(this.context); + } + + /** + * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions + ): GaxiosPromise; + provision( + params?: Params$Resource$Projects$Provision, + options?: MethodOptions + ): GaxiosPromise; + provision( + params: Params$Resource$Projects$Provision, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + provision( + params: Params$Resource$Projects$Provision, + callback: BodyResponseCallback + ): void; + provision( + callback: BodyResponseCallback + ): void; + provision( + paramsOrCallback?: + | Params$Resource$Projects$Provision + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Provision; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Provision; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:provision').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Provision + extends StandardParameters { + /** + * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + collections: Resource$Projects$Locations$Collections; + dataStores: Resource$Projects$Locations$Datastores; + evaluations: Resource$Projects$Locations$Evaluations; + groundingConfigs: Resource$Projects$Locations$Groundingconfigs; + operations: Resource$Projects$Locations$Operations; + rankingConfigs: Resource$Projects$Locations$Rankingconfigs; + sampleQuerySets: Resource$Projects$Locations$Samplequerysets; + userEvents: Resource$Projects$Locations$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.collections = new Resource$Projects$Locations$Collections( + this.context + ); + this.dataStores = new Resource$Projects$Locations$Datastores( + this.context + ); + this.evaluations = new Resource$Projects$Locations$Evaluations( + this.context + ); + this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( + this.context + ); + this.sampleQuerySets = new Resource$Projects$Locations$Samplequerysets( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Userevents( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections { + context: APIRequestContext; + dataConnector: Resource$Projects$Locations$Collections$Dataconnector; + dataStores: Resource$Projects$Locations$Collections$Datastores; + engines: Resource$Projects$Locations$Collections$Engines; + operations: Resource$Projects$Locations$Collections$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.dataConnector = + new Resource$Projects$Locations$Collections$Dataconnector(this.context); + this.dataStores = new Resource$Projects$Locations$Collections$Datastores( + this.context + ); + this.engines = new Resource$Projects$Locations$Collections$Engines( + this.context + ); + this.operations = new Resource$Projects$Locations$Collections$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Dataconnector$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores { + context: APIRequestContext; + branches: Resource$Projects$Locations$Collections$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Collections$Datastores$Controls; + conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; + customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; + models: Resource$Projects$Locations$Collections$Datastores$Models; + operations: Resource$Projects$Locations$Collections$Datastores$Operations; + schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; + constructor(context: APIRequestContext) { + this.context = context; + this.branches = + new Resource$Projects$Locations$Collections$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( + this.context + ); + this.controls = + new Resource$Projects$Locations$Collections$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Datastores$Conversations( + this.context + ); + this.customModels = + new Resource$Projects$Locations$Collections$Datastores$Custommodels( + this.context + ); + this.models = + new Resource$Projects$Locations$Collections$Datastores$Models( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Operations( + this.context + ); + this.schemas = + new Resource$Projects$Locations$Collections$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = + new Resource$Projects$Locations$Collections$Datastores$Userevents( + this.context + ); + } + + /** + * Completes the specified user input with keyword suggestions. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions + ): GaxiosPromise; + completeQuery( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options?: MethodOptions + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + completeQuery( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + callback: BodyResponseCallback + ): void; + completeQuery( + callback: BodyResponseCallback + ): void; + completeQuery( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Completequery + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a DataStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the SiteSearchEngine. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: StreamMethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options?: MethodOptions + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + callback: BodyResponseCallback + ): void; + getSiteSearchEngine( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all the DataStores associated with the project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a DataStore + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Trains a custom model. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions + ): GaxiosPromise; + trainCustomModel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options?: MethodOptions + ): GaxiosPromise; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + trainCustomModel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + callback: BodyResponseCallback + ): void; + trainCustomModel( + callback: BodyResponseCallback + ): void; + trainCustomModel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['dataStore'], + pathParams: ['dataStore'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery + extends StandardParameters { + /** + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. + */ + dataStore?: string; + /** + * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + */ + queryModel?: string; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + extends StandardParameters { + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Get + extends StandardParameters { + /** + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + */ + pageSize?: number; + /** + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + */ + pageToken?: string; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch + extends StandardParameters { + /** + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel + extends StandardParameters { + /** + * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. + */ + dataStore?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( + this.context + ); + } + + /** + * Gets index freshness metadata for Documents. Supported for website search only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options?: MethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+parent}/batchGetDocumentsMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Batchgetdocumentsmetadata + extends StandardParameters { + /** + * The exact URIs to match by. + */ + 'matcher.urisMatcher.uris'?: string[]; + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a list of Documents. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a Document. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms. + * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - provision( - params: Params$Resource$Projects$Provision, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - provision( - params?: Params$Resource$Projects$Provision, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options?: MethodOptions ): GaxiosPromise; - provision( - params: Params$Resource$Projects$Provision, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - provision( - params: Params$Resource$Projects$Provision, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, callback: BodyResponseCallback ): void; - provision( + purge( callback: BodyResponseCallback ): void; - provision( + purge( paramsOrCallback?: - | Params$Resource$Projects$Provision + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7105,12 +10658,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Provision; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Provision; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; options = {}; } @@ -7124,7 +10678,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:provision').replace( + url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( /([^:]\/)\/+/g, '$1' ), @@ -7134,8 +10688,8 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -7149,150 +10703,158 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Provision + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create extends StandardParameters { /** - * Required. Full resource name of a Project, such as `projects/{project_id_or_number\}`. + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */ - name?: string; + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaProvisionProjectRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + extends StandardParameters { + /** + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + extends StandardParameters { + /** + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + */ + parent?: string; - export class Resource$Projects$Locations { - context: APIRequestContext; - collections: Resource$Projects$Locations$Collections; - dataStores: Resource$Projects$Locations$Datastores; - groundingConfigs: Resource$Projects$Locations$Groundingconfigs; - operations: Resource$Projects$Locations$Operations; - rankingConfigs: Resource$Projects$Locations$Rankingconfigs; - userEvents: Resource$Projects$Locations$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.collections = new Resource$Projects$Locations$Collections( - this.context - ); - this.dataStores = new Resource$Projects$Locations$Datastores( - this.context - ); - this.groundingConfigs = new Resource$Projects$Locations$Groundingconfigs( - this.context - ); - this.operations = new Resource$Projects$Locations$Operations( - this.context - ); - this.rankingConfigs = new Resource$Projects$Locations$Rankingconfigs( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Userevents( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List + extends StandardParameters { + /** + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * 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. + */ + parent?: string; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch + extends StandardParameters { + /** + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + */ + updateMask?: string; - export class Resource$Projects$Locations$Collections { - context: APIRequestContext; - dataConnector: Resource$Projects$Locations$Collections$Dataconnector; - dataStores: Resource$Projects$Locations$Collections$Datastores; - engines: Resource$Projects$Locations$Collections$Engines; - operations: Resource$Projects$Locations$Collections$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.dataConnector = - new Resource$Projects$Locations$Collections$Dataconnector(this.context); - this.dataStores = new Resource$Projects$Locations$Collections$Datastores( - this.context - ); - this.engines = new Resource$Projects$Locations$Collections$Engines( - this.context - ); - this.operations = new Resource$Projects$Locations$Collections$Operations( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; - export class Resource$Projects$Locations$Collections$Dataconnector { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Dataconnector$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Dataconnector$Operations( - this.context - ); - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; } - export class Resource$Projects$Locations$Collections$Dataconnector$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + cancel( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; options = {}; } @@ -7306,8 +10868,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -7318,273 +10883,169 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | BodyResponseCallback | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Dataconnector$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Collections$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Collections$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Collections$Datastores$Controls; - conversations: Resource$Projects$Locations$Collections$Datastores$Conversations; - customModels: Resource$Projects$Locations$Collections$Datastores$Custommodels; - models: Resource$Projects$Locations$Collections$Datastores$Models; - operations: Resource$Projects$Locations$Collections$Datastores$Operations; - schemas: Resource$Projects$Locations$Collections$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Collections$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Collections$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = - new Resource$Projects$Locations$Collections$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Collections$Datastores$Completionsuggestions( - this.context - ); - this.controls = - new Resource$Projects$Locations$Collections$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Datastores$Conversations( - this.context - ); - this.customModels = - new Resource$Projects$Locations$Collections$Datastores$Custommodels( - this.context - ); - this.models = - new Resource$Projects$Locations$Collections$Datastores$Models( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Operations( - this.context - ); - this.schemas = - new Resource$Projects$Locations$Collections$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Datastores$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = - new Resource$Projects$Locations$Collections$Datastores$Userevents( - this.context + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Completes the specified user input with keyword suggestions. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completequery, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + callback: BodyResponseCallback ): void; - completeQuery( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - completeQuery( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completequery - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completequery; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; options = {}; } @@ -7598,7 +11059,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -7608,60 +11069,106 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel + extends StandardParameters { /** - * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Create + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7677,13 +11184,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; options = {}; } @@ -7697,10 +11204,9 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -7722,43 +11228,43 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a DataStore. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, callback: BodyResponseCallback ): void; - delete( + purge( callback: BodyResponseCallback ): void; - delete( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Delete + | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7774,13 +11280,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; options = {}; } @@ -7794,15 +11300,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -7814,67 +11322,99 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Gets a DataStore. + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; options = {}; } @@ -7888,89 +11428,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; options = {}; } @@ -7985,7 +11524,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -7996,77 +11535,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the DataStores associated with the project. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; options = {}; } @@ -8080,92 +11617,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataStore + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; options = {}; } @@ -8179,89 +11713,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Trains a custom model. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - trainCustomModel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - trainCustomModel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - trainCustomModel( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - trainCustomModel( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; options = {}; } @@ -8275,321 +11812,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+dataStore}:trainCustomModel').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. - */ - queryModel?: string; - /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create extends StandardParameters { /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. */ - dataStoreId?: string; + controlId?: string; /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete extends StandardParameters { /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Getsitesearchengine + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get extends StandardParameters { /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List extends StandardParameters { /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. */ filter?: string; /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Patch - extends StandardParameters { - /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Traincustommodel - extends StandardParameters { - /** - * Required. The resource name of the Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models. - */ - dataStore?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTrainCustomModelRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Collections$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Collections$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Collections$Datastores$Branches$Documents( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Branches$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Branches$Documents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a Document. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create; - options = {}; - } + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + export class Resource$Projects$Locations$Collections$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Deletes a Document. + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + converse( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + converse( + callback: BodyResponseCallback + ): void; + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; options = {}; } @@ -8603,8 +11981,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -8615,75 +11996,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Document. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; options = {}; } @@ -8697,89 +12080,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; options = {}; } @@ -8793,90 +12175,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; options = {}; } @@ -8890,92 +12269,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; options = {}; } @@ -8989,89 +12365,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; options = {}; } @@ -9085,183 +12464,174 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ - documentId?: string; + name?: string; + /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List extends StandardParameters { /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ - parent?: string; - + filter?: string; /** - * Request body metadata + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * 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. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Patch - extends StandardParameters { - /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Documents$Purge + export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch extends StandardParameters { /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. */ - parent?: string; + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export class Resource$Projects$Locations$Collections$Datastores$Branches$Operations { + export class Resource$Projects$Locations$Collections$Datastores$Custommodels { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Gets a list of all the custom models. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; options = {}; } @@ -9275,29 +12645,58 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:cancel').replace( + url: (rootUrl + '/v1beta/{+dataStore}/customModels').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List + extends StandardParameters { + /** + * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. + */ + dataStore?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Models$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * 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. @@ -9308,27 +12707,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -9336,7 +12735,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9352,13 +12751,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; options = {}; } @@ -9402,27 +12801,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, callback: BodyResponseCallback ): void; list( @@ -9430,7 +12829,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9446,13 +12845,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; options = {}; } @@ -9493,26 +12892,14 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List extends StandardParameters { /** * The standard list filter. @@ -9532,50 +12919,50 @@ export namespace discoveryengine_v1beta { pageToken?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Collections$Datastores$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, callback: BodyResponseCallback ): void; - import( + get( callback: BodyResponseCallback ): void; - import( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -9591,13 +12978,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; options = {}; } @@ -9611,17 +12998,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -9635,65 +13020,65 @@ export namespace discoveryengine_v1beta { } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - purge( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; options = {}; } @@ -9704,66 +13089,76 @@ export namespace discoveryengine_v1beta { const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Import + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get extends StandardParameters { /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata + * The name of the operation resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; + name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Completionsuggestions$Purge + export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List extends StandardParameters { /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * The standard list filter. */ - parent?: string; - + filter?: string; /** - * Request body metadata + * The name of the operation's parent resource. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; } - export class Resource$Projects$Locations$Collections$Datastores$Controls { + export class Resource$Projects$Locations$Collections$Datastores$Schemas { context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( + this.context + ); } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9771,57 +13166,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; options = {}; } @@ -9835,7 +13230,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -9850,19 +13245,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9870,53 +13263,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; options = {}; } @@ -9942,17 +13339,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Control. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9960,57 +13357,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; options = {}; } @@ -10036,19 +13433,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10056,57 +13453,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; options = {}; } @@ -10120,7 +13517,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( /([^:]\/)\/+/g, '$1' ), @@ -10135,19 +13532,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10155,57 +13552,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; options = {}; } @@ -10231,150 +13628,144 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Create + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create extends StandardParameters { /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ - controlId?: string; + parent?: string; /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */ - parent?: string; + schemaId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Delete + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete extends StandardParameters { /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List extends StandardParameters { /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Controls$Patch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */ - name?: string; + allowMissing?: boolean; /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ - updateMask?: string; + name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; } - export class Resource$Projects$Locations$Collections$Datastores$Conversations { + export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Converses a conversation. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - converse( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; options = {}; } @@ -10388,11 +13779,8 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -10403,77 +13791,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; options = {}; } @@ -10487,88 +13873,126 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + extends StandardParameters { /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + answer( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + answer( + callback: BodyResponseCallback + ): void; + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; options = {}; } @@ -10582,29 +14006,34 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10612,57 +14041,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; options = {}; } @@ -10688,19 +14117,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10708,57 +14137,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; options = {}; } @@ -10772,7 +14201,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), @@ -10787,19 +14216,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -10807,57 +14236,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; options = {}; } @@ -10868,177 +14297,92 @@ export namespace discoveryengine_v1beta { const rootUrl = options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - - export class Resource$Projects$Locations$Collections$Datastores$Custommodels { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * Gets a list of all the custom models. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - list( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; options = {}; } @@ -11052,213 +14396,278 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+dataStore}/customModels').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Custommodels$List - extends StandardParameters { - /** - * Required. The resource name of the parent Data Store, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. - */ - dataStore?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Collections$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + search( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - get( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get; - options = {}; - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback + export class Resource$Projects$Locations$Collections$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( + this.context ); - } else { - return createAPIRequest(parameters); - } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; options = {}; } @@ -11272,126 +14681,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; options = {}; } @@ -11406,7 +14777,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -11417,75 +14788,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - | BodyResponseCallback + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; options = {}; } @@ -11499,10 +14870,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -11514,116 +14882,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Schemas { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Schemas$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Schemas$Operations( - this.context - ); - } /** - * Creates a Schema. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; options = {}; } @@ -11637,11 +14966,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -11652,75 +14981,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Schema. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; options = {}; } @@ -11735,7 +15066,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -11746,17 +15077,92 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create + extends StandardParameters { /** - * Gets a Schema. + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11764,57 +15170,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; options = {}; } @@ -11840,77 +15246,102 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get + extends StandardParameters { /** - * Gets a list of Schemas. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; + targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( + this.context + ); + this.targetSites = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( + this.context + ); + } + + /** + * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + batchVerifyTargetSites( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + ): GaxiosPromise; + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List, - callback: BodyResponseCallback + batchVerifyTargetSites( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchVerifyTargetSites( + callback: BodyResponseCallback ): void; - list( + batchVerifyTargetSites( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; options = {}; } @@ -11924,11 +15355,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + url: (rootUrl + '/v1beta/{+parent}:batchVerifyTargetSites').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -11939,55 +15370,53 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback ): void; - patch( + disableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - patch( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12003,13 +15432,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -12023,15 +15452,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -12043,114 +15474,45 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Create - extends StandardParameters { - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$List - extends StandardParameters { - /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Patch - extends StandardParameters { - /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - - export class Resource$Projects$Locations$Collections$Datastores$Schemas$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback ): void; - get( + enableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - get( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -12166,13 +15528,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -12186,15 +15548,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -12208,65 +15572,65 @@ export namespace discoveryengine_v1beta { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + fetchDomainVerificationStatus( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + ): GaxiosPromise; + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List, - callback: BodyResponseCallback + fetchDomainVerificationStatus( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + fetchDomainVerificationStatus( + callback: BodyResponseCallback ): void; - list( + fetchDomainVerificationStatus( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; options = {}; } @@ -12280,126 +15644,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + + '/v1beta/{+siteSearchEngine}:fetchDomainVerificationStatus' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Schemas$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + recrawlUris( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - answer( + recrawlUris( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -12408,39 +15738,108 @@ export namespace discoveryengine_v1beta { options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + extends StandardParameters { + /** + * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12448,57 +15847,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; options = {}; } @@ -12524,19 +15923,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -12544,57 +15941,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; options = {}; } @@ -12608,7 +16005,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), @@ -12618,82 +16015,121 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( + this.context + ); + } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + batchCreate( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - patch( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -12707,89 +16143,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Makes a recommendation, which requires a contextual user event. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + create( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - recommend( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -12803,7 +16239,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), @@ -12813,82 +16249,80 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + delete( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - search( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -12902,179 +16336,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Answer - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$List - extends StandardParameters { - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sessions { - context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Datastores$Sessions$Answers; - constructor(context: APIRequestContext) { - this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Datastores$Sessions$Answers( - this.context - ); - } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -13088,88 +16430,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -13183,87 +16526,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Session. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -13278,7 +16626,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -13289,77 +16637,148 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { /** - * Lists all Sessions by their parent DataStore. + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + + export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + get( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; options = {}; } @@ -13373,92 +16792,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + list( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; options = {}; } @@ -13472,8 +16886,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -13484,150 +16901,111 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Get + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$List + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + * The standard list filter. */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + * The name of the operation's parent resource. */ - orderBy?: string; + name?: string; /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * The standard list page size. */ pageSize?: number; /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * The standard list page token. */ pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; } - export class Resource$Projects$Locations$Collections$Datastores$Sessions$Answers { + export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Answer. + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -13641,92 +17019,67 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations; - targetSites: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations( - this.context - ); - this.targetSites = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites( - this.context - ); - } /** - * Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions ): GaxiosPromise; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + purge( callback: BodyResponseCallback ): void; - batchVerifyTargetSites( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13742,13 +17095,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -13762,10 +17115,9 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}:batchVerifyTargetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -13785,67 +17137,95 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import + extends StandardParameters { /** - * Downgrade from advanced site search to basic site search. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; + } + + export class Resource$Projects$Locations$Collections$Datastores$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + collect( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options?: MethodOptions - ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch, - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - callback: BodyResponseCallback + collect( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + collect(callback: BodyResponseCallback): void; + collect( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; options = {}; } @@ -13859,67 +17239,68 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Upgrade from basic site search to advanced site search. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + import( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options?: MethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch, + import( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + import( callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -13935,13 +17316,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; options = {}; } @@ -13955,17 +17336,18 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -13979,65 +17361,65 @@ export namespace discoveryengine_v1beta { } /** - * Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - fetchDomainVerificationStatus( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + purge( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options?: MethodOptions - ): GaxiosPromise; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge, + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - fetchDomainVerificationStatus( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge; options = {}; } @@ -14051,92 +17433,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v1beta/{+siteSearchEngine}:fetchDomainVerificationStatus' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Request on-demand recrawl for a list of URIs. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + write( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - recrawlUris( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - recrawlUris( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; options = {}; } @@ -14150,7 +17530,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( + url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( /([^:]\/)\/+/g, '$1' ), @@ -14160,129 +17540,152 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Batchverifytargetsites + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect extends StandardParameters { /** - * Required. The parent resource shared by all TargetSites being verified. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. */ parent?: string; - /** - * Request body metadata + * 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. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchVerifyTargetSitesRequest; + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Disableadvancedsitesearch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` */ - siteSearchEngine?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Enableadvancedsitesearch + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Purge extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` */ - siteSearchEngine?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Fetchdomainverificationstatus + export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write extends StandardParameters { /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `FetchDomainVerificationStatus` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDomainVerificationStatus` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The site search engine resource under which we fetch all the domain verification status. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. */ - siteSearchEngine?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris - extends StandardParameters { + parent?: string; /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. */ - siteSearchEngine?: string; + writeAsync?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; } - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { + export class Resource$Projects$Locations$Collections$Engines { context: APIRequestContext; + controls: Resource$Projects$Locations$Collections$Engines$Controls; + conversations: Resource$Projects$Locations$Collections$Engines$Conversations; + operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; + sessions: Resource$Projects$Locations$Collections$Engines$Sessions; constructor(context: APIRequestContext) { this.context = context; + this.controls = + new Resource$Projects$Locations$Collections$Engines$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Collections$Engines$Conversations( + this.context + ); + this.operations = + new Resource$Projects$Locations$Collections$Engines$Operations( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); + this.sessions = + new Resource$Projects$Locations$Collections$Engines$Sessions( + this.context + ); } /** - * 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. + * Creates a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Create, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Create, callback: BodyResponseCallback ): void; - get( + create( callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get + | Params$Resource$Projects$Locations$Collections$Engines$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14298,13 +17701,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Create; options = {}; } @@ -14318,15 +17721,18 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/engines').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -14340,65 +17746,65 @@ export namespace discoveryengine_v1beta { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Deletes a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - list( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; options = {}; } @@ -14412,11 +17818,8 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -14427,116 +17830,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites { - context: APIRequestContext; - operations: Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations( - this.context - ); - } /** - * Creates TargetSite in a batch. + * Gets a Engine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Get, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Get, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {} as Params$Resource$Projects$Locations$Collections$Engines$Get; options = {}; } @@ -14550,89 +17912,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Creates a TargetSite. + * Lists all the Engines associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$List; options = {}; } @@ -14646,11 +18008,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + url: (rootUrl + '/v1beta/{+parent}/engines').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -14661,75 +18023,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a TargetSite. + * Updates an Engine * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - delete( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; options = {}; } @@ -14744,7 +18108,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', apiVersion: '', }, options @@ -14755,75 +18119,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a TargetSite. + * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + pause( + params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + ): GaxiosPromise; + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + pause( + params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + pause( + callback: BodyResponseCallback ): void; - get( + pause( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Pause + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; options = {}; } @@ -14837,8 +18203,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}:pause').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -14849,77 +18218,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of TargetSites. + * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + resume( + params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + ): GaxiosPromise; + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + resume( + params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + resume( + callback: BodyResponseCallback ): void; - list( + resume( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Resume + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; options = {}; } @@ -14933,70 +18302,70 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + url: (rootUrl + '/v1beta/{+name}:resume').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a TargetSite. + * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + tune( + params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch, + tune( + params: Params$Resource$Projects$Locations$Collections$Engines$Tune, callback: BodyResponseCallback ): void; - patch( + tune( callback: BodyResponseCallback ): void; - patch( + tune( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + | Params$Resource$Projects$Locations$Collections$Engines$Tune | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -15012,13 +18381,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; options = {}; } @@ -15032,8 +18401,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+name}:tune').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -15054,232 +18426,174 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Batchcreate + export interface Params$Resource$Projects$Locations$Collections$Engines$Create extends StandardParameters { /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata + * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { + engineId?: string; /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Delete + export interface Params$Resource$Projects$Locations$Collections$Engines$Delete extends StandardParameters { /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Get extends StandardParameters { /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$List + export interface Params$Resource$Projects$Locations$Collections$Engines$List extends StandardParameters { /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH + */ + filter?: string; + /** + * Optional. Not supported. */ pageSize?: number; /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + * Optional. Not supported. */ pageToken?: string; /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Patch extends StandardParameters { /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. */ name?: string; + /** + * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; } - - export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } + export interface Params$Resource$Projects$Locations$Collections$Engines$Pause + extends StandardParameters { + /** + * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; /** - * 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. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Request body metadata */ - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Resume + extends StandardParameters { + /** + * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Tune + extends StandardParameters { + /** + * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` + */ + name?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Collections$Engines$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + create( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; options = {}; } @@ -15293,126 +18607,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Targetsites$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + delete( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; options = {}; } @@ -15426,89 +18702,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - purge( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; options = {}; } @@ -15522,117 +18796,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Suggestiondenylistentries$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; - } - - export class Resource$Projects$Locations$Collections$Datastores$Userevents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } } /** - * 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. + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; options = {}; } @@ -15646,7 +18892,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( + url: (rootUrl + '/v1beta/{+parent}/controls').replace( /([^:]\/)\/+/g, '$1' ), @@ -15661,75 +18907,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - import( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; options = {}; } @@ -15743,90 +18991,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + extends StandardParameters { /** - * Writes a single user event. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + + export class Resource$Projects$Locations$Collections$Engines$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + converse( + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + converse( + callback: BodyResponseCallback ): void; - write( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - | BodyResponseCallback + converse( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; options = {}; } @@ -15840,7 +19160,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( + url: (rootUrl + '/v1beta/{+name}:converse').replace( /([^:]\/)\/+/g, '$1' ), @@ -15850,104 +19170,24 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * 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. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; - } - - export class Resource$Projects$Locations$Collections$Engines { - context: APIRequestContext; - controls: Resource$Projects$Locations$Collections$Engines$Controls; - conversations: Resource$Projects$Locations$Collections$Engines$Conversations; - operations: Resource$Projects$Locations$Collections$Engines$Operations; - servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; - sessions: Resource$Projects$Locations$Collections$Engines$Sessions; - constructor(context: APIRequestContext) { - this.context = context; - this.controls = - new Resource$Projects$Locations$Collections$Engines$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Collections$Engines$Conversations( - this.context - ); - this.operations = - new Resource$Projects$Locations$Collections$Engines$Operations( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Collections$Engines$Servingconfigs( - this.context - ); - this.sessions = - new Resource$Projects$Locations$Collections$Engines$Sessions( - this.context - ); - } /** - * Creates a Engine. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15955,57 +19195,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; options = {}; } @@ -16019,7 +19259,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/engines').replace( + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -16034,17 +19274,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Deletes a Engine. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16052,57 +19294,53 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + callback: BodyResponseCallback ): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; options = {}; } @@ -16128,17 +19366,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Engine. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16146,57 +19384,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; options = {}; } @@ -16222,19 +19460,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all the Engines associated with the project. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16242,57 +19480,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; options = {}; } @@ -16306,7 +19544,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/engines').replace( + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( /([^:]\/)\/+/g, '$1' ), @@ -16321,19 +19559,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates an Engine + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16341,57 +19579,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; options = {}; } @@ -16417,77 +19655,162 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse + extends StandardParameters { /** - * Pauses the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + extends StandardParameters { + /** + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + extends StandardParameters { + /** + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + */ + name?: string; + /** + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + } + + export class Resource$Projects$Locations$Collections$Engines$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - pause( - params?: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - pause( - params: Params$Resource$Projects$Locations$Collections$Engines$Pause, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + callback: BodyResponseCallback ): void; - pause( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - pause( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Pause - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Pause; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; options = {}; } @@ -16501,11 +19824,8 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:pause').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options @@ -16516,77 +19836,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Resumes the training of an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - resume( - params?: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options?: MethodOptions - ): GaxiosPromise; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - resume( - params: Params$Resource$Projects$Locations$Collections$Engines$Resume, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + callback: BodyResponseCallback ): void; - resume( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - resume( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Resume - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Resume; + {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; options = {}; } @@ -16600,11 +19918,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:resume').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -16615,77 +19933,111 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + extends StandardParameters { /** - * Tunes an existing engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - tune( - params?: Params$Resource$Projects$Locations$Collections$Engines$Tune, + answer( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - tune( - params: Params$Resource$Projects$Locations$Collections$Engines$Tune, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - tune( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - tune( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Tune - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Tune; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; options = {}; } @@ -16699,7 +20051,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:tune').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), @@ -16709,189 +20061,82 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Create - extends StandardParameters { - /** - * Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - engineId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Delete - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Get - extends StandardParameters { - /** - * Required. Full resource name of Engine, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$List - extends StandardParameters { - /** - * Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH - */ - filter?: string; - /** - * Optional. Not supported. - */ - pageSize?: number; - /** - * Optional. Not supported. - */ - pageToken?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Patch - extends StandardParameters { - /** - * Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` engine should be 1-63 characters, and valid characters are /a-z0-9x/. Otherwise, an INVALID_ARGUMENT error is returned. - */ - name?: string; - /** - * Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEngine; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Pause - extends StandardParameters { - /** - * Required. The name of the engine to pause. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPauseEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Resume - extends StandardParameters { - /** - * Required. The name of the engine to resume. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaResumeEngineRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Tune - extends StandardParameters { - /** - * Required. The resource name of the engine to tune. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}` - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTuneEngineRequest; - } - - export class Resource$Projects$Locations$Collections$Engines$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; options = {}; } @@ -16905,88 +20150,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + list( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; options = {}; } @@ -17000,87 +20246,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Control. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + patch( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; options = {}; } @@ -17095,7 +20346,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -17106,77 +20357,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Controls by their parent DataStore. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$List, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + recommend( + callback: BodyResponseCallback ): void; - list( + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; options = {}; } @@ -17190,92 +20441,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - patch( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; options = {}; } @@ -17289,203 +20540,121 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Create + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer extends StandardParameters { /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */ - parent?: string; + servingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get extends StandardParameters { /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List extends StandardParameters { /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Controls$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` */ name?: string; /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; } - - export class Resource$Projects$Locations$Collections$Engines$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + extends StandardParameters { /** - * Converses a conversation. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */ - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options: StreamMethodOptions - ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - converse( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse, - callback: BodyResponseCallback - ): void; - converse( - callback: BodyResponseCallback - ): void; - converse( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; - let options = (optionsOrCallback || {}) as MethodOptions; + servingConfig?: string; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}:converse').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + export class Resource$Projects$Locations$Collections$Engines$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( + this.context ); - } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17493,57 +20662,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; options = {}; } @@ -17557,7 +20726,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -17572,19 +20741,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17592,31 +20761,31 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -17632,13 +20801,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; options = {}; } @@ -17674,7 +20843,7 @@ export namespace discoveryengine_v1beta { } /** - * Gets a Conversation. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17682,57 +20851,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; options = {}; } @@ -17758,19 +20927,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Conversations by their parent DataStore. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17778,57 +20947,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$List; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; options = {}; } @@ -17842,7 +21011,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -17857,19 +21026,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17877,57 +21046,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; options = {}; } @@ -17953,31 +21122,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Create + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create extends StandardParameters { /** * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` @@ -17987,30 +21144,30 @@ export namespace discoveryengine_v1beta { /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Delete + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete extends StandardParameters { /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Get + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get extends StandardParameters { /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$List + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List extends StandardParameters { /** * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ filter?: string; /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */ orderBy?: string; /** @@ -18018,7 +21175,7 @@ export namespace discoveryengine_v1beta { */ pageSize?: number; /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** @@ -18026,24 +21183,135 @@ export namespace discoveryengine_v1beta { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Conversations$Patch + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` */ name?: string; /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */ updateMask?: string; /** - * Request body metadata + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + + export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Answer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get + extends StandardParameters { + /** + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; + name?: string; } - export class Resource$Projects$Locations$Collections$Engines$Operations { + export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; @@ -18058,27 +21326,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params?: Params$Resource$Projects$Locations$Collections$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$Get, + params: Params$Resource$Projects$Locations$Collections$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -18086,7 +21354,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + | Params$Resource$Projects$Locations$Collections$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18102,13 +21370,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$Get; + {} as Params$Resource$Projects$Locations$Collections$Operations$Get; options = {}; } @@ -18152,27 +21420,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params?: Params$Resource$Projects$Locations$Collections$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Engines$Operations$List, + params: Params$Resource$Projects$Locations$Collections$Operations$List, callback: BodyResponseCallback ): void; list( @@ -18180,7 +21448,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Operations$List + | Params$Resource$Projects$Locations$Collections$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18196,13 +21464,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {}) as Params$Resource$Projects$Locations$Collections$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Operations$List; + {} as Params$Resource$Projects$Locations$Collections$Operations$List; options = {}; } @@ -18243,14 +21511,14 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$Get + export interface Params$Resource$Projects$Locations$Collections$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Operations$List + export interface Params$Resource$Projects$Locations$Collections$Operations$List extends StandardParameters { /** * The standard list filter. @@ -18270,72 +21538,121 @@ export namespace discoveryengine_v1beta { pageToken?: string; } - export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + export class Resource$Projects$Locations$Datastores { context: APIRequestContext; + branches: Resource$Projects$Locations$Datastores$Branches; + completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; + controls: Resource$Projects$Locations$Datastores$Controls; + conversations: Resource$Projects$Locations$Datastores$Conversations; + models: Resource$Projects$Locations$Datastores$Models; + operations: Resource$Projects$Locations$Datastores$Operations; + schemas: Resource$Projects$Locations$Datastores$Schemas; + servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; + sessions: Resource$Projects$Locations$Datastores$Sessions; + siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; + suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; + userEvents: Resource$Projects$Locations$Datastores$Userevents; constructor(context: APIRequestContext) { this.context = context; + this.branches = new Resource$Projects$Locations$Datastores$Branches( + this.context + ); + this.completionSuggestions = + new Resource$Projects$Locations$Datastores$Completionsuggestions( + this.context + ); + this.controls = new Resource$Projects$Locations$Datastores$Controls( + this.context + ); + this.conversations = + new Resource$Projects$Locations$Datastores$Conversations(this.context); + this.models = new Resource$Projects$Locations$Datastores$Models( + this.context + ); + this.operations = new Resource$Projects$Locations$Datastores$Operations( + this.context + ); + this.schemas = new Resource$Projects$Locations$Datastores$Schemas( + this.context + ); + this.servingConfigs = + new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); + this.sessions = new Resource$Projects$Locations$Datastores$Sessions( + this.context + ); + this.siteSearchEngine = + new Resource$Projects$Locations$Datastores$Sitesearchengine( + this.context + ); + this.suggestionDenyListEntries = + new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( + this.context + ); + this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( + this.context + ); } /** - * Answer query method. + * Completes the specified user input with keyword suggestions. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + completeQuery( + params?: Params$Resource$Projects$Locations$Datastores$Completequery, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + ): GaxiosPromise; + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer, - callback: BodyResponseCallback + completeQuery( + params: Params$Resource$Projects$Locations$Datastores$Completequery, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + completeQuery( + callback: BodyResponseCallback ): void; - answer( + completeQuery( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Completequery + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Completequery; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Completequery; options = {}; } @@ -18349,92 +21666,187 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( + url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['dataStore'], + pathParams: ['dataStore'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datastores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datastores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Datastores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Delete, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - get( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get; + params = {} as Params$Resource$Projects$Locations$Datastores$Delete; options = {}; } @@ -18449,7 +21861,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -18460,77 +21872,74 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Gets a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List; + params = {} as Params$Resource$Projects$Locations$Datastores$Get; options = {}; } @@ -18544,92 +21953,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Gets the SiteSearchEngine. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getSiteSearchEngine( + params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + ): GaxiosPromise; + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch, - callback: BodyResponseCallback + getSiteSearchEngine( + params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + getSiteSearchEngine( + callback: BodyResponseCallback ): void; - patch( + getSiteSearchEngine( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; options = {}; } @@ -18644,7 +22050,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -18655,77 +22061,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Makes a recommendation, which requires a contextual user event. + * Lists all the DataStores associated with the project. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + list( + params?: Params$Resource$Projects$Locations$Datastores$List, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + list( + params: Params$Resource$Projects$Locations$Datastores$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$List, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - recommend( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + params = {} as Params$Resource$Projects$Locations$Datastores$List; options = {}; } @@ -18739,92 +22144,91 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Performs a search. + * Updates a DataStore * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Patch, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Patch, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - search( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + params = {} as Params$Resource$Projects$Locations$Datastores$Patch; options = {}; } @@ -18838,121 +22242,269 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Datastores$Completequery extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. */ - servingConfig?: string; + dataStore?: string; + /** + * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. + */ + includeTailSuggestions?: boolean; + /** + * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. + */ + query?: string; + /** + * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. + */ + queryModel?: string; + /** + * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + userPseudoId?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Create + extends StandardParameters { + /** + * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. + */ + createAdvancedSiteSearch?: boolean; + /** + * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. + */ + dataStoreId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. + */ + parent?: string; + /** + * A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. + */ + skipDefaultSchemaCreation?: boolean; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Get + export interface Params$Resource$Projects$Locations$Datastores$Delete extends StandardParameters { /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Datastores$Get extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine + extends StandardParameters { + /** + * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$List + extends StandardParameters { + /** + * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` + */ + filter?: string; + /** + * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. */ pageSize?: number; /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. */ pageToken?: string; /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Patch + export interface Params$Resource$Projects$Locations$Datastores$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; + + export class Resource$Projects$Locations$Datastores$Branches { + context: APIRequestContext; + documents: Resource$Projects$Locations$Datastores$Branches$Documents; + operations: Resource$Projects$Locations$Datastores$Branches$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.documents = + new Resource$Projects$Locations$Datastores$Branches$Documents( + this.context + ); + this.operations = + new Resource$Projects$Locations$Datastores$Branches$Operations( + this.context + ); + } /** - * Request body metadata + * Gets index freshness metadata for Documents. Supported for website search only. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options?: MethodOptions + ): GaxiosPromise; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + params: Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata, + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + callback: BodyResponseCallback + ): void; + batchGetDocumentsMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+parent}/batchGetDocumentsMetadata' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + + export interface Params$Resource$Projects$Locations$Datastores$Branches$Batchgetdocumentsmetadata extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * The exact URIs to match by. */ - servingConfig?: string; - + 'matcher.urisMatcher.uris'?: string[]; /** - * Request body metadata + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + parent?: string; } - export class Resource$Projects$Locations$Collections$Engines$Sessions { + export class Resource$Projects$Locations$Datastores$Branches$Documents { context: APIRequestContext; - answers: Resource$Projects$Locations$Collections$Engines$Sessions$Answers; constructor(context: APIRequestContext) { this.context = context; - this.answers = - new Resource$Projects$Locations$Collections$Engines$Sessions$Answers( - this.context - ); } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Creates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18960,57 +22512,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; options = {}; } @@ -19024,7 +22576,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+parent}/documents').replace( /([^:]\/)\/+/g, '$1' ), @@ -19039,19 +22591,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Deletes a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19059,31 +22611,31 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19099,13 +22651,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; options = {}; } @@ -19141,7 +22693,7 @@ export namespace discoveryengine_v1beta { } /** - * Gets a Session. + * Gets a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -19149,57 +22701,250 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a list of Documents. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; options = {}; } @@ -19213,89 +22958,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/documents').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all Sessions by their parent DataStore. + * Updates a Document. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - list( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; options = {}; } @@ -19309,92 +23057,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - patch( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; options = {}; } @@ -19408,162 +23153,183 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Create + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create extends StandardParameters { /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + documentId?: string; + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Delete + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete extends StandardParameters { /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Get + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get extends StandardParameters { /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. */ name?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$List + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import extends StandardParameters { /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. */ - filter?: string; + parent?: string; + /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + * Request body metadata */ - orderBy?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List + extends StandardParameters { /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */ pageSize?: number; /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */ pageToken?: string; /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + * 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. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Patch + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch extends StandardParameters { /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + * If set to `true` and the Document is not found, a new Document is be created. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string; /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge + extends StandardParameters { + /** + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; } - export class Resource$Projects$Locations$Collections$Engines$Sessions$Answers { + export class Resource$Projects$Locations$Datastores$Branches$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Gets a Answer. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + cancel( + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get, - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + cancel( + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + callback: BodyResponseCallback ): void; - get( + cancel(callback: BodyResponseCallback): void; + cancel( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; options = {}; } @@ -19577,8 +23343,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -19589,31 +23358,14 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Collections$Engines$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Collections$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** * 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. @@ -19624,27 +23376,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Collections$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Collections$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -19652,7 +23404,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19668,13 +23420,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; options = {}; } @@ -19718,27 +23470,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Collections$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Collections$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, callback: BodyResponseCallback ): void; list( @@ -19746,7 +23498,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Collections$Operations$List + | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -19762,13 +23514,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Collections$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Collections$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; options = {}; } @@ -19809,225 +23561,89 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Collections$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel extends StandardParameters { /** - * The name of the operation resource. + * The name of the operation resource to be cancelled. */ name?: string; - } - export interface Params$Resource$Projects$Locations$Collections$Operations$List - extends StandardParameters { + /** - * The standard list filter. + * Request body metadata */ - filter?: string; + requestBody?: Schema$GoogleLongrunningCancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + extends StandardParameters { /** - * The name of the operation's parent resource. + * The name of the operation resource. */ name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; } - - export class Resource$Projects$Locations$Datastores { - context: APIRequestContext; - branches: Resource$Projects$Locations$Datastores$Branches; - completionSuggestions: Resource$Projects$Locations$Datastores$Completionsuggestions; - controls: Resource$Projects$Locations$Datastores$Controls; - conversations: Resource$Projects$Locations$Datastores$Conversations; - models: Resource$Projects$Locations$Datastores$Models; - operations: Resource$Projects$Locations$Datastores$Operations; - schemas: Resource$Projects$Locations$Datastores$Schemas; - servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; - sessions: Resource$Projects$Locations$Datastores$Sessions; - siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; - suggestionDenyListEntries: Resource$Projects$Locations$Datastores$Suggestiondenylistentries; - userEvents: Resource$Projects$Locations$Datastores$Userevents; - constructor(context: APIRequestContext) { - this.context = context; - this.branches = new Resource$Projects$Locations$Datastores$Branches( - this.context - ); - this.completionSuggestions = - new Resource$Projects$Locations$Datastores$Completionsuggestions( - this.context - ); - this.controls = new Resource$Projects$Locations$Datastores$Controls( - this.context - ); - this.conversations = - new Resource$Projects$Locations$Datastores$Conversations(this.context); - this.models = new Resource$Projects$Locations$Datastores$Models( - this.context - ); - this.operations = new Resource$Projects$Locations$Datastores$Operations( - this.context - ); - this.schemas = new Resource$Projects$Locations$Datastores$Schemas( - this.context - ); - this.servingConfigs = - new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); - this.sessions = new Resource$Projects$Locations$Datastores$Sessions( - this.context - ); - this.siteSearchEngine = - new Resource$Projects$Locations$Datastores$Sitesearchengine( - this.context - ); - this.suggestionDenyListEntries = - new Resource$Projects$Locations$Datastores$Suggestiondenylistentries( - this.context - ); - this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( - this.context - ); - } - + export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + extends StandardParameters { /** - * Completes the specified user input with keyword suggestions. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The standard list filter. */ - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - options: StreamMethodOptions - ): GaxiosPromise; - completeQuery( - params?: Params$Resource$Projects$Locations$Datastores$Completequery, - options?: MethodOptions - ): GaxiosPromise; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - completeQuery( - params: Params$Resource$Projects$Locations$Datastores$Completequery, - callback: BodyResponseCallback - ): void; - completeQuery( - callback: BodyResponseCallback - ): void; - completeQuery( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completequery - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completequery; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Completequery; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+dataStore}:completeQuery').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['dataStore'], - pathParams: ['dataStore'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores$Completionsuggestions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately. + * Imports CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Create, + import( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, callback: BodyResponseCallback ): void; - create( + import( callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Create + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20043,12 +23659,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Create; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; options = {}; } @@ -20062,10 +23679,9 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, @@ -20087,43 +23703,43 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a DataStore. + * Permanently deletes all CompletionSuggestions for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, callback: BodyResponseCallback ): void; - delete( + purge( callback: BodyResponseCallback ): void; - delete( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Delete + | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -20139,12 +23755,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Delete; + params = + {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; options = {}; } @@ -20158,15 +23775,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -20178,66 +23797,99 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + extends StandardParameters { + /** + * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` + */ + parent?: string; /** - * Gets a DataStore. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + extends StandardParameters { + /** + * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; + } + + export class Resource$Projects$Locations$Datastores$Controls { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Get; + params = + {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; options = {}; } @@ -20251,89 +23903,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets the SiteSearchEngine. + * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions ): GaxiosPromise; - getSiteSearchEngine( - params?: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options?: MethodOptions - ): GaxiosPromise; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getSiteSearchEngine( - params: Params$Resource$Projects$Locations$Datastores$Getsitesearchengine, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + callback: BodyResponseCallback ): void; - getSiteSearchEngine( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Getsitesearchengine; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; options = {}; } @@ -20348,7 +23999,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', apiVersion: '', }, options @@ -20359,76 +24010,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all the DataStores associated with the project. + * Gets a Control. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$List; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$List; + params = + {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; options = {}; } @@ -20442,91 +24092,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/dataStores').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a DataStore + * Lists all Controls by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Patch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Controls$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Controls$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Datastores$Patch; + params = + {} as Params$Resource$Projects$Locations$Datastores$Controls$List; options = {}; } @@ -20540,213 +24188,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/controls').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completequery - extends StandardParameters { - /** - * Required. The parent data store resource name for which the completion is performed, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store`. - */ - dataStore?: string; - /** - * Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. - */ - includeTailSuggestions?: boolean; - /** - * Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. - */ - query?: string; - /** - * Specifies the autocomplete data model. This overrides any model specified in the Configuration \> Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. - */ - queryModel?: string; - /** - * 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 logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. - */ - userPseudoId?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Create - extends StandardParameters { - /** - * A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored. - */ - createAdvancedSiteSearch?: boolean; - /** - * Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. - */ - dataStoreId?: string; - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - export interface Params$Resource$Projects$Locations$Datastores$Delete - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Get - extends StandardParameters { - /** - * Required. Full resource name of DataStore, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Getsitesearchengine - extends StandardParameters { - /** - * Required. Resource name of SiteSearchEngine, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$List - extends StandardParameters { - /** - * Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` - */ - filter?: string; - /** - * Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. - */ - pageSize?: number; - /** - * A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned. - */ - pageToken?: string; - /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection_id\}`. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Patch - extends StandardParameters { - /** - * Immutable. The full resource name of the data store. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - /** - * Indicates which fields in the provided DataStore to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDataStore; - } - - export class Resource$Projects$Locations$Datastores$Branches { - context: APIRequestContext; - documents: Resource$Projects$Locations$Datastores$Branches$Documents; - operations: Resource$Projects$Locations$Datastores$Branches$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.documents = - new Resource$Projects$Locations$Datastores$Branches$Documents( - this.context + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - this.operations = - new Resource$Projects$Locations$Datastores$Branches$Operations( - this.context + } else { + return createAPIRequest( + parameters ); - } - } - - export class Resource$Projects$Locations$Datastores$Branches$Documents { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + } } /** - * Creates a Document. + * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - create( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Controls$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create; + {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; options = {}; } @@ -20760,88 +24287,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Create + extends StandardParameters { /** - * Deletes a Document. + * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. + */ + controlId?: string; + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete + extends StandardParameters { + /** + * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Get + extends StandardParameters { + /** + * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$List + extends StandardParameters { + /** + * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. + */ + filter?: string; + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` + */ + name?: string; + /** + * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; + } + + export class Resource$Projects$Locations$Datastores$Conversations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Converses a conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + converse( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, + ): GaxiosPromise; + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete, - callback: BodyResponseCallback + converse( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + converse( + callback: BodyResponseCallback + ): void; + converse( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Converse + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; options = {}; } @@ -20855,8 +24456,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+name}:converse').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -20867,75 +24471,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Document. + * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; options = {}; } @@ -20949,89 +24555,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. + * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + callback: BodyResponseCallback ): void; - import( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; options = {}; } @@ -21045,90 +24650,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a list of Documents. + * Gets a Conversation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$List; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; options = {}; } @@ -21142,92 +24744,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Document. + * Lists all Conversations by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; options = {}; } @@ -21241,89 +24840,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. + * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Conversations$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; options = {}; } @@ -21337,183 +24939,280 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/documents:purge').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Create + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse extends StandardParameters { /** - * Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */ - documentId?: string; + name?: string; + /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Delete + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Get + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get extends StandardParameters { /** - * Required. Full resource name of Document, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document\}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. + * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Import + export interface Params$Resource$Projects$Locations$Datastores$Conversations$List extends StandardParameters { /** - * Required. The parent branch resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. Requires create/update permission. + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */ - parent?: string; - + filter?: string; /** - * Request body metadata + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportDocumentsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */ pageSize?: number; /** - * A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */ pageToken?: string; /** - * 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. + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` */ parent?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Patch + export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch extends StandardParameters { /** - * If set to `true` and the Document is not found, a new Document is be created. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the document. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}/documents/{document_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. */ name?: string; /** - * Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. + * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDocument; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Documents$Purge - extends StandardParameters { - /** - * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/branches/{branch\}`. - */ - parent?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeDocumentsRequest; + export class Resource$Projects$Locations$Datastores$Models { + context: APIRequestContext; + operations: Resource$Projects$Locations$Datastores$Models$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Datastores$Models$Operations( + this.context + ); + } } - export class Resource$Projects$Locations$Datastores$Branches$Operations { + export class Resource$Projects$Locations$Datastores$Models$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + get( + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Models$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; options = {}; } @@ -21527,11 +25226,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:cancel').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -21542,14 +25241,50 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Datastores$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * 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. @@ -21560,27 +25295,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Operations$Get, callback: BodyResponseCallback ): void; get( @@ -21588,7 +25323,7 @@ export namespace discoveryengine_v1beta { ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + | Params$Resource$Projects$Locations$Datastores$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21604,13 +25339,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; options = {}; } @@ -21654,27 +25389,27 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Operations$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Branches$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Operations$List, callback: BodyResponseCallback ): void; list( @@ -21682,7 +25417,7 @@ export namespace discoveryengine_v1beta { ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + | Params$Resource$Projects$Locations$Datastores$Operations$List | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21698,13 +25433,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Branches$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Operations$List; options = {}; } @@ -21745,26 +25480,14 @@ export namespace discoveryengine_v1beta { } } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Cancel - extends StandardParameters { - /** - * The name of the operation resource to be cancelled. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleLongrunningCancelOperationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$Get + export interface Params$Resource$Projects$Locations$Datastores$Operations$Get extends StandardParameters { /** * The name of the operation resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Datastores$Branches$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Operations$List extends StandardParameters { /** * The standard list filter. @@ -21784,50 +25507,50 @@ export namespace discoveryengine_v1beta { pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Completionsuggestions { + export class Resource$Projects$Locations$Datastores$Schemas { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Imports CompletionSuggestions for a DataStore. + * Creates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options?: MethodOptions ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import, + create( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, callback: BodyResponseCallback ): void; - import( + create( callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import + | Params$Resource$Projects$Locations$Datastores$Schemas$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21843,13 +25566,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; options = {}; } @@ -21863,9 +25586,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:import' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, @@ -21887,43 +25611,43 @@ export namespace discoveryengine_v1beta { } /** - * Permanently deletes all CompletionSuggestions for a DataStore. + * Deletes a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options?: MethodOptions ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge, + delete( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, callback: BodyResponseCallback ): void; - purge( + delete( callback: BodyResponseCallback ): void; - purge( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge + | Params$Resource$Projects$Locations$Datastores$Schemas$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -21939,13 +25663,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; options = {}; } @@ -21959,17 +25683,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/completionSuggestions:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -21981,99 +25703,67 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Import - extends StandardParameters { - /** - * Required. The parent data store resource name for which to import customer autocomplete suggestions. Follows pattern `projects/x/locations/x/collections/x/dataStores/x` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Completionsuggestions$Purge - extends StandardParameters { - /** - * Required. The parent data store resource name for which to purge completion suggestions. Follows pattern projects/x/locations/x/collections/x/dataStores/x. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeCompletionSuggestionsRequest; - } - - export class Resource$Projects$Locations$Datastores$Controls { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. + * Gets a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Create, + get( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Controls$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - create( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Create; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; options = {}; } @@ -22087,88 +25777,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. + * Gets a list of Schemas. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + list( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Controls$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; options = {}; } @@ -22182,87 +25873,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/schemas').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Control. + * Updates a Schema. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Controls$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Get; + {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; options = {}; } @@ -22277,7 +25973,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -22288,77 +25984,144 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create + extends StandardParameters { + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. + */ + schemaId?: string; /** - * Lists all Controls by their parent DataStore. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get + extends StandardParameters { + /** + * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$List + extends StandardParameters { + /** + * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch + extends StandardParameters { + /** + * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. + */ + allowMissing?: boolean; + /** + * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; + } + + export class Resource$Projects$Locations$Datastores$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Answer query method. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Controls$List, + answer( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + ): GaxiosPromise; + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Controls$List, - callback: BodyResponseCallback + answer( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + answer( + callback: BodyResponseCallback ): void; - list( + answer( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$List; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$List; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; options = {}; } @@ -22372,92 +26135,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/controls').replace( + url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. + * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Controls$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Controls$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Controls$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; options = {}; } @@ -22472,7 +26235,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -22483,150 +26246,77 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Controls$Create - extends StandardParameters { - /** - * Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. - */ - controlId?: string; - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Delete - extends StandardParameters { - /** - * Required. The resource name of the Control to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Get - extends StandardParameters { - /** - * Required. The resource name of the Control to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}/controls/{control_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$List - extends StandardParameters { - /** - * Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. - */ - filter?: string; - /** - * Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/dataStores/{data_store_id\}` or `projects/{project_number\}/locations/{location_id\}/collections/{collection_id\}/engines/{engine_id\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Controls$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/x/locations/global/dataStore/x/controls/x` - */ - name?: string; - /** - * Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaControl; - } - - export class Resource$Projects$Locations$Datastores$Conversations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Converses a conversation. + * Lists all ServingConfigs linked to this dataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions ): GaxiosPromise; - converse( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options?: MethodOptions - ): GaxiosPromise; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - converse( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Converse, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + callback: BodyResponseCallback ): void; - converse( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - converse( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Converse - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Converse; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; options = {}; } @@ -22640,92 +26330,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}:converse').replace( + url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. + * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Create, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + callback: BodyResponseCallback ): void; - create( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Create; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; options = {}; } @@ -22739,88 +26429,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. + * Makes a recommendation, which requires a contextual user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + recommend( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Delete, - callback: BodyResponseCallback + recommend( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + recommend( + callback: BodyResponseCallback + ): void; + recommend( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; options = {}; } @@ -22834,87 +26525,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets a Conversation. + * Performs a search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + search( + params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Get, - callback: BodyResponseCallback + search( + params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + search( + callback: BodyResponseCallback ): void; - get( + search( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; options = {}; } @@ -22923,94 +26619,184 @@ export namespace discoveryengine_v1beta { options = {}; } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get + extends StandardParameters { + /** + * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + extends StandardParameters { + /** + * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` + */ + name?: string; + /** + * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + + export class Resource$Projects$Locations$Datastores$Sessions { + context: APIRequestContext; + answers: Resource$Projects$Locations$Datastores$Sessions$Answers; + constructor(context: APIRequestContext) { + this.context = context; + this.answers = + new Resource$Projects$Locations$Datastores$Sessions$Answers( + this.context ); - } } /** - * Lists all Conversations by their parent DataStore. + * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$List, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Conversations$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; options = {}; } @@ -23024,11 +26810,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/conversations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -23039,77 +26825,73 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. + * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Conversations$Patch, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + callback: BodyResponseCallback ): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Conversations$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Conversations$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; options = {}; } @@ -23124,7 +26906,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -23135,116 +26917,17 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Converse - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}`. Use `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConverseConversationRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Delete - extends StandardParameters { - /** - * Required. The resource name of the Conversation to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Get - extends StandardParameters { - /** - * Required. The resource name of the Conversation to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/conversations/{conversation_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Conversations$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/dataStore/x/conversations/x` or `projects/{project\}/locations/global/collections/{collection\}/engines/x/conversations/x`. - */ - name?: string; - /** - * Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaConversation; - } - - export class Resource$Projects$Locations$Datastores$Models { - context: APIRequestContext; - operations: Resource$Projects$Locations$Datastores$Models$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Datastores$Models$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Datastores$Models$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Gets a Session. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23252,57 +26935,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; options = {}; } @@ -23328,17 +27011,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists all Sessions by their parent DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -23346,57 +27031,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Models$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Models$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Models$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; options = {}; } @@ -23410,7 +27095,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/sessions').replace( /([^:]\/)\/+/g, '$1' ), @@ -23420,210 +27105,251 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Models$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Datastores$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Operations$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - get( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; options = {}; } - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create + extends StandardParameters { + /** + * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get + extends StandardParameters { + /** + * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$List + extends StandardParameters { + /** + * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" + */ + orderBy?: string; + /** + * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. + */ + pageToken?: string; + /** + * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch + extends StandardParameters { + /** + * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` + */ + name?: string; + /** + * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; + } - const rootUrl = - options.rootUrl || 'https://discoveryengine.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Projects$Locations$Datastores$Sessions$Answers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a Answer. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Operations$List, + get( + params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Operations$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Operations$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Operations$List; + {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; options = {}; } @@ -23637,10 +27363,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, @@ -23652,89 +27375,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Operations$List + export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get extends StandardParameters { /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. + * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` */ name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; } - export class Resource$Projects$Locations$Datastores$Schemas { + export class Resource$Projects$Locations$Datastores$Sitesearchengine { context: APIRequestContext; + targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; constructor(context: APIRequestContext) { this.context = context; + this.targetSites = + new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( + this.context + ); } /** - * Creates a Schema. + * Downgrade from advanced site search to basic site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Create, + disableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, callback: BodyResponseCallback ): void; - create( + disableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - create( + disableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Create + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23750,13 +27459,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Create; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; options = {}; } @@ -23770,18 +27479,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -23795,43 +27503,43 @@ export namespace discoveryengine_v1beta { } /** - * Deletes a Schema. + * Upgrade from basic site search to advanced site search. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Delete, + enableAdvancedSiteSearch( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, callback: BodyResponseCallback ): void; - delete( + enableAdvancedSiteSearch( callback: BodyResponseCallback ): void; - delete( + enableAdvancedSiteSearch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Delete + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -23847,13 +27555,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; options = {}; } @@ -23867,15 +27575,17 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: ( + rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { @@ -23889,65 +27599,65 @@ export namespace discoveryengine_v1beta { } /** - * Gets a Schema. + * Request on-demand recrawl for a list of URIs. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Get, - callback: BodyResponseCallback + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + recrawlUris( + callback: BodyResponseCallback ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Get - | BodyResponseCallback + recrawlUris( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; options = {}; } @@ -23961,89 +27671,134 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; /** - * Gets a list of Schemas. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + } + + export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates TargetSite in a batch. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$List, + batchCreate( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Schemas$List, - callback: BodyResponseCallback + batchCreate( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + batchCreate( + callback: BodyResponseCallback ): void; - list( + batchCreate( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; options = {}; } @@ -24057,11 +27812,10 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/schemas').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options @@ -24072,55 +27826,53 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Schema. + * Creates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Schemas$Patch, + create( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, callback: BodyResponseCallback ): void; - patch( + create( callback: BodyResponseCallback ): void; - patch( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Schemas$Patch + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24136,13 +27888,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Schemas$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; options = {}; } @@ -24156,15 +27908,18 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -24176,136 +27931,67 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Create - extends StandardParameters { - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. - */ - schemaId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Delete - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Get - extends StandardParameters { - /** - * Required. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$List - extends StandardParameters { - /** - * The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent data store resource name, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Schemas$Patch - extends StandardParameters { - /** - * If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. - */ - allowMissing?: boolean; - /** - * Immutable. The full resource name of the schema, in the format of `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/schemas/{schema\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSchema; - } - - export class Resource$Projects$Locations$Datastores$Servingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Answer query method. + * Deletes a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions ): GaxiosPromise; - answer( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + delete( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options?: MethodOptions - ): GaxiosPromise; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - answer( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + callback: BodyResponseCallback ): void; - answer( - callback: BodyResponseCallback + delete( + callback: BodyResponseCallback ): void; - answer( + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; options = {}; } @@ -24319,34 +28005,29 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:answer').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. + * Gets a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24354,57 +28035,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; options = {}; } @@ -24430,19 +28111,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all ServingConfigs linked to this dataStore. + * Gets a list of TargetSites. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24450,57 +28131,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$List; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; options = {}; } @@ -24514,7 +28195,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/servingConfigs').replace( + url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( /([^:]\/)\/+/g, '$1' ), @@ -24529,19 +28210,19 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a ServingConfig. Returns a NOT_FOUND error if the ServingConfig does not exist. + * Updates a TargetSite. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24549,57 +28230,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch; + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; options = {}; } @@ -24625,77 +28306,148 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + extends StandardParameters { + /** + * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create + extends StandardParameters { + /** + * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get + extends StandardParameters { + /** + * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List + extends StandardParameters { + /** + * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch + extends StandardParameters { + /** + * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; + } + + export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Makes a recommendation, which requires a contextual user event. + * Imports all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions ): GaxiosPromise; - recommend( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + import( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options?: MethodOptions - ): GaxiosPromise; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recommend( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + callback: BodyResponseCallback ): void; - recommend( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - recommend( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; options = {}; } @@ -24709,92 +28461,89 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Performs a search. + * Permanently deletes all SuggestionDenyListEntry for a DataStore. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions ): GaxiosPromise; - search( - params?: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options?: MethodOptions - ): GaxiosPromise; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - search( - params: Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + callback: BodyResponseCallback ): void; - search( - callback: BodyResponseCallback + purge( + callback: BodyResponseCallback ): void; - search( + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search; + {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; options = {}; } @@ -24808,179 +28557,214 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['servingConfig'], - pathParams: ['servingConfig'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Answer + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import extends StandardParameters { /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/x/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ - servingConfig?: string; + parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaAnswerQueryRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Get - extends StandardParameters { - /** - * Required. The resource name of the ServingConfig to get. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}/servingConfigs/{serving_config_id\}` - */ - name?: string; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$List + export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge extends StandardParameters { /** - * Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListServingConfigs` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. Full resource name of the parent resource. Format: `projects/{project_number\}/locations/{location\}/collections/{collection\}/engines/{engine\}` + * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. */ parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/{location\}/collections/{collection_id\}/engines/{engine_id\}/servingConfigs/{serving_config_id\}` - */ - name?: string; - /** - * Indicates which fields in the provided ServingConfig to update. The following are NOT supported: * ServingConfig.name If not set, all supported fields are updated. - */ - updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaServingConfig; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Recommend - extends StandardParameters { - /** - * Required. Full resource name of a ServingConfig: `projects/x/locations/global/collections/x/engines/x/servingConfigs/x`, or `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/x/locations/global/collections/x/engines/my-engine`, you can use `projects/x/locations/global/collections/x/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. - */ - servingConfig?: string; - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Servingconfigs$Search - extends StandardParameters { - /** - * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/engines/x/servingConfigs/default_serving_config`, or `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. - */ - servingConfig?: string; + export class Resource$Projects$Locations$Datastores$Userevents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Request body metadata + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; - } + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: StreamMethodOptions + ): GaxiosPromise; + collect( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options?: MethodOptions + ): GaxiosPromise; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + collect( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + callback: BodyResponseCallback + ): void; + collect(callback: BodyResponseCallback): void; + collect( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Userevents$Collect + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + options = {}; + } - export class Resource$Projects$Locations$Datastores$Sessions { - context: APIRequestContext; - answers: Resource$Projects$Locations$Datastores$Sessions$Answers; - constructor(context: APIRequestContext) { - this.context = context; - this.answers = - new Resource$Projects$Locations$Datastores$Sessions$Answers( - this.context + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. + * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + import( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Create, - callback: BodyResponseCallback + import( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + import( + callback: BodyResponseCallback ): void; - create( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Import + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Create; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; options = {}; } @@ -24994,7 +28778,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( /([^:]\/)\/+/g, '$1' ), @@ -25009,73 +28793,75 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. + * Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + purge( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, + ): GaxiosPromise; + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Delete, - callback: BodyResponseCallback + purge( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Purge, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + purge( + callback: BodyResponseCallback + ): void; + purge( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Purge + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Delete; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Purge; options = {}; } @@ -25089,87 +28875,90 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+parent}/userEvents:purge').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a Session. + * Writes a single user event. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + write( + params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + ): GaxiosPromise; + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Get, - callback: BodyResponseCallback + write( + params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + write( + callback: BodyResponseCallback ): void; - get( + write( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datastores$Userevents$Write + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Get; + {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; options = {}; } @@ -25183,89 +28972,162 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect + extends StandardParameters { + /** + * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. + */ + ets?: string; + /** + * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. + */ + parent?: string; + /** + * 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. + */ + uri?: string; + /** + * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. + */ + userEvent?: string; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import + extends StandardParameters { + /** + * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Purge + extends StandardParameters { + /** + * Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId\}/locations/global/collections/{$collectionId\}/dataStores/${dataStoreId\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest; + } + export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write + extends StandardParameters { + /** + * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. + */ + writeAsync?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; + } + + export class Resource$Projects$Locations$Evaluations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Evaluations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Evaluations$Operations( + this.context + ); + } /** - * Lists all Sessions by their parent DataStore. + * Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params?: Params$Resource$Projects$Locations$Evaluations$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sessions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Evaluations$Create, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - list( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$List; + {}) as Params$Resource$Projects$Locations$Evaluations$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$List; + params = {} as Params$Resource$Projects$Locations$Evaluations$Create; options = {}; } @@ -25279,11 +29141,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/sessions').replace( + url: (rootUrl + '/v1beta/{+parent}/evaluations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -25294,77 +29156,74 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. + * Gets a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Evaluations$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + {}) as Params$Resource$Projects$Locations$Evaluations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Patch; + params = {} as Params$Resource$Projects$Locations$Evaluations$Get; options = {}; } @@ -25379,7 +29238,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -25390,150 +29249,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Create - extends StandardParameters { - /** - * Required. Full resource name of parent data store. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Delete - extends StandardParameters { - /** - * Required. The resource name of the Session to delete. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Get - extends StandardParameters { - /** - * Required. The resource name of the Session to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}/sessions/{session_id\}` - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$List - extends StandardParameters { - /** - * A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" - */ - filter?: string; - /** - * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" - */ - orderBy?: string; - /** - * Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. - */ - pageToken?: string; - /** - * Required. The data store resource name. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/dataStores/{data_store_id\}` - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Patch - extends StandardParameters { - /** - * Immutable. Fully qualified name `projects/{project\}/locations/global/collections/{collection\}/engines/{engine\}/sessions/x` - */ - name?: string; - /** - * Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSession; - } - - export class Resource$Projects$Locations$Datastores$Sessions$Answers { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Gets a Answer. + * Gets a list of Evaluations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + list( + params?: Params$Resource$Projects$Locations$Evaluations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, + list( + params: Params$Resource$Projects$Locations$Evaluations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Evaluations$List, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - get( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + {}) as Params$Resource$Projects$Locations$Evaluations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get; + params = {} as Params$Resource$Projects$Locations$Evaluations$List; options = {}; } @@ -25547,109 +29332,92 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta/{+parent}/evaluations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sessions$Answers$Get - extends StandardParameters { - /** - * Required. The resource name of the Answer to get. Format: `projects/{project_number\}/locations/{location_id\}/collections/{collection\}/engines/{engine_id\}/sessions/{session_id\}/answers/{answer_id\}` - */ - name?: string; - } - - export class Resource$Projects$Locations$Datastores$Sitesearchengine { - context: APIRequestContext; - targetSites: Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites; - constructor(context: APIRequestContext) { - this.context = context; - this.targetSites = - new Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites( - this.context + return createAPIRequest( + parameters ); + } } /** - * Downgrade from advanced site search to basic site search. + * Gets a list of results for a given a Evaluation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions ): GaxiosPromise; - disableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + listResults( + params?: Params$Resource$Projects$Locations$Evaluations$Listresults, options?: MethodOptions - ): GaxiosPromise; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + ): GaxiosPromise; + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch, - callback: BodyResponseCallback + listResults( + params: Params$Resource$Projects$Locations$Evaluations$Listresults, + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( - callback: BodyResponseCallback + listResults( + callback: BodyResponseCallback ): void; - disableAdvancedSiteSearch( + listResults( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Evaluations$Listresults + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$Listresults; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Evaluations$Listresults; options = {}; } @@ -25663,67 +29431,127 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:disableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+evaluation}:listResults').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['evaluation'], + pathParams: ['evaluation'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Evaluations$Create + extends StandardParameters { /** - * Upgrade from basic site search to advanced site search. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEvaluation; + } + export interface Params$Resource$Projects$Locations$Evaluations$Get + extends StandardParameters { + /** + * Required. Full resource name of Evaluation, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$List + extends StandardParameters { + /** + * Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Evaluations$Listresults + extends StandardParameters { + /** + * Required. The evaluation resource name, such as `projects/{project\}/locations/{location\}/evaluations/{evaluation\}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. + */ + evaluation?: string; + /** + * Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Evaluations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params?: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch, + get( + params: Params$Resource$Projects$Locations$Evaluations$Operations$Get, callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + get( callback: BodyResponseCallback ): void; - enableAdvancedSiteSearch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch + | Params$Resource$Projects$Locations$Evaluations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25739,13 +29567,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {}) as Params$Resource$Projects$Locations$Evaluations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch; + {} as Params$Resource$Projects$Locations$Evaluations$Operations$Get; options = {}; } @@ -25759,17 +29587,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+siteSearchEngine}:enableAdvancedSiteSearch' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -25781,67 +29607,82 @@ export namespace discoveryengine_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Evaluations$Operations$Get + extends StandardParameters { /** - * Request on-demand recrawl for a list of URIs. + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Groundingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Performs a grounding check. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions ): GaxiosPromise; - recrawlUris( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + check( + params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, options?: MethodOptions - ): GaxiosPromise; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + ): GaxiosPromise; + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - recrawlUris( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, - callback: BodyResponseCallback + check( + params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + callback: BodyResponseCallback ): void; - recrawlUris( - callback: BodyResponseCallback + check( + callback: BodyResponseCallback ): void; - recrawlUris( + check( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris - | BodyResponseCallback + | Params$Resource$Projects$Locations$Groundingconfigs$Check + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; options = {}; } @@ -25855,7 +29696,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+siteSearchEngine}:recrawlUris').replace( + url: (rootUrl + '/v1beta/{+groundingConfig}:check').replace( /([^:]\/)\/+/g, '$1' ), @@ -25865,102 +29706,80 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['siteSearchEngine'], - pathParams: ['siteSearchEngine'], + requiredParams: ['groundingConfig'], + pathParams: ['groundingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Disableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Enableadvancedsitesearch - extends StandardParameters { - /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/{project\}/locations/{location\}/dataStores/{data_store_id\}/siteSearchEngine`. - */ - siteSearchEngine?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + export interface Params$Resource$Projects$Locations$Groundingconfigs$Check extends StandardParameters { /** - * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. */ - siteSearchEngine?: string; + groundingConfig?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecrawlUrisRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest; } - export class Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites { + export class Resource$Projects$Locations$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates TargetSite in a batch. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - batchCreate( + get( callback: BodyResponseCallback ): void; - batchCreate( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -25976,13 +29795,12 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -25996,17 +29814,15 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/targetSites:batchCreate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { @@ -26020,65 +29836,64 @@ export namespace discoveryengine_v1beta { } /** - * Creates a TargetSite. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - create( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -26092,90 +29907,125 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( + url: (rootUrl + '/v1beta/{+name}/operations').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { /** - * Deletes a TargetSite. + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Rankingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Ranks a list of text records based on the given input query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + rank( + params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + ): GaxiosPromise; + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete, - callback: BodyResponseCallback + rank( + params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + callback: BodyResponseCallback ): void; - delete( - callback: BodyResponseCallback + rank( + callback: BodyResponseCallback ): void; - delete( + rank( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Rankingconfigs$Rank + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete; + params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; options = {}; } @@ -26189,87 +30039,122 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta/{+rankingConfig}:rank').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['rankingConfig'], + pathParams: ['rankingConfig'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } + } + + export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank + extends StandardParameters { + /** + * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + */ + rankingConfig?: string; /** - * Gets a TargetSite. + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRankRequest; + } + + export class Resource$Projects$Locations$Samplequerysets { + context: APIRequestContext; + operations: Resource$Projects$Locations$Samplequerysets$Operations; + sampleQueries: Resource$Projects$Locations$Samplequerysets$Samplequeries; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = + new Resource$Projects$Locations$Samplequerysets$Operations( + this.context + ); + this.sampleQueries = + new Resource$Projects$Locations$Samplequerysets$Samplequeries( + this.context + ); + } + + /** + * Creates a SampleQuerySet * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Create, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - get( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get; + {} as Params$Resource$Projects$Locations$Samplequerysets$Create; options = {}; } @@ -26283,89 +30168,88 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Gets a list of TargetSites. + * Deletes a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List; + {} as Params$Resource$Projects$Locations$Samplequerysets$Delete; options = {}; } @@ -26379,92 +30263,86 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/targetSites').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates a TargetSite. + * Gets a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Get, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - patch( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Get; options = {}; } @@ -26479,7 +30357,7 @@ export namespace discoveryengine_v1beta { options: Object.assign( { url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -26490,148 +30368,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } - } - - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Batchcreate - extends StandardParameters { - /** - * Required. The parent resource shared by all TargetSites being created. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Create - extends StandardParameters { - /** - * Required. Parent resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Delete - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Get - extends StandardParameters { - /** - * Required. Full resource name of TargetSite, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$List - extends StandardParameters { - /** - * Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent site search engine resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Targetsites$Patch - extends StandardParameters { - /** - * Output only. The fully qualified resource name of the target site. `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}/siteSearchEngine/targetSites/{target_site\}` The `target_site_id` is system-generated. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaTargetSite; - } - - export class Resource$Projects$Locations$Datastores$Suggestiondenylistentries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Imports all SuggestionDenyListEntry for a DataStore. + * Gets a list of SampleQuerySets. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + list( + params?: Params$Resource$Projects$Locations$Samplequerysets$List, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Samplequerysets$List, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - import( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + {}) as Params$Resource$Projects$Locations$Samplequerysets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$List; options = {}; } @@ -26645,10 +30451,11 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:import' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+parent}/sampleQuerySets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options @@ -26659,75 +30466,76 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Permanently deletes all SuggestionDenyListEntry for a DataStore. + * Updates a SampleQuerySet. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions ): GaxiosPromise; - purge( - params?: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Patch, options?: MethodOptions - ): GaxiosPromise; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - purge( - params: Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Patch, + callback: BodyResponseCallback ): void; - purge( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - purge( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge; + params = {} as Params$Resource$Projects$Locations$Samplequerysets$Patch; options = {}; } @@ -26741,117 +30549,158 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1beta/{+parent}/suggestionDenyListEntries:purge' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Import + export interface Params$Resource$Projects$Locations$Samplequerysets$Create extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQuerySetId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet; } - export interface Params$Resource$Projects$Locations$Datastores$Suggestiondenylistentries$Purge + export interface Params$Resource$Projects$Locations$Samplequerysets$Delete extends StandardParameters { /** - * Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/x/locations/x/collections/x/dataStores/x. + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuerySet, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$List + extends StandardParameters { + /** + * Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent location resource name, such as `projects/{project\}/locations/{location\}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. */ parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Patch + extends StandardParameters { + /** + * Identifier. The full resource name of the SampleQuerySet, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuerySet; } - export class Resource$Projects$Locations$Datastores$Userevents { + export class Resource$Projects$Locations$Samplequerysets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - collect( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options?: MethodOptions - ): GaxiosPromise; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - collect( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Collect, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Operations$Get, + callback: BodyResponseCallback ): void; - collect(callback: BodyResponseCallback): void; - collect( + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Collect - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Collect; + {} as Params$Resource$Projects$Locations$Samplequerysets$Operations$Get; options = {}; } @@ -26865,90 +30714,102 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:collect').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Operations$Get + extends StandardParameters { /** - * Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Projects$Locations$Samplequerysets$Samplequeries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a SampleQuery * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions ): GaxiosPromise; - import( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Import, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - import( + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Import - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Import; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create; options = {}; } @@ -26962,7 +30823,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:import').replace( + url: (rootUrl + '/v1beta/{+parent}/sampleQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -26977,75 +30838,73 @@ export namespace discoveryengine_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Writes a single user event. + * Deletes a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions ): GaxiosPromise; - write( - params?: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + delete( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options?: MethodOptions - ): GaxiosPromise; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - write( - params: Params$Resource$Projects$Locations$Datastores$Userevents$Write, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - write( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete, + callback: BodyResponseCallback ): void; - write( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datastores$Userevents$Write - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datastores$Userevents$Write; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete; options = {}; } @@ -27059,147 +30918,87 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+parent}/userEvents:write').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Collect - extends StandardParameters { - /** - * The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. - */ - ets?: string; - /** - * Required. The parent DataStore resource name, such as `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. - */ - parent?: string; - /** - * 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. - */ - uri?: string; - /** - * Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. - */ - userEvent?: string; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Import - extends StandardParameters { - /** - * Required. Parent DataStore resource name, of the form `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}` - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportUserEventsRequest; - } - export interface Params$Resource$Projects$Locations$Datastores$Userevents$Write - extends StandardParameters { - /** - * Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{data_store\}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write. - */ - writeAsync?: boolean; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaUserEvent; - } - - export class Resource$Projects$Locations$Groundingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + return createAPIRequest(parameters); + } } /** - * Performs a grounding check. + * Gets a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions ): GaxiosPromise; - check( - params?: Params$Resource$Projects$Locations$Groundingconfigs$Check, + get( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options?: MethodOptions - ): GaxiosPromise; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - check( - params: Params$Resource$Projects$Locations$Groundingconfigs$Check, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get, + callback: BodyResponseCallback ): void; - check( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - check( + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Groundingconfigs$Check - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Groundingconfigs$Check; + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get; options = {}; } @@ -27213,90 +31012,67 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+groundingConfig}:check').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['groundingConfig'], - pathParams: ['groundingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Groundingconfigs$Check - extends StandardParameters { - /** - * Required. The resource name of the grounding config, such as `projects/x/locations/global/groundingConfigs/default_grounding_config`. - */ - groundingConfig?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaCheckGroundingRequest; - } - - export class Resource$Projects$Locations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * 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. + * Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + import( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options?: MethodOptions ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + import( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import, callback: BodyResponseCallback ): void; - get( + import( callback: BodyResponseCallback ): void; - get( + import( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -27312,12 +31088,13 @@ export namespace discoveryengine_v1beta { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import; options = {}; } @@ -27331,15 +31108,18 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1beta/{+parent}/sampleQueries:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { @@ -27353,7 +31133,7 @@ export namespace discoveryengine_v1beta { } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Gets a list of SampleQuerys. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -27361,56 +31141,57 @@ export namespace discoveryengine_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Operations$List, + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List; options = {}; } @@ -27424,7 +31205,7 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+name}/operations').replace( + url: (rootUrl + '/v1beta/{+parent}/sampleQueries').replace( /([^:]\/)\/+/g, '$1' ), @@ -27434,115 +31215,82 @@ export namespace discoveryengine_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - } - - export interface Params$Resource$Projects$Locations$Operations$Get - extends StandardParameters { - /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Operations$List - extends StandardParameters { - /** - * The standard list filter. - */ - filter?: string; - /** - * The name of the operation's parent resource. - */ - name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; - } - - export class Resource$Projects$Locations$Rankingconfigs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Ranks a list of text records based on the given input query. + * Updates a SampleQuery. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions ): GaxiosPromise; - rank( - params?: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + patch( + params?: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options?: MethodOptions - ): GaxiosPromise; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - rank( - params: Params$Resource$Projects$Locations$Rankingconfigs$Rank, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch, + callback: BodyResponseCallback ): void; - rank( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - rank( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Rankingconfigs$Rank - | BodyResponseCallback + | Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + {}) as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Rankingconfigs$Rank; + params = + {} as Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch; options = {}; } @@ -27556,44 +31304,102 @@ export namespace discoveryengine_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+rankingConfig}:rank').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['rankingConfig'], - pathParams: ['rankingConfig'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Projects$Locations$Rankingconfigs$Rank + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Create extends StandardParameters { /** - * Required. The resource name of the rank service config, such as `projects/{project_num\}/locations/{location_id\}/rankingConfigs/default_ranking_config`. + * Required. The parent resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. */ - rankingConfig?: string; + parent?: string; + /** + * Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + sampleQueryId?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRankRequest; + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Delete + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Get + extends StandardParameters { + /** + * Required. Full resource name of SampleQuery, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Import + extends StandardParameters { + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$List + extends StandardParameters { + /** + * Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. + */ + pageSize?: number; + /** + * A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. + */ + pageToken?: string; + /** + * Required. The parent sample query set resource name, such as `projects/{project\}/locations/{location\}/sampleQuerySets/{sampleQuerySet\}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Samplequerysets$Samplequeries$Patch + extends StandardParameters { + /** + * Identifier. The full resource name of the sample query, in the format of `projects/{project\}/locations/{location\}/sampleQuerySets/{sample_query_set\}/sampleQueries/{sample_query\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. + */ + name?: string; + /** + * Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSampleQuery; } export class Resource$Projects$Locations$Userevents { diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index 79dedd4229..e57aa5e515 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -3458,7 +3458,7 @@ export namespace displayvideo_v3 { */ adGroupIds?: string[] | null; /** - * Optional. YouTube Ad Groups QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. */ adGroupQaIds?: string[] | null; /** @@ -3474,7 +3474,7 @@ export namespace displayvideo_v3 { */ lineItemIds?: string[] | null; /** - * Optional. Line Items QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + * Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. */ lineItemQaIds?: string[] | null; /** @@ -5446,7 +5446,7 @@ export namespace displayvideo_v3 { */ exchangeReviewStatuses?: Schema$ExchangeReviewStatus[]; /** - * Publisher review statuses for the creative. **Warning:** This field will be deprecated on June 26th, 2024. After this date, this field will be empty. Read our [feature deprecation announcement](/display-video/api/deprecations#features.creative_publisher_review_statuses) for more information. + * Publisher review statuses for the creative. */ publisherReviewStatuses?: Schema$PublisherReviewStatus[]; } diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 0d17e084c9..07907e131c 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -188,6 +188,10 @@ export namespace dlp_v2 { * Match database resources not covered by any other filter. */ export interface Schema$GooglePrivacyDlpV2AllOtherDatabaseResources {} + /** + * Match discovery resources not covered by any other filter. + */ + export interface Schema$GooglePrivacyDlpV2AllOtherResources {} /** * Apply to all text. */ @@ -582,6 +586,27 @@ export namespace dlp_v2 { */ usernamePassword?: Schema$GooglePrivacyDlpV2SecretManagerCredential; } + /** + * Target used to match against for discovery with Cloud Storage buckets. + */ + export interface Schema$GooglePrivacyDlpV2CloudStorageDiscoveryTarget { + /** + * Optional. In addition to matching the filter, these conditions must be true before a profile is generated. + */ + conditions?: Schema$GooglePrivacyDlpV2DiscoveryFileStoreConditions; + /** + * Optional. Disable profiling for buckets that match this filter. + */ + disabled?: Schema$GooglePrivacyDlpV2Disabled; + /** + * Required. The buckets the generation_cadence applies to. The first target with a matching filter will be the one to apply to a bucket. + */ + filter?: Schema$GooglePrivacyDlpV2DiscoveryCloudStorageFilter; + /** + * Optional. How often and when to update profiles. New buckets that match both the filter and conditions are scanned as quickly as possible depending on system capacity. + */ + generationCadence?: Schema$GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence; + } /** * Message representing a set of files in Cloud Storage. */ @@ -629,6 +654,19 @@ export namespace dlp_v2 { */ path?: string | null; } + /** + * A pattern to match against one or more file stores. At least one pattern must be specified. Regular expressions use RE2 [syntax](https://github.com/google/re2/wiki/Syntax); a guide can be found under the google/re2 repository on GitHub. + */ + export interface Schema$GooglePrivacyDlpV2CloudStorageRegex { + /** + * Optional. Regex to test the bucket name against. If empty, all buckets match. Example: "marketing2021" or "(marketing)\d{4\}" will both match the bucket gs://marketing2021 + */ + bucketNameRegex?: string | null; + /** + * Optional. For organizations, if unset, will match all projects. + */ + projectIdRegex?: string | null; + } /** * Message representing a set of files in a Cloud Storage bucket. Regular expressions are used to allow fine-grained control over which files in the bucket to include. Included files are those that match at least one item in `include_regex` and do not match any items in `exclude_regex`. Note that a file that matches items from both lists will _not_ be included. For a match to occur, the entire file path (i.e., everything in the url after the bucket name) must match the regular expression. For example, given the input `{bucket_name: "mybucket", include_regex: ["directory1/.*"], exclude_regex: ["directory1/excluded.*"]\}`: * `gs://mybucket/directory1/myfile` will be included * `gs://mybucket/directory1/directory2/myfile` will be included (`.*` matches across `/`) * `gs://mybucket/directory0/directory1/myfile` will _not_ be included (the full path doesn't match any items in `include_regex`) * `gs://mybucket/directory1/excludedfile` will _not_ be included (the path matches an item in `exclude_regex`) If `include_regex` is left empty, it will match all files by default (this is equivalent to setting `include_regex: [".*"]`). Some other common use cases: * `{bucket_name: "mybucket", exclude_regex: [".*\.pdf"]\}` will include all files in `mybucket` except for .pdf files * `{bucket_name: "mybucket", include_regex: ["directory/[^/]+"]\}` will include all files directly under `gs://mybucket/directory/`, without matching across `/` */ @@ -646,6 +684,19 @@ export namespace dlp_v2 { */ includeRegex?: string[] | null; } + /** + * Identifies a single Cloud Storage bucket. + */ + export interface Schema$GooglePrivacyDlpV2CloudStorageResourceReference { + /** + * Required. The bucket to scan. + */ + bucketName?: string | null; + /** + * Required. If within a project-level config, then this must match the config's project id. + */ + projectId?: string | null; + } /** * Represents a color in the RGB color space. */ @@ -1049,7 +1100,7 @@ export namespace dlp_v2 { */ cryptoKey?: Schema$GooglePrivacyDlpV2CryptoKey; /** - * This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz ~`!@#$%^&*()_-+={[\}]|\:;"'<,\>.?/ + * This is supported by mapping these to the alphanumeric characters that the FFX mode natively supports. This happens before/after encryption/decryption. Each character listed must appear only once. Number of characters must be in the range [2, 95]. This must be encoded as ASCII. The order of characters does not matter. The full list of allowed characters is: ``0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz~`!@#$%^&*()_-+={[\}]|\:;"'<,\>.?/`` */ customAlphabet?: string | null; /** @@ -1174,6 +1225,10 @@ export namespace dlp_v2 { * Publish a message into the Pub/Sub topic. */ pubSubNotification?: Schema$GooglePrivacyDlpV2PubSubNotification; + /** + * Tags the profiled resources with the specified tag values. + */ + tagResources?: Schema$GooglePrivacyDlpV2TagResources; } /** * The schema of data to be saved to the BigQuery table when the `DataProfileAction` is enabled. @@ -1243,7 +1298,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DataProfileLocation { /** - * The ID of the Folder within an organization to scan. + * The ID of the folder within an organization to scan. */ folderId?: string | null; /** @@ -1364,11 +1419,11 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2Deidentify { /** - * Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for cloud storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket + * Required. User settable Cloud Storage bucket and folders to store de-identified files. This field must be set for Cloud Storage deidentification. The output Cloud Storage bucket must be different from the input bucket. De-identified files will overwrite files in the output path. Form of: gs://bucket/folder/ or gs://bucket */ cloudStorageOutput?: string | null; /** - * List of user-specified file type groups to transform. If specified, only the files with these filetypes will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only filetypes supported are: IMAGES, TEXT_FILES, CSV, TSV. + * List of user-specified file type groups to transform. If specified, only the files with these file types will be transformed. If empty, all supported files will be transformed. Supported types may be automatically added over time. If a file type is set in this field that isn't supported by the Deidentify action then the job will fail and will not be successfully created/started. Currently the only file types supported are: IMAGES, TEXT_FILES, CSV, TSV. */ fileTypesToTransform?: string[] | null; /** @@ -1664,6 +1719,10 @@ export namespace dlp_v2 { * How often existing tables should have their profiles refreshed. New tables are scanned as quickly as possible depending on system capacity. */ export interface Schema$GooglePrivacyDlpV2DiscoveryCloudSqlGenerationCadence { + /** + * Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; /** * Data changes (non-schema changes) in Cloud SQL tables can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying tables have changed. Defaults to never. */ @@ -1673,6 +1732,49 @@ export namespace dlp_v2 { */ schemaModifiedCadence?: Schema$GooglePrivacyDlpV2SchemaModifiedCadence; } + /** + * Requirements that must be true before a Cloud Storage bucket or object is scanned in discovery for the first time. There is an AND relationship between the top-level attributes. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryCloudStorageConditions { + /** + * Required. Only objects with the specified attributes will be scanned. Defaults to [ALL_SUPPORTED_BUCKETS] if unset. + */ + includedBucketAttributes?: string[] | null; + /** + * Required. Only objects with the specified attributes will be scanned. If an object has one of the specified attributes but is inside an excluded bucket, it will not be scanned. Defaults to [ALL_SUPPORTED_OBJECTS]. A profile will be created even if no objects match the included_object_attributes. + */ + includedObjectAttributes?: string[] | null; + } + /** + * Determines which buckets will have profiles generated within an organization or project. Includes the ability to filter by regular expression patterns on project ID and bucket name. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryCloudStorageFilter { + /** + * Optional. The bucket to scan. Targets including this can only include one target (the target with this bucket). This enables profiling the contents of a single bucket, while the other options allow for easy profiling of many bucets within a project or an organization. + */ + cloudStorageResourceReference?: Schema$GooglePrivacyDlpV2CloudStorageResourceReference; + /** + * Optional. A specific set of buckets for this filter to apply to. + */ + collection?: Schema$GooglePrivacyDlpV2FileStoreCollection; + /** + * Optional. Catch-all. This should always be the last target in the list because anything above it will apply first. Should only appear once in a configuration. If none is specified, a default one will be added automatically. + */ + others?: Schema$GooglePrivacyDlpV2AllOtherResources; + } + /** + * How often existing buckets should have their profiles refreshed. New buckets are scanned as quickly as possible depending on system capacity. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryCloudStorageGenerationCadence { + /** + * Optional. Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; + /** + * Optional. Data changes in Cloud Storage can't trigger reprofiling. If you set this field, profiles are refreshed at this frequency regardless of whether the underlying buckets have changed. Defaults to never. + */ + refreshFrequency?: string | null; + } /** * Configuration for discovery to scan resources for profile generation. Only one discovery configuration may exist per organization, folder, or project. The generated data profiles are retained according to the [data retention policy] (https://cloud.google.com/sensitive-data-protection/docs/data-profiles#retention). */ @@ -1722,10 +1824,35 @@ export namespace dlp_v2 { */ updateTime?: string | null; } + /** + * Requirements that must be true before a file store is scanned in discovery for the first time. There is an AND relationship between the top-level attributes. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryFileStoreConditions { + /** + * Optional. Cloud Storage conditions. + */ + cloudStorageConditions?: Schema$GooglePrivacyDlpV2DiscoveryCloudStorageConditions; + /** + * Optional. File store must have been created after this date. Used to avoid backfilling. + */ + createdAfter?: string | null; + /** + * Optional. Minimum age a file store must have. If set, the value must be 1 hour or greater. + */ + minAge?: string | null; + } /** * What must take place for a profile to be updated and how frequently it should occur. New tables are scanned as quickly as possible depending on system capacity. */ export interface Schema$GooglePrivacyDlpV2DiscoveryGenerationCadence { + /** + * Governs when to update data profiles when the inspection rules defined by the `InspectTemplate` change. If not set, changing the template will not cause a data profile to update. + */ + inspectTemplateModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence; + /** + * Frequency at which profiles should be updated, regardless of whether the underlying resource has changed. Defaults to never. + */ + refreshFrequency?: string | null; /** * Governs when to update data profiles when a schema is modified. */ @@ -1735,6 +1862,15 @@ export namespace dlp_v2 { */ tableModifiedCadence?: Schema$GooglePrivacyDlpV2DiscoveryTableModifiedCadence; } + /** + * The cadence at which to update data profiles when the inspection rules defined by the `InspectTemplate` change. + */ + export interface Schema$GooglePrivacyDlpV2DiscoveryInspectTemplateModifiedCadence { + /** + * How frequently data profiles can be updated when the template is modified. Defaults to never. + */ + frequency?: string | null; + } /** * The cadence at which to update data profiles when a schema is modified. */ @@ -1753,7 +1889,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2DiscoveryStartingLocation { /** - * The ID of the Folder within an organization to scan. + * The ID of the folder within an organization to be scanned. */ folderId?: string | null; /** @@ -1786,6 +1922,10 @@ export namespace dlp_v2 { * Cloud SQL target for Discovery. The first target to match a table will be the one applied. */ cloudSqlTarget?: Schema$GooglePrivacyDlpV2CloudSqlDiscoveryTarget; + /** + * Cloud Storage target for Discovery. The first target to match a table will be the one applied. + */ + cloudStorageTarget?: Schema$GooglePrivacyDlpV2CloudStorageDiscoveryTarget; /** * Discovery target that looks for credentials and secrets stored in cloud resource metadata and reports them as vulnerabilities to Security Command Center. Only one target of this type is allowed. */ @@ -1987,7 +2127,7 @@ export namespace dlp_v2 { */ dataRiskLevel?: Schema$GooglePrivacyDlpV2DataRiskLevel; /** - * A list of Errors detected while scanning this cluster. The list is truncated to 10 per cluster. + * A list of errors detected while scanning this cluster. The list is truncated to 10 per cluster. */ errors?: Schema$GooglePrivacyDlpV2Error[]; /** @@ -1995,11 +2135,11 @@ export namespace dlp_v2 { */ fileClusterType?: Schema$GooglePrivacyDlpV2FileClusterType; /** - * A sample of file types scanned in this cluster. Empty if no files were scanned. + * A sample of file types scanned in this cluster. Empty if no files were scanned. File extensions can be derived from the file name or the file content. */ fileExtensionsScanned?: Schema$GooglePrivacyDlpV2FileExtensionInfo[]; /** - * A sample of file types seen in this cluster. Empty if no files were seen. + * A sample of file types seen in this cluster. Empty if no files were seen. File extensions can be derived from the file name or the file content. */ fileExtensionsSeen?: Schema$GooglePrivacyDlpV2FileExtensionInfo[]; /** @@ -2047,7 +2187,16 @@ export namespace dlp_v2 { url?: string | null; } /** - * The profile for a file store. * Google Cloud Storage: maps 1:1 with a bucket. + * Match file stores (e.g. buckets) using regex filters. + */ + export interface Schema$GooglePrivacyDlpV2FileStoreCollection { + /** + * Optional. A collection of regular expressions to match a file store against. + */ + includeRegexes?: Schema$GooglePrivacyDlpV2FileStoreRegexes; + } + /** + * The profile for a file store. * Cloud Storage: maps 1:1 with a bucket. */ export interface Schema$GooglePrivacyDlpV2FileStoreDataProfile { /** @@ -2067,7 +2216,7 @@ export namespace dlp_v2 { */ dataSourceType?: Schema$GooglePrivacyDlpV2DataSourceType; /** - * For resources that have multiple storage locations, these are those regions. For Google Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. + * For resources that have multiple storage locations, these are those regions. For Cloud Storage this is the list of regions chosen for dual-region storage. `file_store_location` will normally be the corresponding multi-region for the list of individual locations. The first region is always picked as the processing and storage location for the data profile. */ dataStorageLocations?: string[] | null; /** @@ -2083,11 +2232,11 @@ export namespace dlp_v2 { */ fileStoreIsEmpty?: boolean | null; /** - * The location of the file store. * Google Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations + * The location of the file store. * Cloud Storage: https://cloud.google.com/storage/docs/locations#available-locations */ fileStoreLocation?: string | null; /** - * The file store path. * Google Cloud Storage: `gs://{bucket\}` + * The file store path. * Cloud Storage: `gs://{bucket\}` */ fileStorePath?: string | null; /** @@ -2115,7 +2264,7 @@ export namespace dlp_v2 { */ profileStatus?: Schema$GooglePrivacyDlpV2ProfileStatus; /** - * The resource name to the project data profile for this file store. + * The resource name of the project data profile for this file store. */ projectDataProfile?: string | null; /** @@ -2123,7 +2272,7 @@ export namespace dlp_v2 { */ projectId?: string | null; /** - * Attributes of the resource being profiled. Currently used attributes: - customer_managed_encryption: boolean true: the resource is encrypted with a customer-managed key. false: the resource is encrypted with a provider-managed key. + * Attributes of the resource being profiled. Currently used attributes: * customer_managed_encryption: boolean - true: the resource is encrypted with a customer-managed key. - false: the resource is encrypted with a provider-managed key. */ resourceAttributes?: {[key: string]: Schema$GooglePrivacyDlpV2Value} | null; /** @@ -2152,6 +2301,24 @@ export namespace dlp_v2 { */ infoType?: Schema$GooglePrivacyDlpV2InfoType; } + /** + * A pattern to match against one or more file stores. + */ + export interface Schema$GooglePrivacyDlpV2FileStoreRegex { + /** + * Optional. Regex for Cloud Storage. + */ + cloudStorageRegex?: Schema$GooglePrivacyDlpV2CloudStorageRegex; + } + /** + * A collection of regular expressions to determine what file store to match against. + */ + export interface Schema$GooglePrivacyDlpV2FileStoreRegexes { + /** + * Required. The group of regular expression patterns to match against one or more file stores. Maximum of 100 entries. The sum of all regular expression's length can't exceed 10 KiB. + */ + patterns?: Schema$GooglePrivacyDlpV2FileStoreRegex[]; + } /** * Represents a piece of potentially sensitive content. */ @@ -4256,7 +4423,7 @@ export namespace dlp_v2 { */ profileStatus?: Schema$GooglePrivacyDlpV2ProfileStatus; /** - * The resource name to the project data profile for this table. + * The resource name of the project data profile for this table. */ projectDataProfile?: string | null; /** @@ -4323,6 +4490,19 @@ export namespace dlp_v2 { */ tableId?: string | null; } + /** + * The tag to attach to profiles matching the condition. At most one `TagCondition` can be specified per sensitivity level. + */ + export interface Schema$GooglePrivacyDlpV2TagCondition { + /** + * Conditions attaching the tag to a resource on its profile having this sensitivity score. + */ + sensitivityScore?: Schema$GooglePrivacyDlpV2SensitivityScore; + /** + * The tag value to attach to resources. + */ + tag?: Schema$GooglePrivacyDlpV2TagValue; + } /** * A column with a semantic tag attached. */ @@ -4344,6 +4524,32 @@ export namespace dlp_v2 { */ infoType?: Schema$GooglePrivacyDlpV2InfoType; } + /** + * If set, attaches the [tags] (https://cloud.google.com/resource-manager/docs/tags/tags-overview) provided to profiled resources. Tags support [access control](https://cloud.google.com/iam/docs/tags-access-control). You can conditionally grant or deny access to a resource based on whether the resource has a specific tag. + */ + export interface Schema$GooglePrivacyDlpV2TagResources { + /** + * Whether applying a tag to a resource should lower the risk of the profile for that resource. For example, in conjunction with an [IAM deny policy](https://cloud.google.com/iam/docs/deny-overview), you can deny all principals a permission if a tag value is present, mitigating the risk of the resource. This also lowers the data risk of resources at the lower levels of the resource hierarchy. For example, reducing the data risk of a table data profile also reduces the data risk of the constituent column data profiles. + */ + lowerDataRiskToLow?: boolean | null; + /** + * The profile generations for which the tag should be attached to resources. If you attach a tag to only new profiles, then if the sensitivity score of a profile subsequently changes, its tag doesn't change. By default, this field includes only new profiles. To include both new and updated profiles for tagging, this field should explicitly include both `PROFILE_GENERATION_NEW` and `PROFILE_GENERATION_UPDATE`. + */ + profileGenerationsToTag?: string[] | null; + /** + * The tags to associate with different conditions. + */ + tagConditions?: Schema$GooglePrivacyDlpV2TagCondition[]; + } + /** + * A value of a tag. + */ + export interface Schema$GooglePrivacyDlpV2TagValue { + /** + * The namespaced name for the tag value to attach to resources. Must be in the format `{parent_id\}/{tag_key_short_name\}/{short_name\}`, for example, "123456/environment/prod". + */ + namespacedValue?: string | null; + } /** * Throw an error and fail the request when a transformation error occurs. */ @@ -4374,7 +4580,7 @@ export namespace dlp_v2 { */ startTime?: string | null; /** - * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. *For BigQuery* If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - _PARTITIONTIME - _PARTITIONDATE - _PARTITION_LOAD_TIME *For Datastore* If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. + * Specification of the field containing the timestamp of scanned items. Used for data sources like Datastore and BigQuery. **For BigQuery** If this value is not specified and the table was modified between the given start and end times, the entire table will be scanned. If this value is specified, then rows are filtered based on the given start and end times. Rows with a `NULL` value in the provided BigQuery column are skipped. Valid data types of the provided BigQuery column are: `INTEGER`, `DATE`, `TIMESTAMP`, and `DATETIME`. If your BigQuery table is [partitioned at ingestion time](https://cloud.google.com/bigquery/docs/partitioned-tables#ingestion_time), you can use any of the following pseudo-columns as your timestamp field. When used with Cloud DLP, these pseudo-column names are case sensitive. - `_PARTITIONTIME` - `_PARTITIONDATE` - `_PARTITION_LOAD_TIME` **For Datastore** If this value is specified, then entities are filtered based on the given start and end times. If an entity does not contain the provided timestamp property or contains empty or invalid values, then it is included. Valid data types of the provided timestamp property are: `TIMESTAMP`. See the [known issue](https://cloud.google.com/sensitive-data-protection/docs/known-issues#bq-timespan) related to this operation. */ timestampField?: Schema$GooglePrivacyDlpV2FieldId; } @@ -4907,7 +5113,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * The parent resource name. The format of this value is as follows: locations/ LOCATION_ID + * The parent resource name. The format of this value is as follows: `locations/{location_id\}` */ parent?: string; } @@ -5040,7 +5246,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * The parent resource name. The format of this value is as follows: locations/ LOCATION_ID + * The parent resource name. The format of this value is as follows: `locations/{location_id\}` */ parent?: string; } @@ -5546,7 +5752,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -5576,7 +5782,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -5588,7 +5794,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -6085,7 +6291,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -6115,7 +6321,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -6127,7 +6333,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -6401,7 +6607,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -6705,6 +6911,103 @@ export namespace dlp_v2 { } } + /** + * Lists Connections in a parent. Use SearchConnections to see all connections within an organization. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Organizations$Locations$Connections$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Organizations$Locations$Connections$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Locations$Connections$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Connections$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Locations$Connections$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Connections$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Connections$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Connections$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dlp.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/connections').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Update a Connection. * @@ -6902,7 +7205,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Connections$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id\}/locations/{location_id\}` + Organizations scope: `organizations/{org_id\}/locations/{location_id\}` */ parent?: string; @@ -6925,6 +7228,25 @@ export namespace dlp_v2 { */ name?: string; } + export interface Params$Resource$Organizations$Locations$Connections$List + extends StandardParameters { + /** + * Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR + */ + filter?: string; + /** + * Optional. Number of results per page, max 1000. + */ + pageSize?: number; + /** + * Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request. + */ + pageToken?: string; + /** + * Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. + */ + parent?: string; + } export interface Params$Resource$Organizations$Locations$Connections$Patch extends StandardParameters { /** @@ -6952,7 +7274,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent name, typically an organization, without location. For example: `organizations/12345678`. + * Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`. */ parent?: string; } @@ -7442,7 +7764,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -7472,7 +7794,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -7484,7 +7806,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -7986,7 +8308,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Discoveryconfigs$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id\}/locations/{location_id\}` + Organizations scope: `organizations/{org_id\}/locations/{location_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -8012,7 +8334,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Discoveryconfigs$List extends StandardParameters { /** - * Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. + * Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. */ orderBy?: string; /** @@ -8024,7 +8346,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value is as follows: `projects/{project_id\}/locations/{location_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -8156,7 +8478,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -8168,7 +8490,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -8483,11 +8805,11 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Filestoredataprofiles$List extends StandardParameters { /** - * Optional. Allows filtering. 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\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + * Optional. Allows filtering. 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\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. + * Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. */ orderBy?: string; /** @@ -8989,7 +9311,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -9019,7 +9341,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -9031,7 +9353,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -9531,7 +9853,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Jobtriggers$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -9565,7 +9887,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -9577,7 +9899,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -9812,7 +10134,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -10314,7 +10636,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Locations$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -10344,7 +10666,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -10356,7 +10678,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -10683,7 +11005,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. */ orderBy?: string; /** @@ -11180,7 +11502,7 @@ export namespace dlp_v2 { export interface Params$Resource$Organizations$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -11210,7 +11532,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -11222,7 +11544,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -11569,7 +11891,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Content$Deidentify extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -11581,7 +11903,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Content$Inspect extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -11593,7 +11915,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Content$Reidentify extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12083,7 +12405,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12113,7 +12435,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -12125,7 +12447,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -12622,7 +12944,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Dlpjobs$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -12656,7 +12978,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -12668,7 +12990,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -12784,7 +13106,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Image$Redact extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -13274,7 +13596,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -13304,7 +13626,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -13316,7 +13638,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -13920,7 +14242,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Jobtriggers$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -13954,7 +14276,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -13966,7 +14288,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -14249,7 +14571,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a column is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -14552,7 +14874,7 @@ export namespace dlp_v2 { } /** - * Lists Connections in a parent. + * Lists Connections in a parent. Use SearchConnections to see all connections within an organization. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -14843,7 +15165,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Connections$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id\}/locations/{location_id\}` + Organizations scope: `organizations/{org_id\}/locations/{location_id\}` */ parent?: string; @@ -14881,7 +15203,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent name, for example: `projects/project-id/locations/global`. + * Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. */ parent?: string; } @@ -14912,7 +15234,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent name, typically an organization, without location. For example: `organizations/12345678`. + * Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`. */ parent?: string; } @@ -15218,7 +15540,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Content$Deidentify extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -15230,7 +15552,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Content$Inspect extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -15242,7 +15564,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Content$Reidentify extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -15737,7 +16059,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Deidentifytemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -15767,7 +16089,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -15779,7 +16101,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -16279,7 +16601,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Discoveryconfigs$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/`PROJECT_ID`/locations/`LOCATION_ID + Organizations scope: `organizations/`ORG_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id\}/locations/{location_id\}` + Organizations scope: `organizations/{org_id\}/locations/{location_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -16305,7 +16627,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Discoveryconfigs$List extends StandardParameters { /** - * Comma separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. + * Comma-separated list of config fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `last_run_time`: corresponds to the last time the DiscoveryConfig ran. - `name`: corresponds to the DiscoveryConfig's name. - `status`: corresponds to DiscoveryConfig's status. */ orderBy?: string; /** @@ -16317,7 +16639,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value is as follows: `projects/`PROJECT_ID`/locations/`LOCATION_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value is as follows: `projects/{project_id\}/locations/{location_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -16999,7 +17321,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Dlpjobs$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -17057,7 +17379,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, end_time asc, create_time desc` Supported fields are: - `create_time`: corresponds to the time the job was created. - `end_time`: corresponds to the time the job ended. - `name`: corresponds to the job's name. - `state`: corresponds to `state` */ orderBy?: string; /** @@ -17069,7 +17391,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -17384,11 +17706,11 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Filestoredataprofiles$List extends StandardParameters { /** - * Optional. Allows filtering. 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\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` . * 'file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. + * Optional. Allows filtering. 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\}`. * Supported fields/values: - `project_id` - The Google Cloud project ID. - `file_store_path` - The path like "gs://bucket". - `sensitivity_level` - HIGH|MODERATE|LOW - `data_risk_level` - HIGH|MODERATE|LOW - `resource_visibility`: PUBLIC|RESTRICTED - `status_code` - an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto * The operator must be `=` or `!=`. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `project_id = 12345 AND resource_visibility = PUBLIC` * `file_store_path = "gs://mybucket"` The length of this field should be no more than 500 characters. */ filter?: string; /** - * Optional. Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. + * Optional. Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `name` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `name`: The name of the profile. - `create_time`: The time the file store was first created. */ orderBy?: string; /** @@ -17512,7 +17834,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Image$Redact extends StandardParameters { /** - * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -18005,7 +18327,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Inspecttemplates$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -18035,7 +18357,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the template was created. - `update_time`: corresponds to the time the template was last updated. - `name`: corresponds to the template's name. - `display_name`: corresponds to the template's display name. */ orderBy?: string; /** @@ -18047,7 +18369,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -18749,7 +19071,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Jobtriggers$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -18795,7 +19117,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. + * Comma-separated list of triggeredJob fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc,update_time, create_time desc` Supported fields are: - `create_time`: corresponds to the time the JobTrigger was created. - `update_time`: corresponds to the time the JobTrigger was last updated. - `last_run_time`: corresponds to the last time the JobTrigger ran. - `name`: corresponds to the JobTrigger's name. - `display_name`: corresponds to the JobTrigger's display name. - `status`: corresponds to JobTrigger's status. */ orderBy?: string; /** @@ -18807,7 +19129,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; /** @@ -19042,7 +19364,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields are: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. */ orderBy?: string; /** @@ -19541,7 +19863,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Locations$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -19571,7 +19893,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -19583,7 +19905,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } @@ -19909,7 +20231,7 @@ export namespace dlp_v2 { */ filter?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id asc` * `table_id` * `sensitivity_level desc` Supported fields are: - `project_id`: The Google Cloud project ID. - `dataset_id`: The ID of a BigQuery dataset. - `table_id`: The ID of a BigQuery table. - `sensitivity_level`: How sensitive the data in a table is, at most. - `data_risk_level`: How much risk is associated with this data. - `profile_last_generated`: When the profile was last updated in epoch seconds. - `last_modified`: The last time the resource was modified. - `resource_visibility`: Visibility restriction for this resource. - `row_count`: Number of rows in this resource. */ orderBy?: string; /** @@ -20406,7 +20728,7 @@ export namespace dlp_v2 { export interface Params$Resource$Projects$Storedinfotypes$Create extends StandardParameters { /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID + Organizations scope, location specified: `organizations/`ORG_ID`/locations/`LOCATION_ID + Organizations scope, no location specified (defaults to global): `organizations/`ORG_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` + Organizations scope, location specified: `organizations/{org_id\}/locations/{location_id\}` + Organizations scope, no location specified (defaults to global): `organizations/{org_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; @@ -20436,7 +20758,7 @@ export namespace dlp_v2 { */ locationId?: string; /** - * Comma separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. + * Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Example: `name asc, display_name, create_time desc` Supported fields are: - `create_time`: corresponds to the time the most recent version of the resource was created. - `state`: corresponds to the state of the resource. - `name`: corresponds to resource name. - `display_name`: corresponds to info type's display name. */ orderBy?: string; /** @@ -20448,7 +20770,7 @@ export namespace dlp_v2 { */ pageToken?: string; /** - * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/`PROJECT_ID`/locations/` LOCATION_ID + Projects scope, no location specified (defaults to global): `projects/`PROJECT_ID The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 + * Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization) and whether you have [specified a processing location](https://cloud.google.com/sensitive-data-protection/docs/specifying-location): + Projects scope, location specified: `projects/{project_id\}/locations/{location_id\}` + Projects scope, no location specified (defaults to global): `projects/{project_id\}` The following example `parent` string specifies a parent project with the identifier `example-project`, and specifies the `europe-west3` location for processing data: parent=projects/example-project/locations/europe-west3 */ parent?: string; } diff --git a/src/apis/dns/v1.ts b/src/apis/dns/v1.ts index ee1ce4d93f..ee42bd340b 100644 --- a/src/apis/dns/v1.ts +++ b/src/apis/dns/v1.ts @@ -798,6 +798,7 @@ export namespace dns_v1 { * Maximum allowed number of GKE clusters per response policy. */ gkeClustersPerResponsePolicy?: number | null; + internetHealthChecksPerManagedZone?: number | null; /** * Maximum allowed number of items per routing policy. */ @@ -1034,6 +1035,10 @@ export namespace dns_v1 { */ export interface Schema$RRSetRoutingPolicy { geo?: Schema$RRSetRoutingPolicyGeoPolicy; + /** + * The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + */ + healthCheck?: string | null; kind?: string | null; primaryBackup?: Schema$RRSetRoutingPolicyPrimaryBackupPolicy; wrr?: Schema$RRSetRoutingPolicyWrrPolicy; @@ -1075,6 +1080,10 @@ export namespace dns_v1 { * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. */ export interface Schema$RRSetRoutingPolicyHealthCheckTargets { + /** + * The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + */ + externalEndpoints?: string[] | null; /** * Configuration for internal load balancers to be health checked. */ diff --git a/src/apis/dns/v1beta2.ts b/src/apis/dns/v1beta2.ts index a6b5967624..ff355f407b 100644 --- a/src/apis/dns/v1beta2.ts +++ b/src/apis/dns/v1beta2.ts @@ -798,6 +798,7 @@ export namespace dns_v1beta2 { * Maximum allowed number of GKE clusters per response policy. */ gkeClustersPerResponsePolicy?: number | null; + internetHealthChecksPerManagedZone?: number | null; /** * Maximum allowed number of items per routing policy. */ @@ -1034,6 +1035,10 @@ export namespace dns_v1beta2 { export interface Schema$RRSetRoutingPolicy { geo?: Schema$RRSetRoutingPolicyGeoPolicy; geoPolicy?: Schema$RRSetRoutingPolicyGeoPolicy; + /** + * The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + */ + healthCheck?: string | null; kind?: string | null; primaryBackup?: Schema$RRSetRoutingPolicyPrimaryBackupPolicy; wrr?: Schema$RRSetRoutingPolicyWrrPolicy; @@ -1076,6 +1081,10 @@ export namespace dns_v1beta2 { * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. */ export interface Schema$RRSetRoutingPolicyHealthCheckTargets { + /** + * The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + */ + externalEndpoints?: string[] | null; /** * Configuration for internal load balancers to be health checked. */ diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index e4d8bc47a7..5188deca3d 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -208,6 +208,19 @@ export namespace docs_v1 { */ content?: Schema$StructuralElement[]; } + /** + * A reference to a bookmark in this document. + */ + export interface Schema$BookmarkLink { + /** + * The ID of a bookmark in this document. + */ + id?: string | null; + /** + * The ID of the tab containing this bookmark. + */ + tabId?: string | null; + } /** * Describes the bullet of a paragraph. */ @@ -442,6 +455,10 @@ export namespace docs_v1 { * The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. */ footerId?: string | null; + /** + * The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * Deletes a Header from the document. @@ -451,6 +468,10 @@ export namespace docs_v1 { * The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section. */ headerId?: string | null; + /** + * The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * Deletes a NamedRange. @@ -464,6 +485,10 @@ export namespace docs_v1 { * The ID of the named range to delete. */ namedRangeId?: string | null; + /** + * Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs. + */ + tabsCriteria?: Schema$TabsCriteria; } /** * Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. @@ -482,6 +507,10 @@ export namespace docs_v1 { * The ID of the positioned object to delete. */ objectId?: string | null; + /** + * The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * Deletes a column from a table. @@ -519,7 +548,7 @@ export namespace docs_v1 { */ export interface Schema$Document { /** - * Output only. The main body of the document. + * Output only. The main body of the document. Legacy field: Instead, use Document.tabs.documentTab.body, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ body?: Schema$Body; /** @@ -527,39 +556,39 @@ export namespace docs_v1 { */ documentId?: string | null; /** - * Output only. The style of the document. + * Output only. The style of the document. Legacy field: Instead, use Document.tabs.documentTab.documentStyle, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ documentStyle?: Schema$DocumentStyle; /** - * Output only. The footers in the document, keyed by footer ID. + * Output only. The footers in the document, keyed by footer ID. Legacy field: Instead, use Document.tabs.documentTab.footers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ footers?: {[key: string]: Schema$Footer} | null; /** - * Output only. The footnotes in the document, keyed by footnote ID. + * Output only. The footnotes in the document, keyed by footnote ID. Legacy field: Instead, use Document.tabs.documentTab.footnotes, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ footnotes?: {[key: string]: Schema$Footnote} | null; /** - * Output only. The headers in the document, keyed by header ID. + * Output only. The headers in the document, keyed by header ID. Legacy field: Instead, use Document.tabs.documentTab.headers, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ headers?: {[key: string]: Schema$Header} | null; /** - * Output only. The inline objects in the document, keyed by object ID. + * Output only. The inline objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.inlineObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ inlineObjects?: {[key: string]: Schema$InlineObject} | null; /** - * Output only. The lists in the document, keyed by list ID. + * Output only. The lists in the document, keyed by list ID. Legacy field: Instead, use Document.tabs.documentTab.lists, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ lists?: {[key: string]: Schema$List} | null; /** - * Output only. The named ranges in the document, keyed by name. + * Output only. The named ranges in the document, keyed by name. Legacy field: Instead, use Document.tabs.documentTab.namedRanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ namedRanges?: {[key: string]: Schema$NamedRanges} | null; /** - * Output only. The named styles of the document. + * Output only. The named styles of the document. Legacy field: Instead, use Document.tabs.documentTab.namedStyles, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ namedStyles?: Schema$NamedStyles; /** - * Output only. The positioned objects in the document, keyed by object ID. + * Output only. The positioned objects in the document, keyed by object ID. Legacy field: Instead, use Document.tabs.documentTab.positionedObjects, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ positionedObjects?: {[key: string]: Schema$PositionedObject} | null; /** @@ -567,13 +596,13 @@ export namespace docs_v1 { */ revisionId?: string | null; /** - * Output only. The suggested changes to the style of the document, keyed by suggestion ID. + * Output only. The suggested changes to the style of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedDocumentStyleChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ suggestedDocumentStyleChanges?: { [key: string]: Schema$SuggestedDocumentStyle; } | null; /** - * Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. + * Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. Legacy field: Instead, use Document.tabs.documentTab.suggestedNamedStylesChanges, which exposes the actual document content from all tabs when the includeTabsContent parameter is set to `true`. If `false` or unset, this field contains information about the first tab in the document. */ suggestedNamedStylesChanges?: { [key: string]: Schema$SuggestedNamedStyles; @@ -582,6 +611,10 @@ export namespace docs_v1 { * Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. */ suggestionsViewMode?: string | null; + /** + * Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.childTabs field. + */ + tabs?: Schema$Tab[]; /** * The title of the document. */ @@ -749,6 +782,63 @@ export namespace docs_v1 { */ useFirstPageHeaderFooterSuggested?: boolean | null; } + /** + * A tab with document contents. + */ + export interface Schema$DocumentTab { + /** + * The main body of the document tab. + */ + body?: Schema$Body; + /** + * The style of the document tab. + */ + documentStyle?: Schema$DocumentStyle; + /** + * The footers in the document tab, keyed by footer ID. + */ + footers?: {[key: string]: Schema$Footer} | null; + /** + * The footnotes in the document tab, keyed by footnote ID. + */ + footnotes?: {[key: string]: Schema$Footnote} | null; + /** + * The headers in the document tab, keyed by header ID. + */ + headers?: {[key: string]: Schema$Header} | null; + /** + * The inline objects in the document tab, keyed by object ID. + */ + inlineObjects?: {[key: string]: Schema$InlineObject} | null; + /** + * The lists in the document tab, keyed by list ID. + */ + lists?: {[key: string]: Schema$List} | null; + /** + * The named ranges in the document tab, keyed by name. + */ + namedRanges?: {[key: string]: Schema$NamedRanges} | null; + /** + * The named styles of the document tab. + */ + namedStyles?: Schema$NamedStyles; + /** + * The positioned objects in the document tab, keyed by object ID. + */ + positionedObjects?: {[key: string]: Schema$PositionedObject} | null; + /** + * The suggested changes to the style of the document tab, keyed by suggestion ID. + */ + suggestedDocumentStyleChanges?: { + [key: string]: Schema$SuggestedDocumentStyle; + } | null; + /** + * The suggested changes to the named styles of the document tab, keyed by suggestion ID. + */ + suggestedNamedStylesChanges?: { + [key: string]: Schema$SuggestedNamedStyles; + } | null; + } /** * The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. */ @@ -905,6 +995,10 @@ export namespace docs_v1 { * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */ segmentId?: string | null; + /** + * The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * A ParagraphElement representing an equation. @@ -989,6 +1083,19 @@ export namespace docs_v1 { */ headerId?: string | null; } + /** + * A reference to a heading in this document. + */ + export interface Schema$HeadingLink { + /** + * The ID of a heading in this document. + */ + id?: string | null; + /** + * The ID of the tab containing this heading. + */ + tabId?: string | null; + } /** * A ParagraphElement representing a horizontal line. */ @@ -1288,13 +1395,25 @@ export namespace docs_v1 { */ export interface Schema$Link { /** - * The ID of a bookmark in this document. + * A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + */ + bookmark?: Schema$BookmarkLink; + /** + * The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. */ bookmarkId?: string | null; /** - * The ID of a heading in this document. + * A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + */ + heading?: Schema$HeadingLink; + /** + * The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. */ headingId?: string | null; + /** + * The ID of a tab in this document. + */ + tabId?: string | null; /** * An external URL. */ @@ -1371,6 +1490,10 @@ export namespace docs_v1 { * The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. */ segmentId?: string | null; + /** + * The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * Merges cells in a Table. @@ -2031,6 +2154,10 @@ export namespace docs_v1 { * The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. */ startIndex?: number | null; + /** + * The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * Replaces all instances of text matching a criteria with replace text. @@ -2044,6 +2171,10 @@ export namespace docs_v1 { * The text that will replace the matched text. */ replaceText?: string | null; + /** + * Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. + */ + tabsCriteria?: Schema$TabsCriteria; } /** * The result of replacing text. @@ -2066,6 +2197,10 @@ export namespace docs_v1 { * The replacement method. */ imageReplaceMethod?: string | null; + /** + * The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + */ + tabId?: string | null; /** * The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field. */ @@ -2083,6 +2218,10 @@ export namespace docs_v1 { * The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. */ namedRangeName?: string | null; + /** + * Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. + */ + tabsCriteria?: Schema$TabsCriteria; /** * Replaces the content of the specified named range(s) with the given text. */ @@ -2676,6 +2815,23 @@ export namespace docs_v1 { */ textStyleSuggestionState?: Schema$TextStyleSuggestionState; } + /** + * A tab in a document. + */ + export interface Schema$Tab { + /** + * The child tabs nested within this tab. + */ + childTabs?: Schema$Tab[]; + /** + * A tab with document contents, like text and images. + */ + documentTab?: Schema$DocumentTab; + /** + * The properties of the tab, like ID and title. + */ + tabProperties?: Schema$TabProperties; + } /** * A StructuralElement representing a table. */ @@ -2997,6 +3153,40 @@ export namespace docs_v1 { */ tableColumnProperties?: Schema$TableColumnProperties[]; } + /** + * Properties of a tab. + */ + export interface Schema$TabProperties { + /** + * The zero-based index of the tab within the parent. + */ + index?: number | null; + /** + * Output only. The depth of the tab within the document. Root-level tabs start at 0. + */ + nestingLevel?: number | null; + /** + * Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + */ + parentTabId?: string | null; + /** + * Output only. The ID of the tab. This field can't be changed. + */ + tabId?: string | null; + /** + * The user-visible name of the tab. + */ + title?: string | null; + } + /** + * A criteria that specifies in which tabs a request executes. + */ + export interface Schema$TabsCriteria { + /** + * The list of tab IDs in which the request executes. + */ + tabIds?: string[] | null; + } /** * A tab stop within a paragraph. */ @@ -3156,6 +3346,10 @@ export namespace docs_v1 { * The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. */ fields?: string | null; + /** + * The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document. + */ + tabId?: string | null; } /** * Update the styling of all paragraphs that overlap with the given range. @@ -3594,6 +3788,10 @@ export namespace docs_v1 { * The ID of the document to retrieve. */ documentId?: string; + /** + * Whether to populate the Document.tabs field instead of the text content fields like `body` and `documentStyle` on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty. + */ + includeTabsContent?: boolean; /** * The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used. */ diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index de14db7290..ff710fad7b 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -5722,6 +5722,10 @@ export namespace documentai_v1 { * The schema of the processor version. Describes the output. */ documentSchema?: Schema$GoogleCloudDocumentaiV1DocumentSchema; + /** + * Output only. Information about Generative AI model-based processor versions. + */ + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo; /** * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ @@ -5785,6 +5789,45 @@ export namespace documentai_v1 { */ replacementProcessorVersion?: string | null; } + /** + * Information about Generative AI model-based processor versions. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo { + /** + * Information for a custom Generative AI model created by the user. + */ + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + /** + * Information for a pretrained Google-managed foundation model. + */ + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; + } + /** + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + /** + * The base processor version ID for the custom model. + */ + baseProcessorVersionId?: string | null; + /** + * The type of custom model created by the user. + */ + customModelType?: string | null; + } + /** + * Information for a pretrained Google-managed foundation model. + */ + export interface Schema$GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + /** + * Whether finetuning is allowed for this base processor version. + */ + finetuningAllowed?: boolean | null; + /** + * The minimum number of labeled documents in the training dataset required for finetuning. + */ + minTrainLabeledDocuments?: number | null; + } /** * Request message for the ProcessDocument method. */ @@ -5797,6 +5840,10 @@ export namespace documentai_v1 { * A raw document on Google Cloud Storage. */ gcsDocument?: Schema$GoogleCloudDocumentaiV1GcsDocument; + /** + * Optional. Option to remove images from the document. + */ + imagelessMode?: boolean | null; /** * An inline document proto. */ diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index ed3c208724..25bbf796c3 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -5679,6 +5679,10 @@ export namespace documentai_v1beta3 { * The schema of the processor version. Describes the output. */ documentSchema?: Schema$GoogleCloudDocumentaiV1beta3DocumentSchema; + /** + * Output only. Information about Generative AI model-based processor versions. + */ + genAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo; /** * Output only. Denotes that this `ProcessorVersion` is managed by Google. */ @@ -5742,6 +5746,45 @@ export namespace documentai_v1beta3 { */ replacementProcessorVersion?: string | null; } + /** + * Information about Generative AI model-based processor versions. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo { + /** + * Information for a custom Generative AI model created by the user. + */ + customGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo; + /** + * Information for a pretrained Google-managed foundation model. + */ + foundationGenAiModelInfo?: Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo; + } + /** + * Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo { + /** + * The base processor version ID for the custom model. + */ + baseProcessorVersionId?: string | null; + /** + * The type of custom model created by the user. + */ + customModelType?: string | null; + } + /** + * Information for a pretrained Google-managed foundation model. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo { + /** + * Whether finetuning is allowed for this base processor version. + */ + finetuningAllowed?: boolean | null; + /** + * The minimum number of labeled documents in the training dataset required for finetuning. + */ + minTrainLabeledDocuments?: number | null; + } /** * Request message for the ProcessDocument method. */ @@ -5758,6 +5801,10 @@ export namespace documentai_v1beta3 { * A raw document on Google Cloud Storage. */ gcsDocument?: Schema$GoogleCloudDocumentaiV1beta3GcsDocument; + /** + * Optional. Option to remove images from the document. + */ + imagelessMode?: boolean | null; /** * An inline document proto. */ diff --git a/src/apis/domains/v1.ts b/src/apis/domains/v1.ts index daf6dbce21..f1565290a0 100644 --- a/src/apis/domains/v1.ts +++ b/src/apis/domains/v1.ts @@ -477,6 +477,10 @@ export namespace domains_v1 { * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. */ export interface Schema$HealthCheckTargets { + /** + * The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + */ + externalEndpoints?: string[] | null; /** * Configuration for internal load balancers to be health checked. */ @@ -1004,6 +1008,10 @@ export namespace domains_v1 { export interface Schema$RRSetRoutingPolicy { geo?: Schema$GeoPolicy; geoPolicy?: Schema$GeoPolicy; + /** + * The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + */ + healthCheck?: string | null; primaryBackup?: Schema$PrimaryBackupPolicy; wrr?: Schema$WrrPolicy; wrrPolicy?: Schema$WrrPolicy; diff --git a/src/apis/domains/v1alpha2.ts b/src/apis/domains/v1alpha2.ts index 966f2cb997..01707e701c 100644 --- a/src/apis/domains/v1alpha2.ts +++ b/src/apis/domains/v1alpha2.ts @@ -477,6 +477,10 @@ export namespace domains_v1alpha2 { * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. */ export interface Schema$HealthCheckTargets { + /** + * The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + */ + externalEndpoints?: string[] | null; /** * Configuration for internal load balancers to be health checked. */ @@ -1008,6 +1012,10 @@ export namespace domains_v1alpha2 { export interface Schema$RRSetRoutingPolicy { geo?: Schema$GeoPolicy; geoPolicy?: Schema$GeoPolicy; + /** + * The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + */ + healthCheck?: string | null; primaryBackup?: Schema$PrimaryBackupPolicy; wrr?: Schema$WrrPolicy; wrrPolicy?: Schema$WrrPolicy; diff --git a/src/apis/domains/v1beta1.ts b/src/apis/domains/v1beta1.ts index 833b3c0665..a5931d289c 100644 --- a/src/apis/domains/v1beta1.ts +++ b/src/apis/domains/v1beta1.ts @@ -477,6 +477,10 @@ export namespace domains_v1beta1 { * HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. */ export interface Schema$HealthCheckTargets { + /** + * The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + */ + externalEndpoints?: string[] | null; /** * Configuration for internal load balancers to be health checked. */ @@ -1004,6 +1008,10 @@ export namespace domains_v1beta1 { export interface Schema$RRSetRoutingPolicy { geo?: Schema$GeoPolicy; geoPolicy?: Schema$GeoPolicy; + /** + * The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks + */ + healthCheck?: string | null; primaryBackup?: Schema$PrimaryBackupPolicy; wrr?: Schema$WrrPolicy; wrrPolicy?: Schema$WrrPolicy; diff --git a/src/apis/domainsrdap/README.md b/src/apis/domainsrdap/README.md index a15641632d..5df08b60e4 100644 --- a/src/apis/domainsrdap/README.md +++ b/src/apis/domainsrdap/README.md @@ -2,7 +2,7 @@ # domainsrdap -> Read-only public API that lets users search for information about domain names. +> ## Installation diff --git a/src/apis/doubleclickbidmanager/v2.ts b/src/apis/doubleclickbidmanager/v2.ts index 0dc2f4122e..c869b09c0f 100644 --- a/src/apis/doubleclickbidmanager/v2.ts +++ b/src/apis/doubleclickbidmanager/v2.ts @@ -125,19 +125,19 @@ export namespace doubleclickbidmanager_v2 { } /** - * Report data range. + * The date range to be reported on. */ export interface Schema$DataRange { /** - * The ending date for the data that is shown in the report. Note, `customEndDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. + * If `CUSTOM_DATES` is assigned to range, this field specifies the end date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. */ customEndDate?: Schema$Date; /** - * The starting data for the data that is shown in the report. Note, `customStartDate` is required if `range` is `CUSTOM_DATES` and ignored otherwise. + * If `CUSTOM_DATES` is assigned to range, this field specifies the starting date for the date range that is reported on. This field is required if using `CUSTOM_DATES` range and will be ignored otherwise. */ customStartDate?: Schema$Date; /** - * Report data range used to generate the report. + * The preset date range to be reported on. If `CUSTOM_DATES` is assigned to this field, fields custom_start_date and custom_end_date must be set to specify the custom date range. */ range?: string | null; } @@ -159,213 +159,213 @@ export namespace doubleclickbidmanager_v2 { year?: number | null; } /** - * Filter used to match traffic data in your report. + * Represents a single filter rule. */ export interface Schema$FilterPair { /** - * Filter type. + * The type of value to filter by. Defined by a [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) value. */ type?: string | null; /** - * Filter value. + * The identifying value to filter by, such as a relevant resource ID. */ value?: string | null; } export interface Schema$ListQueriesResponse { /** - * A token, which can be sent as page_token to retrieve the next page of queries. If this field is omitted, there are no subsequent pages. + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `queries.list` method to retrieve the next page of results. */ nextPageToken?: string | null; /** - * The list of queries. + * The list of queries. This field will be absent if empty. */ queries?: Schema$Query[]; } export interface Schema$ListReportsResponse { /** - * A token, which can be sent as page_token to retrieve the next page of reports. If this field is omitted, there are no subsequent pages. + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `queries.reports.list` method to retrieve the next page of results. */ nextPageToken?: string | null; /** - * Retrieved reports. + * The list of reports. This field will be absent if empty. */ reports?: Schema$Report[]; } /** - * Additional query options. + * Report parameter options. */ export interface Schema$Options { /** - * Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. + * Whether to include data for audience lists specifically targeted by filtered line items or insertion orders. Requires the use of `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` filters. */ includeOnlyTargetedUserLists?: boolean | null; } /** - * Parameters of a query or report. + * Parameters of a generated report. */ export interface Schema$Parameters { /** - * Filters used to match traffic data in your report. + * Filters to limit the scope of reported data. */ filters?: Schema$FilterPair[]; /** - * Data is grouped by the filters listed in this field. + * Dimensions by which to segment and group the data. Defined by [Filter](/bid-manager/reference/rest/v2/filters-metrics#filters) values. */ groupBys?: string[] | null; /** - * Metrics to include as columns in your report. + * Metrics to define the data populating the report. Defined by [Metric](/bid-manager/reference/rest/v2/filters-metrics#metrics) values. */ metrics?: string[] | null; /** - * Additional query options. + * Additional report parameter options. */ options?: Schema$Options; /** - * The type of the report. The type of the report will dictate what dimesions, filters, and metrics can be used. + * The type of the report. The type of the report determines the dimesions, filters, and metrics that can be used. */ type?: string | null; } /** - * Represents a query. + * A single query used to generate a report. */ export interface Schema$Query { /** - * Query metadata. + * The metadata of the query. */ metadata?: Schema$QueryMetadata; /** - * Query parameters. + * The parameters of the report generated by the query. */ params?: Schema$Parameters; /** - * Output only. Query ID. + * Output only. The unique ID of the query. */ queryId?: string | null; /** - * Information on how often and when to run a query. If `ONE_TIME` is set to the frequency field, the query will only be run at the time of creation. + * When and how often the query is scheduled to run. If the frequency field is set to `ONE_TIME`, the query will only run when queries.run is called. */ schedule?: Schema$QuerySchedule; } /** - * Query metadata. + * The metadata of the query. */ export interface Schema$QueryMetadata { /** - * Range of report data. All reports will be based on the same time zone as used by the advertiser. + * The date range the report generated by the query will report on. This date range will be defined by the time zone as used by the advertiser. */ dataRange?: Schema$DataRange; /** - * Format of the generated report. + * The format of the report generated by the query. */ format?: string | null; /** - * Whether to send an email notification when a report is ready. Defaults to false. + * Whether an email notification is sent to the query creator when a report generated by the query is ready. This value is `false` by default. */ sendNotification?: boolean | null; /** - * List of email addresses which are sent email notifications when the report is finished. Separate from send_notification. + * List of additional email addresses with which to share the query. If send_notification is `true`, these email addresses will receive a notification when a report generated by the query is ready. If these email addresses are connected to Display & Video 360 users, the query will be available to them in the Display & Video 360 interface. */ shareEmailAddress?: string[] | null; /** - * Query title. It is used to name the reports generated from this query. + * The display name of the query. This value will be used in the file name of reports generated by the query. */ title?: string | null; } /** - * Information on when and how frequently to run a query. + * Settings on when and how frequently to run a query. */ export interface Schema$QuerySchedule { /** - * Date to periodically run the query until. Not applicable to `ONE_TIME` frequency. + * The date on which to end the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. */ endDate?: Schema$Date; /** - * How often the query is run. + * How frequently to run the query. If set to `ONE_TIME`, the query will only be run when queries.run is called. */ frequency?: string | null; /** - * Canonical timezone code for report generation time. Defaults to `America/New_York`. + * The canonical code for the timezone the query schedule is based on. Scheduled runs are usually conducted in the morning of a given day. Defaults to `America/New_York`. */ nextRunTimezoneCode?: string | null; /** - * When to start running the query. Not applicable to `ONE_TIME` frequency. + * The date on which to begin the scheduled runs. This field is required if frequency is not set to `ONE_TIME`. Otherwise, it will be ignored. */ startDate?: Schema$Date; } /** - * Represents a report. + * A single report generated by its parent report. */ export interface Schema$Report { /** - * Key used to identify a report. + * The key information identifying the report. */ key?: Schema$ReportKey; /** - * Report metadata. + * The metadata of the report. */ metadata?: Schema$ReportMetadata; /** - * Report parameters. + * The parameters of the report. */ params?: Schema$Parameters; } /** - * Key used to identify a report. + * Identifying information of a report. */ export interface Schema$ReportKey { /** - * Output only. Query ID. + * Output only. The unique ID of the query that generated the report. */ queryId?: string | null; /** - * Output only. Report ID. + * Output only. The unique ID of the report. */ reportId?: string | null; } /** - * Report metadata. + * The metadata of a report. */ export interface Schema$ReportMetadata { /** - * Output only. The path to the location in Google Cloud Storage where the report is stored. + * Output only. The location of the generated report file in Google Cloud Storage. This field will be absent if status.state is not `DONE`. */ googleCloudStoragePath?: string | null; /** - * The ending time for the data that is shown in the report. + * The end date of the report data date range. */ reportDataEndDate?: Schema$Date; /** - * The starting time for the data that is shown in the report. + * The start date of the report data date range. */ reportDataStartDate?: Schema$Date; /** - * Report status. + * The status of the report. */ status?: Schema$ReportStatus; } /** - * Report status. + * The status of a report. */ export interface Schema$ReportStatus { /** - * Output only. The time when this report either completed successfully or failed. + * Output only. The timestamp of when report generation finished successfully or in failure. This field will not be set unless state is `DONE` or `FAILED`. */ finishTime?: string | null; /** - * The file type of the report. + * The format of the generated report file. */ format?: string | null; /** - * Output only. The state of the report. + * Output only. The state of the report generation. */ state?: string | null; } /** - * Request to run a stored query to generate a report. + * Details specifying how to run a query. */ export interface Schema$RunQueryRequest { /** - * Report data range used to generate the report. If unspecified, the original parent query's data range is used. + * The date range used by the query to generate the report. If unspecified, the query's original data_range is used. */ dataRange?: Schema$DataRange; } @@ -379,7 +379,7 @@ export namespace doubleclickbidmanager_v2 { } /** - * Creates a query. + * Creates a new query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -464,7 +464,7 @@ export namespace doubleclickbidmanager_v2 { } /** - * Deletes a query as well as the associated reports. + * Deletes an existing query as well as its generated reports. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -726,7 +726,7 @@ export namespace doubleclickbidmanager_v2 { } /** - * Runs a stored query to generate a report. + * Runs an existing query to generate a report. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -822,19 +822,19 @@ export namespace doubleclickbidmanager_v2 { } export interface Params$Resource$Queries$Delete extends StandardParameters { /** - * Required. ID of query to delete. + * Required. The ID of the query to delete. */ queryId?: string; } export interface Params$Resource$Queries$Get extends StandardParameters { /** - * Required. ID of query to retrieve. + * Required. The ID of the query to retrieve. */ queryId?: string; } export interface Params$Resource$Queries$List extends StandardParameters { /** - * Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "metadata.title desc". Sorting is only supported for the following fields: * `queryId` * `metadata.title` + * Field to sort the list by. Accepts the following values: * `queryId` (default) * `metadata.title` The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `queryId desc`. */ orderBy?: string; /** @@ -842,17 +842,17 @@ export namespace doubleclickbidmanager_v2 { */ pageSize?: number; /** - * A page token, received from a previous list call. Provide this to retrieve the subsequent page of queries. + * A token identifying which page of results the server should return. Typically, this is the value of nextPageToken, returned from the previous call to the `queries.list` method. If unspecified, the first page of results is returned. */ pageToken?: string; } export interface Params$Resource$Queries$Run extends StandardParameters { /** - * Required. ID of query to run. + * Required. The ID of the query to run. */ queryId?: string; /** - * Whether the query should be run synchronously. When true, this method will not return until the query has finished running. When false or not specified, this method will return immediately. + * Whether the query should be run synchronously. When `true`, the request won't return until the resulting report has finished running. This parameter is `false` by default. Setting this parameter to `true` is **not recommended**. */ synchronous?: boolean; @@ -958,7 +958,7 @@ export namespace doubleclickbidmanager_v2 { } /** - * Lists reports associated with a query. + * Lists reports generated by the provided query. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1053,18 +1053,18 @@ export namespace doubleclickbidmanager_v2 { export interface Params$Resource$Queries$Reports$Get extends StandardParameters { /** - * Required. ID of the query the report is associated with. + * Required. The ID of the query that generated the report. */ queryId?: string; /** - * Required. ID of the report to retrieve. + * Required. The ID of the query to retrieve. */ reportId?: string; } export interface Params$Resource$Queries$Reports$List extends StandardParameters { /** - * Name of a field used to order results. The default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. For example "key.reportId desc". Sorting is only supported for the following fields: * `key.reportId` + * Field to sort the list by. Accepts the following values: * `key.reportId` (default) The default sorting order is ascending. To specify descending order for a field, add the suffix `desc` to the field name. For example, `key.reportId desc`. */ orderBy?: string; /** @@ -1072,11 +1072,11 @@ export namespace doubleclickbidmanager_v2 { */ pageSize?: number; /** - * A page token, received from a previous list call. Provide this to retrieve the subsequent page of reports. + * A token identifying which page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to the `queries.reports.list` method. If unspecified, the first page of results is returned. */ pageToken?: string; /** - * Required. ID of the query with which the reports are associated. + * Required. The ID of the query that generated the reports. */ queryId?: string; } diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index d73554f2d0..11ee30876c 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -1206,7 +1206,7 @@ export namespace drive_v2 { */ sharingUser?: Schema$User; /** - * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. + * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.insert` requests. */ shortcutDetails?: { targetId?: string; @@ -1226,7 +1226,7 @@ export namespace drive_v2 { */ thumbnail?: {image?: string; mimeType?: string} | null; /** - * Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + * Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. */ thumbnailLink?: string | null; /** @@ -6124,7 +6124,7 @@ export namespace drive_v2 { } export interface Params$Resource$Files$Get extends StandardParameters { /** - * Whether the user is acknowledging the risk of downloading known malware or other abusive files. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. */ acknowledgeAbuse?: boolean; /** @@ -6575,7 +6575,7 @@ export namespace drive_v2 { } export interface Params$Resource$Files$Watch extends StandardParameters { /** - * Whether the user is acknowledging the risk of downloading known malware or other abusive files. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. */ acknowledgeAbuse?: boolean; /** diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index 8c1cc0c0e5..4be9090c3c 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -923,7 +923,7 @@ export namespace drive_v3 { */ sharingUser?: Schema$User; /** - * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. + * Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests. */ shortcutDetails?: { targetId?: string; @@ -947,7 +947,7 @@ export namespace drive_v3 { */ teamDriveId?: string | null; /** - * Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. + * Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request. */ thumbnailLink?: string | null; /** @@ -4778,7 +4778,7 @@ export namespace drive_v3 { } export interface Params$Resource$Files$Get extends StandardParameters { /** - * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. */ acknowledgeAbuse?: boolean; /** @@ -4958,7 +4958,7 @@ export namespace drive_v3 { } export interface Params$Resource$Files$Watch extends StandardParameters { /** - * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. */ acknowledgeAbuse?: boolean; /** @@ -6473,7 +6473,7 @@ export namespace drive_v3 { } export interface Params$Resource$Revisions$Get extends StandardParameters { /** - * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + * Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. */ acknowledgeAbuse?: boolean; /** diff --git a/src/apis/essentialcontacts/v1.ts b/src/apis/essentialcontacts/v1.ts index 00f461e258..3d57ab002a 100644 --- a/src/apis/essentialcontacts/v1.ts +++ b/src/apis/essentialcontacts/v1.ts @@ -166,7 +166,7 @@ export namespace essentialcontacts_v1 { */ validateTime?: string | null; /** - * The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + * Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. */ validationState?: string | null; } diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index e9ad3dcd16..09ddf1d611 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -260,28 +260,11 @@ export namespace file_v1 { * Nfs Export Options. There is a limit of 10 export options per file share. */ nfsExportOptions?: Schema$NfsExportOptions[]; - /** - * Optional. Used to configure performance. - */ - performanceConfig?: Schema$PerformanceConfig; - /** - * Output only. Used for getting performance limits. - */ - performanceLimits?: Schema$PerformanceLimits; /** * The resource name of the backup, in the format `projects/{project_number\}/locations/{location_id\}/backups/{backup_id\}`, that this file share has been restored from. */ sourceBackup?: string | null; } - /** - * Fixed IOPS parameters. - */ - export interface Schema$FixedIOPS { - /** - * Required. Maximum raw read IOPS. - */ - maxReadIops?: string | null; - } /** * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, \}, "labels": { "env": "prod", "foo": "bar" \}, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", \}, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", \} "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", \}, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", \} ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \}, "ncsa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \} \}, "consumer_defined_name": "my-sql-instance1", \} ``` LINT.IfChange */ @@ -556,15 +539,6 @@ export namespace file_v1 { */ tier?: string | null; } - /** - * IOPS per capacity parameters. - */ - export interface Schema$IOPSPerGB { - /** - * Required. Maximum read IOPS per GB. - */ - maxReadIopsPerGb?: string | null; - } /** * ListBackupsResponse is the result of ListBackupsRequest. */ @@ -817,44 +791,6 @@ export namespace file_v1 { */ verb?: string | null; } - /** - * Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. - */ - export interface Schema$PerformanceConfig { - /** - * Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - */ - fixedIops?: Schema$FixedIOPS; - /** - * Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - */ - iopsByCapacity?: boolean | null; - /** - * Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - */ - iopsPerGb?: Schema$IOPSPerGB; - } - /** - * The enforced performance limits, calculated from the instance's performance configuration. - */ - export interface Schema$PerformanceLimits { - /** - * Output only. The max read IOPS. - */ - maxReadIops?: string | null; - /** - * Output only. The max read throughput. - */ - maxReadThroughput?: string | null; - /** - * Output only. The max write IOPS. - */ - maxWriteIops?: string | null; - /** - * Output only. The max write throughput. - */ - maxWriteThroughput?: string | null; - } /** * PromoteReplicaRequest promotes a Filestore standby instance (replica). */ diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index 6269356627..1f3df8f315 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -144,6 +144,10 @@ export namespace file_v1beta1 { * Output only. Amount of bytes that will be downloaded if the backup is restored */ downloadBytes?: string | null; + /** + * Output only. The file system protocol of the source Filestore instance that this backup is created from. + */ + fileSystemProtocol?: string | null; /** * Immutable. KMS key name used for data encryption. */ @@ -269,28 +273,11 @@ export namespace file_v1beta1 { * Nfs Export Options. There is a limit of 10 export options per file share. */ nfsExportOptions?: Schema$NfsExportOptions[]; - /** - * Optional. Used to configure performance. - */ - performanceConfig?: Schema$PerformanceConfig; - /** - * Output only. Used for getting performance limits. - */ - performanceLimits?: Schema$PerformanceLimits; /** * The resource name of the backup, in the format `projects/{project_id\}/locations/{location_id\}/backups/{backup_id\}`, that this file share has been restored from. */ sourceBackup?: string | null; } - /** - * Fixed IOPS parameters. - */ - export interface Schema$FixedIOPS { - /** - * Required. Maximum raw read IOPS. - */ - maxReadIops?: string | null; - } /** * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { "name": "projects/123456/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, \}, "labels": { "env": "prod", "foo": "bar" \}, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", \}, "maintenance_policy_names": { "UpdatePolicy": "projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy", \} "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", \}, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", \} ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \}, "ncsa_rollout": { "start_time": { "seconds": 1526406431, \}, "end_time": { "seconds": 1535406431, \}, \} \}, "consumer_defined_name": "my-sql-instance1", \} ``` LINT.IfChange */ @@ -593,15 +580,6 @@ export namespace file_v1beta1 { */ tier?: string | null; } - /** - * IOPS per capacity parameters. - */ - export interface Schema$IOPSPerGB { - /** - * Required. Maximum read IOPS per GB. - */ - maxReadIopsPerGb?: string | null; - } /** * ListBackupsResponse is the result of ListBackupsRequest. */ @@ -888,44 +866,6 @@ export namespace file_v1beta1 { */ verb?: string | null; } - /** - * Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. - */ - export interface Schema$PerformanceConfig { - /** - * Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - */ - fixedIops?: Schema$FixedIOPS; - /** - * Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - */ - iopsByCapacity?: boolean | null; - /** - * Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - */ - iopsPerGb?: Schema$IOPSPerGB; - } - /** - * The enforced performance limits, calculated from the instance's performance configuration. - */ - export interface Schema$PerformanceLimits { - /** - * Output only. The max read IOPS. - */ - maxReadIops?: string | null; - /** - * Output only. The max read throughput. - */ - maxReadThroughput?: string | null; - /** - * Output only. The max write IOPS. - */ - maxWriteIops?: string | null; - /** - * Output only. The max write throughput. - */ - maxWriteThroughput?: string | null; - } /** * PromoteReplicaRequest promotes a Filestore standby instance (replica). */ diff --git a/src/apis/firebaseappcheck/v1.ts b/src/apis/firebaseappcheck/v1.ts index cb4055dd75..4f16954c3f 100644 --- a/src/apis/firebaseappcheck/v1.ts +++ b/src/apis/firebaseappcheck/v1.ts @@ -208,6 +208,28 @@ export namespace firebaseappcheck_v1 { */ configs?: Schema$GoogleFirebaseAppcheckV1SafetyNetConfig[]; } + /** + * Request message for the BatchUpdateResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest { + /** + * Required. The request messages specifying the ResourcePolicy objects to update. A maximum of 100 objects can be updated in a batch. + */ + requests?: Schema$GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest[]; + /** + * Optional. A comma-separated list of names of fields in the ResourcePolicy objects to update. Example: `enforcement_mode`. If this field is present, the `update_mask` field in the UpdateResourcePolicyRequest messages must all match this field, or the entire batch fails and no updates will be committed. + */ + updateMask?: string | null; + } + /** + * Response message for the BatchUpdateResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesResponse { + /** + * ResourcePolicy objects after the updates have been applied. + */ + resourcePolicies?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy[]; + } /** * Request message for the BatchUpdateServices method. */ @@ -465,6 +487,19 @@ export namespace firebaseappcheck_v1 { */ nextPageToken?: string | null; } + /** + * Response message for the ListResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1ListResourcePoliciesResponse { + /** + * If the result list is too large to fit in a single response, then a token is returned. If the string is empty or omitted, then this response is the last page of results. This token can be used in a subsequent call to ListResourcePolicies to find the next group of ResourcePolicy objects. Page tokens are short-lived and should not be persisted. + */ + nextPageToken?: string | null; + /** + * The ResourcePolicy objects retrieved. + */ + resourcePolicies?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy[]; + } /** * Response message for the ListServices method. */ @@ -567,6 +602,31 @@ export namespace firebaseappcheck_v1 { */ tokenTtl?: string | null; } + /** + * App Check enforcement policy for a specific resource of a Firebase service supported by App Check. Note that this policy will override the service-level configuration. + */ + export interface Schema$GoogleFirebaseAppcheckV1ResourcePolicy { + /** + * Required. The App Check enforcement mode for this resource. This will override the EnforcementMode setting on the service. + */ + enforcementMode?: string | null; + /** + * This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. This etag is strongly validated as defined by RFC 7232. + */ + etag?: string | null; + /** + * Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. + */ + name?: string | null; + /** + * Required. Service specific name of the resource object to which this policy applies, in the format: * `//oauth2.googleapis.com/projects/{project_number\}/oauthClients/{oauth_client_id\}` (Google Identity for iOS) Note that the resource must belong to the service specified in the `name` and be from the same project as this policy, but the resource is allowed to be missing at the time of creation of this policy; in that case, we make a best-effort attempt at respecting this policy, but it may not have any effect until the resource is fully created. + */ + targetResource?: string | null; + /** + * Output only. Timestamp when this resource policy configuration object was most recently updated. + */ + updateTime?: string | null; + } /** * An app's SafetyNet configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangeSafetyNetToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by SafetyNet; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v11/projects.androidApps.sha/create). */ @@ -593,6 +653,19 @@ export namespace firebaseappcheck_v1 { */ name?: string | null; } + /** + * Request message for the UpdateResourcePolicy method as well as an individual update message for the BatchUpdateResourcePolicies method. + */ + export interface Schema$GoogleFirebaseAppcheckV1UpdateResourcePolicyRequest { + /** + * Required. The ResourcePolicy to update. The ResourcePolicy's `name` field is used to identify the ResourcePolicy to be updated, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + resourcePolicy?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy; + /** + * Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`. + */ + updateMask?: string | null; + } /** * Request message for the UpdateService method as well as an individual update message for the BatchUpdateServices method. */ @@ -4944,8 +5017,12 @@ export namespace firebaseappcheck_v1 { export class Resource$Projects$Services { context: APIRequestContext; + resourcePolicies: Resource$Projects$Services$Resourcepolicies; constructor(context: APIRequestContext) { this.context = context; + this.resourcePolicies = new Resource$Projects$Services$Resourcepolicies( + this.context + ); } /** @@ -5385,4 +5462,664 @@ export namespace firebaseappcheck_v1 { */ requestBody?: Schema$GoogleFirebaseAppcheckV1Service; } + + export class Resource$Projects$Services$Resourcepolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Atomically updates the specified ResourcePolicy configurations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options: StreamMethodOptions + ): GaxiosPromise; + batchUpdate( + params?: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options?: MethodOptions + ): GaxiosPromise; + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchUpdate( + params: Params$Resource$Projects$Services$Resourcepolicies$Batchupdate, + callback: BodyResponseCallback + ): void; + batchUpdate( + callback: BodyResponseCallback + ): void; + batchUpdate( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Batchupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Batchupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Services$Resourcepolicies$Batchupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/resourcePolicies:batchUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates the specified ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Services$Resourcepolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Services$Resourcepolicies$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Services$Resourcepolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/resourcePolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes the specified ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Services$Resourcepolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Services$Resourcepolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the requested ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Services$Resourcepolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Services$Resourcepolicies$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Services$Resourcepolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists all ResourcePolicy configurations for the specified project and service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Services$Resourcepolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Services$Resourcepolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Services$Resourcepolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/resourcePolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the specified ResourcePolicy configuration. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Services$Resourcepolicies$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Services$Resourcepolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Services$Resourcepolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Services$Resourcepolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebaseappcheck.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Services$Resourcepolicies$Batchupdate + extends StandardParameters { + /** + * Required. The parent service name, in the format ``` projects/{project_number\}/services/{service_id\} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppcheckV1BatchUpdateResourcePoliciesRequest; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Create + extends StandardParameters { + /** + * Required. The relative resource name of the parent Service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Delete + extends StandardParameters { + /** + * The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232. + */ + etag?: string; + /** + * Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` + */ + name?: string; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Get + extends StandardParameters { + /** + * Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + name?: string; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$List + extends StandardParameters { + /** + * Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` * `enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` + */ + filter?: string; + /** + * The maximum number of ResourcePolicy objects to return in the response. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. + */ + pageSize?: number; + /** + * Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined. + */ + pageToken?: string; + /** + * Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number\}/services/{service_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) + */ + parent?: string; + } + export interface Params$Resource$Projects$Services$Resourcepolicies$Patch + extends StandardParameters { + /** + * Required. Identifier. The relative name of the resource policy object, in the format: ``` projects/{project_number\}/services/{service_id\}/resourcePolicies/{resource_policy_id\} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID. + */ + name?: string; + /** + * Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleFirebaseAppcheckV1ResourcePolicy; + } } diff --git a/src/apis/firebaseappdistribution/v1alpha.ts b/src/apis/firebaseappdistribution/v1alpha.ts index 126e6496e1..e593203bcc 100644 --- a/src/apis/firebaseappdistribution/v1alpha.ts +++ b/src/apis/firebaseappdistribution/v1alpha.ts @@ -126,6 +126,13 @@ export namespace firebaseappdistribution_v1alpha { } } + /** + * Point for describing bounding boxes tap locations Top left is 0,0 + */ + export interface Schema$AndroidxCrawlerOutputPoint { + xCoordinate?: number | null; + yCoordinate?: number | null; + } /** * App bundle test certificate */ @@ -154,12 +161,12 @@ export namespace firebaseappdistribution_v1alpha { /** * Required. Steps to be accomplished by the AI */ - steps?: Schema$GoogleFirebaseAppdistroV1alphaAiInstructionsStep[]; + steps?: Schema$GoogleFirebaseAppdistroV1alphaAiStep[]; } /** * A step to be accomplished by the AI */ - export interface Schema$GoogleFirebaseAppdistroV1alphaAiInstructionsStep { + export interface Schema$GoogleFirebaseAppdistroV1alphaAiStep { /** * An assertion to be checked by the AI */ @@ -169,6 +176,27 @@ export namespace firebaseappdistribution_v1alpha { */ goal?: string | null; } + /** + * Captures the results of an AiStep + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaAiStepResult { + /** + * Output only. Details for an assertion step. + */ + assertionDetails?: Schema$GoogleFirebaseAppdistroV1alphaAssertionDetails; + /** + * Output only. Details for a goal step. + */ + goalDetails?: Schema$GoogleFirebaseAppdistroV1alphaGoalDetails; + /** + * Output only. The current state of the step + */ + state?: string | null; + /** + * Required. The step performed by the AI + */ + step?: Schema$GoogleFirebaseAppdistroV1alphaAiStep; + } export interface Schema$GoogleFirebaseAppdistroV1alphaApp { /** * App bundle test certificate generated for the app. @@ -212,6 +240,23 @@ export namespace firebaseappdistribution_v1alpha { */ stackTrace?: string | null; } + /** + * Details for an assertion step. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaAssertionDetails { + /** + * Output only. An explanation justifying the assertion result. + */ + explanation?: string | null; + /** + * Output only. The result of the assertion. + */ + result?: boolean | null; + /** + * Output only. The screenshot used in the context of this assertion. + */ + screenshot?: Schema$GoogleFirebaseAppdistroV1alphaScreenshot; + } export interface Schema$GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest { /** * The actual release notes body from the user @@ -219,10 +264,27 @@ export namespace firebaseappdistribution_v1alpha { releaseNotes?: Schema$GoogleFirebaseAppdistroV1alphaReleaseNotes; } export interface Schema$GoogleFirebaseAppdistroV1alphaCreateReleaseNotesResponse {} + /** + * A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaDeviceAction { + /** + * Output only. A short description of the high level action taken by the AI agent. + */ + description?: string | null; + /** + * Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. + */ + deviceInteractions?: Schema$GoogleFirebaseAppdistroV1alphaDeviceInteraction[]; + } /** * The results of running an automated test on a particular device. */ export interface Schema$GoogleFirebaseAppdistroV1alphaDeviceExecution { + /** + * Output only. Results of the AI steps if passed in + */ + aiStepResults?: Schema$GoogleFirebaseAppdistroV1alphaAiStepResult[]; /** * Output only. An app crash, if any occurred during the test. */ @@ -264,6 +326,53 @@ export namespace firebaseappdistribution_v1alpha { */ videoUri?: string | null; } + /** + * An interaction with the device, such as a tap, text entry, wait, etc. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaDeviceInteraction { + /** + * Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. + */ + screenshot?: Schema$GoogleFirebaseAppdistroV1alphaScreenshot; + /** + * Output only. A swipe action. + */ + swipe?: Schema$GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe; + /** + * Output only. A tap action. + */ + tap?: Schema$AndroidxCrawlerOutputPoint; + /** + * Output only. Text entered for a text entry action. + */ + textInput?: string | null; + /** + * Output only. A wait action. + */ + wait?: Schema$GoogleFirebaseAppdistroV1alphaDeviceInteractionWait; + } + /** + * A swipe action. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe { + /** + * Output only. The end point of the swipe. + */ + end?: Schema$AndroidxCrawlerOutputPoint; + /** + * Output only. The start point of the swipe. + */ + start?: Schema$AndroidxCrawlerOutputPoint; + } + /** + * A wait action. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaDeviceInteractionWait { + /** + * Output only. The duration of the wait. + */ + duration?: string | null; + } export interface Schema$GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest { /** * Optional. Ignored. Used to be build version of the app release if an instance identifier was provided for the release_id. @@ -319,6 +428,32 @@ export namespace firebaseappdistribution_v1alpha { */ status?: string | null; } + /** + * An action taken by the AI agent while attempting to accomplish a goal. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaGoalAction { + /** + * Output only. A high level action taken by the AI on the device. + */ + deviceAction?: Schema$GoogleFirebaseAppdistroV1alphaDeviceAction; + /** + * Output only. An explanation justifying why the action was taken. + */ + explanation?: string | null; + /** + * Output only. An action taken by the AI to end the goal. + */ + terminalAction?: Schema$GoogleFirebaseAppdistroV1alphaTerminalAction; + } + /** + * Details for a goal step. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaGoalDetails { + /** + * Output only. The actions taken by the AI while attempting to accomplish the goal. + */ + goalActions?: Schema$GoogleFirebaseAppdistroV1alphaGoalAction[]; + } export interface Schema$GoogleFirebaseAppdistroV1alphaJwt { token?: string | null; } @@ -427,7 +562,7 @@ export namespace firebaseappdistribution_v1alpha { */ export interface Schema$GoogleFirebaseAppdistroV1alphaReleaseTest { /** - * Optional. Input only. Instructions for AI driven test. Input only. + * Optional. Instructions for AI driven test. */ aiInstructions?: Schema$GoogleFirebaseAppdistroV1alphaAiInstructions; /** @@ -481,6 +616,36 @@ export namespace firebaseappdistribution_v1alpha { */ mainActivityCrawlTimedOut?: boolean | null; } + /** + * A device screenshot taken during a test. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaScreenshot { + /** + * Output only. The height of the screenshot, in pixels. + */ + height?: number | null; + /** + * Output only. The URI of the screenshot. + */ + uri?: string | null; + /** + * Output only. The width of the screenshot, in pixels. + */ + width?: number | null; + } + /** + * An action taken by the AI to end the goal. + */ + export interface Schema$GoogleFirebaseAppdistroV1alphaTerminalAction { + /** + * Output only. The reason why this goal was ended. + */ + reason?: string | null; + /** + * Output only. The screenshot used in the context of this terminal action. + */ + screenshot?: Schema$GoogleFirebaseAppdistroV1alphaScreenshot; + } /** * Configuration for automated tests */ diff --git a/src/apis/firebaseml/v2beta.ts b/src/apis/firebaseml/v2beta.ts index d078af478c..3b12bbfacd 100644 --- a/src/apis/firebaseml/v2beta.ts +++ b/src/apis/firebaseml/v2beta.ts @@ -158,6 +158,10 @@ export namespace firebaseml_v2beta { * A response candidate generated from the model. */ export interface Schema$GoogleCloudAiplatformV1beta1Candidate { + /** + * Output only. Average log probability score of the candidate. + */ + avgLogprobs?: number | null; /** * Output only. Source attribution of the generated content. */ @@ -243,17 +247,25 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1CountTokensRequest { /** - * Required. Input content. + * Optional. Input content. */ contents?: Schema$GoogleCloudAiplatformV1beta1Content[]; /** - * Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + * Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. */ instances?: any[] | null; /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` */ model?: string | null; + /** + * Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + */ + systemInstruction?: Schema$GoogleCloudAiplatformV1beta1Content; + /** + * Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + */ + tools?: Schema$GoogleCloudAiplatformV1beta1Tool[]; } /** * Response message for PredictionService.CountTokens. @@ -417,7 +429,7 @@ export namespace firebaseml_v2beta { */ candidatesTokenCount?: number | null; /** - * Number of tokens in the request. + * Number of tokens in the request. When `cached_content` is set, this is still the total effective prompt size meaning this includes the number of tokens in the cached content. */ promptTokenCount?: number | null; totalTokenCount?: number | null; @@ -450,6 +462,14 @@ export namespace firebaseml_v2beta { * Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response. */ responseSchema?: Schema$GoogleCloudAiplatformV1beta1Schema; + /** + * Optional. Routing configuration. + */ + routingConfig?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig; + /** + * Optional. Seed. + */ + seed?: number | null; /** * Optional. Stop sequences. */ @@ -468,56 +488,40 @@ export namespace firebaseml_v2beta { topP?: number | null; } /** - * Tool to retrieve public web data for grounding, powered by Google. - */ - export interface Schema$GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {} - /** - * Grounding attribution. + * The configuration for routing the request to a specific model. */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingAttribution { - /** - * Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - */ - confidenceScore?: number | null; + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig { /** - * Optional. Attribution from context retrieved by the retrieval tools. + * Automated routing. */ - retrievedContext?: Schema$GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext; + autoMode?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode; /** - * Output only. Segment of the content this attribution belongs to. + * Manual routing. */ - segment?: Schema$GoogleCloudAiplatformV1beta1Segment; - /** - * Optional. Attribution from the web. - */ - web?: Schema$GoogleCloudAiplatformV1beta1GroundingAttributionWeb; + manualMode?: Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode; } /** - * Attribution from context retrieved by the retrieval tools. + * When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext { - /** - * Output only. Title of the attribution. - */ - title?: string | null; + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode { /** - * Output only. URI reference of the attribution. + * The model routing preference. */ - uri?: string | null; + modelRoutingPreference?: string | null; } /** - * Attribution from the web. + * When manual routing is set, the specified model will be used directly. */ - export interface Schema$GoogleCloudAiplatformV1beta1GroundingAttributionWeb { + export interface Schema$GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode { /** - * Output only. Title of the attribution. + * The model name to use. Only the public LLM models are accepted. e.g. 'gemini-1.5-pro-001'. */ - title?: string | null; - /** - * Output only. URI reference of the attribution. - */ - uri?: string | null; + modelName?: string | null; } + /** + * Tool to retrieve public web data for grounding, powered by Google. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GoogleSearchRetrieval {} /** * Grounding chunk. */ @@ -561,10 +565,6 @@ export namespace firebaseml_v2beta { * Metadata returned to client when grounding is enabled. */ export interface Schema$GoogleCloudAiplatformV1beta1GroundingMetadata { - /** - * Optional. List of grounding attributions. - */ - groundingAttributions?: Schema$GoogleCloudAiplatformV1beta1GroundingAttribution[]; /** * List of supporting references retrieved from specified grounding source. */ @@ -637,7 +637,7 @@ export namespace firebaseml_v2beta { */ export interface Schema$GoogleCloudAiplatformV1beta1Retrieval { /** - * Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + * Optional. Deprecated. This option is no longer supported. */ disableAttribution?: boolean | null; /** @@ -843,11 +843,11 @@ export namespace firebaseml_v2beta { functionCallingConfig?: Schema$GoogleCloudAiplatformV1beta1FunctionCallingConfig; } /** - * Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation + * Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/products/agent-builder */ export interface Schema$GoogleCloudAiplatformV1beta1VertexAISearch { /** - * Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` + * Required. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project\}/locations/{location\}/collections/{collection\}/dataStores/{dataStore\}` */ datastore?: string | null; } @@ -1256,7 +1256,7 @@ export namespace firebaseml_v2beta { export interface Params$Resource$Projects$Locations$Publishers$Models$Generatecontent extends StandardParameters { /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ model?: string; @@ -1268,7 +1268,7 @@ export namespace firebaseml_v2beta { export interface Params$Resource$Projects$Locations$Publishers$Models$Streamgeneratecontent extends StandardParameters { /** - * Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project\}/locations/{location\}/publishers/x/models/x` + * Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: `projects/{project\}/locations/{location\}/publishers/x/models/x` Tuned model endpoint format: `projects/{project\}/locations/{location\}/endpoints/{endpoint\}` */ model?: string; diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index adfcc93ff1..4e2032acd8 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -384,7 +384,7 @@ export namespace firestore_v1 { updateTime?: string | null; } /** - * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. For PipelineQueryTargets, `document` will be in the new pipeline format, For a Listen stream with both QueryTargets and PipelineQueryTargets present, if a document matches both types of queries, then a separate DocumentChange messages will be sent out one for each set. + * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. */ export interface Schema$DocumentChange { /** @@ -606,7 +606,7 @@ export namespace firestore_v1 { unaryFilter?: Schema$UnaryFilter; } /** - * Nearest Neighbors search config. + * Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. */ export interface Schema$FindNearest { /** @@ -676,7 +676,7 @@ export namespace firestore_v1 { */ name?: string | null; /** - * At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + * At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. */ retention?: string | null; /** @@ -756,14 +756,18 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1CreateDatabaseMetadata {} /** - * Represents a recurring schedule that runs every day. The time zone is UTC. + * The configuration options for using CMEK (Customer Managed Encryption Key) encryption. */ - export interface Schema$GoogleFirestoreAdminV1DailyRecurrence { + export interface Schema$GoogleFirestoreAdminV1CustomerManagedEncryptionOptions { /** - * Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. + * Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`. */ - time?: Schema$TimeOfDay; + kmsKeyName?: string | null; } + /** + * Represents a recurring schedule that runs every day. The time zone is UTC. + */ + export interface Schema$GoogleFirestoreAdminV1DailyRecurrence {} /** * A Cloud Firestore Database. */ @@ -841,6 +845,23 @@ export namespace firestore_v1 { * Metadata related to the delete database operation. */ export interface Schema$GoogleFirestoreAdminV1DeleteDatabaseMetadata {} + /** + * Encryption configuration for a new database being created from another source. The source could be a Backup or a DatabaseSnapshot. + */ + export interface Schema$GoogleFirestoreAdminV1EncryptionConfig { + /** + * Use Customer Managed Encryption Keys (CMEK) for encryption. + */ + customerManagedEncryption?: Schema$GoogleFirestoreAdminV1CustomerManagedEncryptionOptions; + /** + * Use Google default encryption. + */ + googleDefaultEncryption?: Schema$GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions; + /** + * The database will use the same encryption configuration as the source. + */ + useSourceEncryption?: Schema$GoogleFirestoreAdminV1SourceEncryptionOptions; + } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments. */ @@ -970,6 +991,10 @@ export namespace firestore_v1 { * An index that stores vectors in a flat data structure, and supports exhaustive search. */ export interface Schema$GoogleFirestoreAdminV1FlatIndex {} + /** + * The configuration options for using Google default encryption. + */ + export interface Schema$GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions {} /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. */ @@ -1245,7 +1270,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1RestoreDatabaseRequest { /** - * Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id\}/locations/{location\}/backups/{backup\}` + * Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id\}/locations/{location\}/backups/{backup\}` */ backup?: string | null; /** @@ -1253,18 +1278,14 @@ export namespace firestore_v1 { */ databaseId?: string | null; /** - * Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`. - */ - kmsKeyName?: string | null; - /** - * The restored database will use the same encryption configuration as the backup. This is the default option when no `encryption_config` is specified. + * Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption. */ - useBackupEncryption?: Schema$Empty; - /** - * Use Google default encryption. - */ - useGoogleDefaultEncryption?: Schema$Empty; + encryptionConfig?: Schema$GoogleFirestoreAdminV1EncryptionConfig; } + /** + * The configuration options for using the same encryption method as the source. + */ + export interface Schema$GoogleFirestoreAdminV1SourceEncryptionOptions {} /** * Backup specific statistics. */ @@ -1325,10 +1346,6 @@ export namespace firestore_v1 { * The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. */ day?: string | null; - /** - * Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - */ - time?: Schema$TimeOfDay; } /** * The request message for Operations.CancelOperation. @@ -1877,27 +1894,6 @@ export namespace firestore_v1 { */ targetIds?: number[] | null; } - /** - * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. - */ - export interface Schema$TimeOfDay { - /** - * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - */ - hours?: number | null; - /** - * Minutes of hour of day. Must be from 0 to 59. - */ - minutes?: number | null; - /** - * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - */ - nanos?: number | null; - /** - * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - */ - seconds?: number | null; - } /** * Options for creating a new transaction. */ diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 62e775f3c8..c20edd5de7 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -384,7 +384,7 @@ export namespace firestore_v1beta1 { updateTime?: string | null; } /** - * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. For PipelineQueryTargets, `document` will be in the new pipeline format, For a Listen stream with both QueryTargets and PipelineQueryTargets present, if a document matches both types of queries, then a separate DocumentChange messages will be sent out one for each set. + * A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected. */ export interface Schema$DocumentChange { /** @@ -606,7 +606,7 @@ export namespace firestore_v1beta1 { unaryFilter?: Schema$UnaryFilter; } /** - * Nearest Neighbors search config. + * Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. */ export interface Schema$FindNearest { /** diff --git a/src/apis/games/v1.ts b/src/apis/games/v1.ts index de323dc1b4..bdacf9392d 100644 --- a/src/apis/games/v1.ts +++ b/src/apis/games/v1.ts @@ -716,7 +716,7 @@ export namespace games_v1 { /** * Recall token data. */ - token?: Schema$RecallToken[]; + recallToken?: Schema$RecallToken; } /** * The payload to request to increment an achievement. @@ -1535,7 +1535,7 @@ export namespace games_v1 { /** * The recall token associated with the requested PGS Player principal. It can be unset if there is no recall token associated with the requested principal. */ - token?: Schema$RecallToken; + gamePlayerToken?: Schema$GamePlayerToken; } /** * A list of recall token data returned from the RetrieveGamesPlayerTokens RPC @@ -1544,7 +1544,7 @@ export namespace games_v1 { /** * The requested applications along with the recall tokens for the player. If the player does not have recall tokens for an application, that application is not included in the response. */ - applicationRecallTokens?: Schema$GamePlayerToken[]; + gamePlayerTokens?: Schema$GamePlayerToken[]; } /** * Response for the RetrievePlayerTokens RPC diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index 9f04512f3c..e98cc7c033 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -604,7 +604,7 @@ export namespace gkebackup_v1 { */ export interface Schema$GroupKind { /** - * Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group + * Optional. API group string of a Kubernetes resource, e.g. "apiextensions.k8s.io", "storage.k8s.io", etc. Note: use empty string for core API group. */ resourceGroup?: string | null; /** @@ -776,11 +776,11 @@ export namespace gkebackup_v1 { namespacedNames?: Schema$NamespacedName[]; } /** - * A list of Kubernetes Namespaces + * A list of Kubernetes Namespaces. */ export interface Schema$Namespaces { /** - * Optional. A list of Kubernetes Namespaces + * Optional. A list of Kubernetes Namespaces. */ namespaces?: string[] | null; } @@ -905,7 +905,7 @@ export namespace gkebackup_v1 { */ etag?: string | null; /** - * Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified, and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. + * Optional. Immutable. Filters resources for `Restore`. If not specified, the scope of the restore will remain the same as defined in the `RestorePlan`. If this is specified and no resources are matched by the `inclusion_filters` or everyting is excluded by the `exclusion_filters`, nothing will be restored. This filter can only be specified if the value of namespaced_resource_restore_mode is set to `MERGE_SKIP_ON_CONFLICT`, `MERGE_REPLACE_VOLUME_ON_CONFLICT` or `MERGE_REPLACE_ON_CONFLICT`. */ filter?: Schema$Filter; /** diff --git a/src/apis/gkehub/index.ts b/src/apis/gkehub/index.ts index 39c9d7a117..81dce29bee 100644 --- a/src/apis/gkehub/index.ts +++ b/src/apis/gkehub/index.ts @@ -20,6 +20,7 @@ import {gkehub_v1alpha2} from './v1alpha2'; import {gkehub_v1beta} from './v1beta'; import {gkehub_v1beta1} from './v1beta1'; import {gkehub_v2alpha} from './v2alpha'; +import {gkehub_v2beta} from './v2beta'; export const VERSIONS = { v1: gkehub_v1.Gkehub, @@ -28,6 +29,7 @@ export const VERSIONS = { v1beta: gkehub_v1beta.Gkehub, v1beta1: gkehub_v1beta1.Gkehub, v2alpha: gkehub_v2alpha.Gkehub, + v2beta: gkehub_v2beta.Gkehub, }; export function gkehub(version: 'v1'): gkehub_v1.Gkehub; @@ -44,6 +46,8 @@ export function gkehub(version: 'v1beta1'): gkehub_v1beta1.Gkehub; export function gkehub(options: gkehub_v1beta1.Options): gkehub_v1beta1.Gkehub; export function gkehub(version: 'v2alpha'): gkehub_v2alpha.Gkehub; export function gkehub(options: gkehub_v2alpha.Options): gkehub_v2alpha.Gkehub; +export function gkehub(version: 'v2beta'): gkehub_v2beta.Gkehub; +export function gkehub(options: gkehub_v2beta.Options): gkehub_v2beta.Gkehub; export function gkehub< T = | gkehub_v1.Gkehub @@ -51,7 +55,8 @@ export function gkehub< | gkehub_v1alpha2.Gkehub | gkehub_v1beta.Gkehub | gkehub_v1beta1.Gkehub - | gkehub_v2alpha.Gkehub, + | gkehub_v2alpha.Gkehub + | gkehub_v2beta.Gkehub, >( this: GoogleConfigurable, versionOrOptions: @@ -67,6 +72,8 @@ export function gkehub< | gkehub_v1beta1.Options | 'v2alpha' | gkehub_v2alpha.Options + | 'v2beta' + | gkehub_v2beta.Options ) { return getAPI('gkehub', versionOrOptions, VERSIONS, this); } @@ -79,6 +86,7 @@ export {gkehub_v1alpha2}; export {gkehub_v1beta}; export {gkehub_v1beta1}; export {gkehub_v2alpha}; +export {gkehub_v2beta}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index 25baf1248a..9cff3f824c 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -472,6 +472,25 @@ export namespace gkehub_v1 { */ policycontroller?: Schema$PolicyControllerMembershipSpec; } + /** + * CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. + */ + export interface Schema$CompliancePostureConfig { + /** + * List of enabled compliance standards. + */ + complianceStandards?: Schema$ComplianceStandard[]; + /** + * Defines the enablement mode for Compliance Posture. + */ + mode?: string | null; + } + export interface Schema$ComplianceStandard { + /** + * Name of the compliance standard. + */ + standard?: string | null; + } /** * Configuration for Config Sync */ @@ -525,10 +544,18 @@ export namespace gkehub_v1 { * Deployment state of the monitor pod */ monitor?: string | null; + /** + * Deployment state of otel-collector + */ + otelCollector?: string | null; /** * Deployment state of reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Deployment state of resource-group-controller-manager + */ + resourceGroupControllerManager?: string | null; /** * Deployment state of root-reconciler */ @@ -585,7 +612,7 @@ export namespace gkehub_v1 { */ export interface Schema$ConfigManagementConfigSyncVersion { /** - * Version of the deployed admission_webhook pod + * Version of the deployed admission-webhook pod */ admissionWebhook?: string | null; /** @@ -600,10 +627,18 @@ export namespace gkehub_v1 { * Version of the deployed monitor pod */ monitor?: string | null; + /** + * Version of the deployed otel-collector pod + */ + otelCollector?: string | null; /** * Version of the deployed reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Version of the deployed resource-group-controller-manager pod + */ + resourceGroupControllerManager?: string | null; /** * Version of the deployed reconciler container in root-reconciler pod */ @@ -791,7 +826,7 @@ export namespace gkehub_v1 { */ management?: string | null; /** - * Policy Controller configuration for the cluster. + * Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. */ policyController?: Schema$ConfigManagementPolicyController; /** @@ -1039,6 +1074,10 @@ export namespace gkehub_v1 { * Optional. Enable/Disable binary authorization features for the cluster. */ binaryAuthorizationConfig?: Schema$BinaryAuthorizationConfig; + /** + * Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + */ + compliancePostureConfig?: Schema$CompliancePostureConfig; /** * Enable/Disable Security Posture features for the cluster. */ @@ -1130,6 +1169,10 @@ export namespace gkehub_v1 { * Output only. The Hub-wide Feature state. */ state?: Schema$CommonFeatureState; + /** + * Output only. List of locations that could not be reached while fetching this feature. + */ + unreachable?: string[] | null; /** * Output only. When the Feature resource was last updated. */ @@ -1320,6 +1363,15 @@ export namespace gkehub_v1 { */ manifest?: Schema$ConnectAgentResource[]; } + /** + * Response for GenerateRBACRoleBindingYAML. + */ + export interface Schema$GenerateMembershipRBACRoleBindingYAMLResponse { + /** + * a yaml text blob including the RBAC policies. + */ + roleBindingsYaml?: string | null; + } /** * GkeCluster contains information specific to GKE clusters. */ @@ -2793,7 +2845,7 @@ export namespace gkehub_v1 { */ controlPlane?: string | null; /** - * Enables automatic Service Mesh management. + * Optional. Enables automatic Service Mesh management. */ management?: string | null; } @@ -4008,6 +4060,10 @@ export namespace gkehub_v1 { * Required. The Feature resource name in the format `projects/x/locations/x/features/x` */ name?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Features$Getiampolicy extends StandardParameters { @@ -4042,6 +4098,10 @@ export namespace gkehub_v1 { * Required. The parent (project and location) where the Features will be listed. Specified in the format `projects/x/locations/x`. */ parent?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Features$Patch extends StandardParameters { @@ -6090,6 +6150,365 @@ export namespace gkehub_v1 { this.context = context; } + /** + * Creates a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/rbacrolebindings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options: StreamMethodOptions + ): GaxiosPromise; + generateMembershipRBACRoleBindingYAML( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options?: MethodOptions + ): GaxiosPromise; + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml, + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + callback: BodyResponseCallback + ): void; + generateMembershipRBACRoleBindingYAML( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/{+parent}/rbacrolebindings:generateMembershipRBACRoleBindingYAML' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Returns the details of a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists all Membership RBACRoleBindings. * @@ -6187,8 +6606,140 @@ export namespace gkehub_v1 { ); } } + + /** + * Updates a Membership RBACRoleBinding. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Create + extends StandardParameters { + /** + * Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/x/locations/x/memberships/x`. + */ + parent?: string; + /** + * Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters. + */ + rbacrolebindingId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RBACRoleBinding; + } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Delete + extends StandardParameters { + /** + * Required. The RBACRoleBinding resource name in the format `projects/x/locations/x/memberships/x/rbacrolebindings/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Generatemembershiprbacrolebindingyaml + extends StandardParameters { + /** + * Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/x/locations/x/memberships/x`. + */ + parent?: string; + /** + * Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters. + */ + rbacrolebindingId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RBACRoleBinding; + } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Get + extends StandardParameters { + /** + * Required. The RBACRoleBinding resource name in the format `projects/x/locations/x/memberships/x/rbacrolebindings/x`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$List extends StandardParameters { /** @@ -6204,6 +6755,22 @@ export namespace gkehub_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Memberships$Rbacrolebindings$Patch + extends StandardParameters { + /** + * The resource name for the rbacrolebinding `projects/{project\}/locations/{location\}/scopes/{scope\}/rbacrolebindings/{rbacrolebinding\}` or `projects/{project\}/locations/{location\}/memberships/{membership\}/rbacrolebindings/{rbacrolebinding\}` + */ + name?: string; + /** + * Required. The fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RBACRoleBinding; + } export class Resource$Projects$Locations$Operations { context: APIRequestContext; diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index d43f058a46..4343f7ba67 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -582,6 +582,25 @@ export namespace gkehub_v1alpha { */ policycontroller?: Schema$PolicyControllerMembershipSpec; } + /** + * CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. + */ + export interface Schema$CompliancePostureConfig { + /** + * List of enabled compliance standards. + */ + complianceStandards?: Schema$ComplianceStandard[]; + /** + * Defines the enablement mode for Compliance Posture. + */ + mode?: string | null; + } + export interface Schema$ComplianceStandard { + /** + * Name of the compliance standard. + */ + standard?: string | null; + } /** * Configuration for Binauthz */ @@ -666,10 +685,18 @@ export namespace gkehub_v1alpha { * Deployment state of the monitor pod */ monitor?: string | null; + /** + * Deployment state of otel-collector + */ + otelCollector?: string | null; /** * Deployment state of reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Deployment state of resource-group-controller-manager + */ + resourceGroupControllerManager?: string | null; /** * Deployment state of root-reconciler */ @@ -726,7 +753,7 @@ export namespace gkehub_v1alpha { */ export interface Schema$ConfigManagementConfigSyncVersion { /** - * Version of the deployed admission_webhook pod + * Version of the deployed admission-webhook pod */ admissionWebhook?: string | null; /** @@ -741,10 +768,18 @@ export namespace gkehub_v1alpha { * Version of the deployed monitor pod */ monitor?: string | null; + /** + * Version of the deployed otel-collector pod + */ + otelCollector?: string | null; /** * Version of the deployed reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Version of the deployed resource-group-controller-manager pod + */ + resourceGroupControllerManager?: string | null; /** * Version of the deployed reconciler container in root-reconciler pod */ @@ -936,7 +971,7 @@ export namespace gkehub_v1alpha { */ management?: string | null; /** - * Policy Controller configuration for the cluster. + * Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. */ policyController?: Schema$ConfigManagementPolicyController; /** @@ -1188,6 +1223,10 @@ export namespace gkehub_v1alpha { * Optional. Enable/Disable binary authorization features for the cluster. */ binaryAuthorizationConfig?: Schema$BinaryAuthorizationConfig; + /** + * Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + */ + compliancePostureConfig?: Schema$CompliancePostureConfig; /** * Enable/Disable Security Posture features for the cluster. */ @@ -1279,6 +1318,10 @@ export namespace gkehub_v1alpha { * Output only. The Hub-wide Feature state. */ state?: Schema$CommonFeatureState; + /** + * Output only. List of locations that could not be reached while fetching this feature. + */ + unreachable?: string[] | null; /** * Output only. When the Feature resource was last updated. */ @@ -3103,6 +3146,10 @@ export namespace gkehub_v1alpha { * **Service Mesh**: Spec for a single Membership for the servicemesh feature */ export interface Schema$ServiceMeshMembershipSpec { + /** + * Optional. Specifies the API that will be used for configuring the mesh workloads. + */ + configApi?: string | null; /** * Deprecated: use `management` instead Enables automatic control plane management. */ @@ -3112,7 +3159,7 @@ export namespace gkehub_v1alpha { */ defaultChannel?: string | null; /** - * Enables automatic Service Mesh management. + * Optional. Enables automatic Service Mesh management. */ management?: string | null; } @@ -4387,6 +4434,10 @@ export namespace gkehub_v1alpha { * Required. The Feature resource name in the format `projects/x/locations/x/features/x` */ name?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Features$Getiampolicy extends StandardParameters { @@ -4421,6 +4472,10 @@ export namespace gkehub_v1alpha { * Required. The parent (project and location) where the Features will be listed. Specified in the format `projects/x/locations/x`. */ parent?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Features$Patch extends StandardParameters { diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index e80cc99959..dbc98528d2 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -502,6 +502,25 @@ export namespace gkehub_v1beta { */ policycontroller?: Schema$PolicyControllerMembershipSpec; } + /** + * CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. + */ + export interface Schema$CompliancePostureConfig { + /** + * List of enabled compliance standards. + */ + complianceStandards?: Schema$ComplianceStandard[]; + /** + * Defines the enablement mode for Compliance Posture. + */ + mode?: string | null; + } + export interface Schema$ComplianceStandard { + /** + * Name of the compliance standard. + */ + standard?: string | null; + } /** * Configuration for Binauthz */ @@ -586,10 +605,18 @@ export namespace gkehub_v1beta { * Deployment state of the monitor pod */ monitor?: string | null; + /** + * Deployment state of otel-collector + */ + otelCollector?: string | null; /** * Deployment state of reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Deployment state of resource-group-controller-manager + */ + resourceGroupControllerManager?: string | null; /** * Deployment state of root-reconciler */ @@ -646,7 +673,7 @@ export namespace gkehub_v1beta { */ export interface Schema$ConfigManagementConfigSyncVersion { /** - * Version of the deployed admission_webhook pod + * Version of the deployed admission-webhook pod */ admissionWebhook?: string | null; /** @@ -661,10 +688,18 @@ export namespace gkehub_v1beta { * Version of the deployed monitor pod */ monitor?: string | null; + /** + * Version of the deployed otel-collector pod + */ + otelCollector?: string | null; /** * Version of the deployed reconciler-manager pod */ reconcilerManager?: string | null; + /** + * Version of the deployed resource-group-controller-manager pod + */ + resourceGroupControllerManager?: string | null; /** * Version of the deployed reconciler container in root-reconciler pod */ @@ -856,7 +891,7 @@ export namespace gkehub_v1beta { */ management?: string | null; /** - * Policy Controller configuration for the cluster. + * Policy Controller configuration for the cluster. Deprecated: Configuring Policy Controller through the configmanagement feature is no longer recommended. Use the policycontroller feature instead. */ policyController?: Schema$ConfigManagementPolicyController; /** @@ -1108,6 +1143,10 @@ export namespace gkehub_v1beta { * Optional. Enable/Disable binary authorization features for the cluster. */ binaryAuthorizationConfig?: Schema$BinaryAuthorizationConfig; + /** + * Optional. Enable/Disable Compliance Posture features for the cluster. Note that on UpdateFleet, only full replacement of this field is allowed. Users are not allowed for partial updates through field mask. + */ + compliancePostureConfig?: Schema$CompliancePostureConfig; /** * Enable/Disable Security Posture features for the cluster. */ @@ -1199,6 +1238,10 @@ export namespace gkehub_v1beta { * Output only. The Hub-wide Feature state. */ state?: Schema$CommonFeatureState; + /** + * Output only. List of locations that could not be reached while fetching this feature. + */ + unreachable?: string[] | null; /** * Output only. When the Feature resource was last updated. */ @@ -2913,7 +2956,7 @@ export namespace gkehub_v1beta { */ controlPlane?: string | null; /** - * Enables automatic Service Mesh management. + * Optional. Enables automatic Service Mesh management. */ management?: string | null; } @@ -4128,6 +4171,10 @@ export namespace gkehub_v1beta { * Required. The Feature resource name in the format `projects/x/locations/x/features/x` */ name?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Features$Getiampolicy extends StandardParameters { @@ -4162,6 +4209,10 @@ export namespace gkehub_v1beta { * Required. The parent (project and location) where the Features will be listed. Specified in the format `projects/x/locations/x`. */ parent?: string; + /** + * Optional. If set to true, the response will return partial results when some regions are unreachable and the unreachable field in Feature proto will be populated. If set to false, the request will fail when some regions are unreachable. + */ + returnPartialSuccess?: boolean; } export interface Params$Resource$Projects$Locations$Features$Patch extends StandardParameters { diff --git a/src/apis/gkehub/v2beta.ts b/src/apis/gkehub/v2beta.ts new file mode 100644 index 0000000000..885996a0f3 --- /dev/null +++ b/src/apis/gkehub/v2beta.ts @@ -0,0 +1,765 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace gkehub_v2beta { + export interface Options extends GlobalOptions { + version: 'v2beta'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * GKE Hub API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const gkehub = google.gkehub('v2beta'); + * ``` + */ + export class Gkehub { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * 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). + */ + export interface Schema$GoogleRpcStatus { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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 | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$GoogleRpcStatus; + /** + * 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?: {[key: string]: any} | null; + /** + * 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 | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 18d264d676..2ac887bb80 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -526,7 +526,7 @@ export namespace healthcare_v1 { */ text?: Schema$TextConfig; /** - * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + * Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. */ useRegionalDataProcessing?: boolean | null; } @@ -940,11 +940,11 @@ export namespace healthcare_v1 { */ pubsubTopic?: string | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic. + * Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. */ sendFullResource?: boolean | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. */ sendPreviousResourceOnDelete?: boolean | null; } @@ -957,7 +957,7 @@ export namespace healthcare_v1 { */ complexDataTypeReferenceParsing?: string | null; /** - * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. */ defaultSearchHandlingStrict?: boolean | null; /** @@ -965,11 +965,11 @@ export namespace healthcare_v1 { */ disableReferentialIntegrity?: boolean | null; /** - * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. + * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. */ disableResourceVersioning?: boolean | null; /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. */ enableUpdateCreate?: boolean | null; /** @@ -1182,7 +1182,7 @@ export namespace healthcare_v1 { */ datasetUri?: string | null; /** - * If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + * The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. */ force?: boolean | null; /** @@ -1661,7 +1661,7 @@ export namespace healthcare_v1 { */ labels?: {[key: string]: string} | null; /** - * The message type for this message. MSH-9.1. + * Output only. The message type for this message. MSH-9.1. */ messageType?: string | null; /** @@ -1673,19 +1673,19 @@ export namespace healthcare_v1 { */ parsedData?: Schema$ParsedData; /** - * All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + * Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. */ patientIds?: Schema$PatientId[]; /** - * The parsed version of the raw message data schematized according to this store's schemas and type definitions. + * Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. */ schematizedData?: Schema$SchematizedData; /** - * The hospital that this message came from. MSH-4. + * Output only. The hospital that this message came from. MSH-4. */ sendFacility?: string | null; /** - * The datetime the sending application sent this message. MSH-7. + * Output only. The datetime the sending application sent this message. MSH-7. */ sendTime?: string | null; } @@ -1971,6 +1971,57 @@ export namespace healthcare_v1 { */ fhirStore?: string | null; } + /** + * Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back. + */ + export interface Schema$RollbackHL7MessagesFilteringFields { + /** + * Optional. A list of operation IDs to roll back. + */ + operationIds?: string[] | null; + } + /** + * Point in time recovery rollback request. + */ + export interface Schema$RollbackHl7V2MessagesRequest { + /** + * Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. + */ + changeType?: string | null; + /** + * Optional. Specifies whether to exclude earlier rollbacks. + */ + excludeRollbacks?: boolean | null; + /** + * Optional. Parameters for filtering. + */ + filteringFields?: Schema$RollbackHL7MessagesFilteringFields; + /** + * Optional. When enabled, changes will be reverted without explicit confirmation. + */ + force?: boolean | null; + /** + * Optional. Cloud storage object containing list of {resourceId\} lines, identifying resources to be reverted + */ + inputGcsObject?: string | null; + /** + * Required. Bucket to deposit result + */ + resultGcsBucket?: string | null; + /** + * Required. Times point to rollback to. + */ + rollbackTime?: string | null; + } + /** + * Final response of rollback HL7v2 messages request. + */ + export interface Schema$RollbackHl7V2MessagesResponse { + /** + * The name of the HL7 store to rollback, in the format of "projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\} /hl7v2Stores/{hl7v2_store_id\}". + */ + hl7v2Store?: string | null; + } /** * Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. */ @@ -2326,19 +2377,19 @@ export namespace healthcare_v1 { */ export interface Schema$ValidationConfig { /** - * Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableFhirpathValidation?: boolean | null; /** - * Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + * Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. */ disableProfileValidation?: boolean | null; /** - * Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableReferenceTypeValidation?: boolean | null; /** - * Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableRequiredFieldValidation?: boolean | null; /** @@ -14961,6 +15012,95 @@ export namespace healthcare_v1 { } } + /** + * Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options: StreamMethodOptions + ): GaxiosPromise; + rollback( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options?: MethodOptions + ): GaxiosPromise; + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + callback: BodyResponseCallback + ): void; + rollback(callback: BodyResponseCallback): void; + rollback( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:rollback').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @@ -15254,6 +15394,18 @@ export namespace healthcare_v1 { */ requestBody?: Schema$Hl7V2Store; } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback + extends StandardParameters { + /** + * Required. The name of the HL7v2 store to rollback, in the format of "projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\} /hl7V2Stores/{hl7v2_store_id\}". + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RollbackHl7V2MessagesRequest; + } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index c906008d7f..d08a6fbf9d 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -302,6 +302,19 @@ export namespace healthcare_v1beta1 { */ name?: string | null; } + /** + * Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources. + */ + export interface Schema$ApplyAdminConsentsErrorDetail { + /** + * The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them. + */ + consentErrors?: Schema$ConsentErrors[]; + /** + * The currently in progress non-validate-only ApplyAdminConsents operation ID if exist. + */ + existingOperationId?: string | null; + } /** * Request to apply the admin Consent resources for the specified FHIR store. */ @@ -704,7 +717,7 @@ export namespace healthcare_v1beta1 { */ accessDeterminationLogConfig?: Schema$AccessDeterminationLogConfig; /** - * Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + * Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. */ accessEnforced?: boolean | null; /** @@ -720,6 +733,19 @@ export namespace healthcare_v1beta1 { */ version?: string | null; } + /** + * The Consent resource name and error. + */ + export interface Schema$ConsentErrors { + /** + * The error code and message. + */ + error?: Schema$Status; + /** + * The versioned name of the admin Consent resource, in the format `projects/{project_id\}/locations/{location\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Consent/{resource_id\}/_history/{version_id\}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id\}/locations/{location\}/datasets/{dataset_id\}/fhirStores/{fhir_store_id\}/fhir/Consent/{resource_id\}`. + */ + name?: string | null; + } /** * The detailed evaluation of a particular Consent. */ @@ -882,7 +908,7 @@ export namespace healthcare_v1beta1 { */ text?: Schema$TextConfig; /** - * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + * Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. */ useRegionalDataProcessing?: boolean | null; } @@ -1484,11 +1510,11 @@ export namespace healthcare_v1beta1 { */ pubsubTopic?: string | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + * Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. */ sendFullResource?: boolean | null; /** - * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + * Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. */ sendPreviousResourceOnDelete?: boolean | null; } @@ -1514,7 +1540,7 @@ export namespace healthcare_v1beta1 { */ consentConfig?: Schema$ConsentConfig; /** - * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + * If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. */ defaultSearchHandlingStrict?: boolean | null; /** @@ -1522,15 +1548,15 @@ export namespace healthcare_v1beta1 { */ disableReferentialIntegrity?: boolean | null; /** - * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. + * Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. */ disableResourceVersioning?: boolean | null; /** - * Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. + * Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. */ enableHistoryModifications?: boolean | null; /** - * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + * Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. */ enableUpdateCreate?: boolean | null; /** @@ -2838,6 +2864,57 @@ export namespace healthcare_v1beta1 { */ fhirStore?: string | null; } + /** + * Filtering fields for an HL7 rollback. Currently only supports a list of operation ids to roll back. + */ + export interface Schema$RollbackHL7MessagesFilteringFields { + /** + * Optional. A list of operation IDs to roll back. + */ + operationIds?: string[] | null; + } + /** + * Point in time recovery rollback request. + */ + export interface Schema$RollbackHl7V2MessagesRequest { + /** + * Optional. CREATE/UPDATE/DELETE/ALL for reverting all txns of a certain type. + */ + changeType?: string | null; + /** + * Optional. Specifies whether to exclude earlier rollbacks. + */ + excludeRollbacks?: boolean | null; + /** + * Optional. Parameters for filtering. + */ + filteringFields?: Schema$RollbackHL7MessagesFilteringFields; + /** + * Optional. When enabled, changes will be reverted without explicit confirmation. + */ + force?: boolean | null; + /** + * Optional. Cloud storage object containing list of {resourceId\} lines, identifying resources to be reverted + */ + inputGcsObject?: string | null; + /** + * Required. Bucket to deposit result + */ + resultGcsBucket?: string | null; + /** + * Required. Times point to rollback to. + */ + rollbackTime?: string | null; + } + /** + * Final response of rollback FHIR resources request. + */ + export interface Schema$RollbackHl7V2MessagesResponse { + /** + * The name of the HL7 store to rollback, in the format of "projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\} /hl7v2Stores/{fhir_store_id\}". + */ + hl7v2Store?: string | null; + } /** * Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. */ @@ -3287,19 +3364,19 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ValidationConfig { /** - * Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableFhirpathValidation?: boolean | null; /** - * Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + * Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. */ disableProfileValidation?: boolean | null; /** - * Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableReferenceTypeValidation?: boolean | null; /** - * Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + * Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. */ disableRequiredFieldValidation?: boolean | null; /** @@ -19275,6 +19352,95 @@ export namespace healthcare_v1beta1 { } } + /** + * Rolls back messages from the HL7 store to the specified time. This method returns an Operation that can be used to track the status of the rollback by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type RollbackHl7V2MessagesResponse is returned in the response field. The metadata field type for this operation is OperationMetadata. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options: StreamMethodOptions + ): GaxiosPromise; + rollback( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options?: MethodOptions + ): GaxiosPromise; + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + rollback( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback, + callback: BodyResponseCallback + ): void; + rollback(callback: BodyResponseCallback): void; + rollback( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:rollback').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. * @@ -19568,6 +19734,18 @@ export namespace healthcare_v1beta1 { */ requestBody?: Schema$Hl7V2Store; } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Rollback + extends StandardParameters { + /** + * Required. The name of the HL7v2 store to rollback, in the format of "projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\} /hl7V2Stores/{hl7v2_store_id\}". + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RollbackHl7V2MessagesRequest; + } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index e6471a3a23..9695f49d97 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -830,19 +830,6 @@ export namespace iam_v1 { */ verb?: string | null; } - /** - * The service account key patch request. - */ - export interface Schema$PatchServiceAccountKeyRequest { - /** - * Required. The service account key to update. - */ - serviceAccountKey?: Schema$ServiceAccountKey; - /** - * Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description - */ - updateMask?: string | null; - } /** * The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response. */ @@ -954,7 +941,7 @@ export namespace iam_v1 { */ fullResourceName?: string | null; /** - * Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000. + * Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 2,000. */ pageSize?: number | null; /** @@ -1106,18 +1093,6 @@ export namespace iam_v1 { * Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. */ export interface Schema$ServiceAccountKey { - /** - * Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - */ - contact?: string | null; - /** - * Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - */ - creator?: string | null; - /** - * Optional. A user provided description of this service account key. - */ - description?: string | null; /** * The key status. */ @@ -4567,7 +4542,7 @@ export namespace iam_v1 { } /** - * Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. + * Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](https://cloud.google.com/iam/help/limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8906,7 +8881,7 @@ export namespace iam_v1 { } /** - * Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. + * Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](https://cloud.google.com/iam/help/limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -11367,94 +11342,6 @@ export namespace iam_v1 { } } - /** - * Patches a ServiceAccountKey. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Serviceaccounts$Keys$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Serviceaccounts$Keys$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Serviceaccounts$Keys$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Serviceaccounts$Keys$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Serviceaccounts$Keys$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Serviceaccounts$Keys$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Serviceaccounts$Keys$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Serviceaccounts$Keys$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://iam.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}:patch').replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key. * @@ -11612,18 +11499,6 @@ export namespace iam_v1 { */ name?: string; } - export interface Params$Resource$Projects$Serviceaccounts$Keys$Patch - extends StandardParameters { - /** - * The resource name of the service account key in the following format `projects/{PROJECT_ID\}/serviceAccounts/{ACCOUNT\}/keys/{key\}`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PatchServiceAccountKeyRequest; - } export interface Params$Resource$Projects$Serviceaccounts$Keys$Upload extends StandardParameters { /** diff --git a/src/apis/index.ts b/src/apis/index.ts index b0c122c68b..45cb3d93c4 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -49,6 +49,10 @@ import {VERSIONS as adminVersions, admin} from './admin'; import {VERSIONS as admobVersions, admob} from './admob'; import {VERSIONS as adsenseVersions, adsense} from './adsense'; import {VERSIONS as adsensehostVersions, adsensehost} from './adsensehost'; +import { + VERSIONS as adsenseplatformVersions, + adsenseplatform, +} from './adsenseplatform'; import { VERSIONS as advisorynotificationsVersions, advisorynotifications, @@ -244,6 +248,7 @@ import { VERSIONS as contentwarehouseVersions, contentwarehouse, } from './contentwarehouse'; +import {VERSIONS as cssVersions, css} from './css'; import {VERSIONS as customsearchVersions, customsearch} from './customsearch'; import {VERSIONS as datacatalogVersions, datacatalog} from './datacatalog'; import {VERSIONS as dataflowVersions, dataflow} from './dataflow'; @@ -396,6 +401,7 @@ import {VERSIONS as idsVersions, ids} from './ids'; import {VERSIONS as indexingVersions, indexing} from './indexing'; import {VERSIONS as integrationsVersions, integrations} from './integrations'; import {VERSIONS as jobsVersions, jobs} from './jobs'; +import {VERSIONS as keepVersions, keep} from './keep'; import {VERSIONS as kgsearchVersions, kgsearch} from './kgsearch'; import {VERSIONS as kmsinventoryVersions, kmsinventory} from './kmsinventory'; import {VERSIONS as languageVersions, language} from './language'; @@ -725,6 +731,7 @@ export const APIS: APIList = { admob: admobVersions, adsense: adsenseVersions, adsensehost: adsensehostVersions, + adsenseplatform: adsenseplatformVersions, advisorynotifications: advisorynotificationsVersions, aiplatform: aiplatformVersions, airquality: airqualityVersions, @@ -806,6 +813,7 @@ export const APIS: APIList = { containeranalysis: containeranalysisVersions, content: contentVersions, contentwarehouse: contentwarehouseVersions, + css: cssVersions, customsearch: customsearchVersions, datacatalog: datacatalogVersions, dataflow: dataflowVersions, @@ -880,6 +888,7 @@ export const APIS: APIList = { indexing: indexingVersions, integrations: integrationsVersions, jobs: jobsVersions, + keep: keepVersions, kgsearch: kgsearchVersions, kmsinventory: kmsinventoryVersions, language: languageVersions, @@ -1025,6 +1034,7 @@ export class GeneratedAPIs { admob = admob; adsense = adsense; adsensehost = adsensehost; + adsenseplatform = adsenseplatform; advisorynotifications = advisorynotifications; aiplatform = aiplatform; airquality = airquality; @@ -1106,6 +1116,7 @@ export class GeneratedAPIs { containeranalysis = containeranalysis; content = content; contentwarehouse = contentwarehouse; + css = css; customsearch = customsearch; datacatalog = datacatalog; dataflow = dataflow; @@ -1180,6 +1191,7 @@ export class GeneratedAPIs { indexing = indexing; integrations = integrations; jobs = jobs; + keep = keep; kgsearch = kgsearch; kmsinventory = kmsinventory; language = language; diff --git a/src/apis/keep/README.md b/src/apis/keep/README.md new file mode 100644 index 0000000000..98ca1857a3 --- /dev/null +++ b/src/apis/keep/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# keep + +> The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software. + +## Installation + +```sh +$ npm install @googleapis/keep +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/keep/classes/Keep.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/keep/index.ts b/src/apis/keep/index.ts new file mode 100644 index 0000000000..71d9ed8651 --- /dev/null +++ b/src/apis/keep/index.ts @@ -0,0 +1,44 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {keep_v1} from './v1'; + +export const VERSIONS = { + v1: keep_v1.Keep, +}; + +export function keep(version: 'v1'): keep_v1.Keep; +export function keep(options: keep_v1.Options): keep_v1.Keep; +export function keep( + this: GoogleConfigurable, + versionOrOptions: 'v1' | keep_v1.Options +) { + return getAPI('keep', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {keep_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/keep/package.json b/src/apis/keep/package.json new file mode 100644 index 0000000000..87bab67c1f --- /dev/null +++ b/src/apis/keep/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/keep", + "version": "0.1.0", + "description": "keep", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/keep/tsconfig.json b/src/apis/keep/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/keep/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/keep/v1.ts b/src/apis/keep/v1.ts new file mode 100644 index 0000000000..8b7b1c23a5 --- /dev/null +++ b/src/apis/keep/v1.ts @@ -0,0 +1,1043 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace keep_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Google Keep API + * + * The Google Keep API is used in an enterprise environment to manage Google Keep content and resolve issues identified by cloud security software. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const keep = google.keep('v1'); + * ``` + */ + export class Keep { + context: APIRequestContext; + media: Resource$Media; + notes: Resource$Notes; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.media = new Resource$Media(this.context); + this.notes = new Resource$Notes(this.context); + } + } + + /** + * An attachment to a note. + */ + export interface Schema$Attachment { + /** + * The MIME types (IANA media types) in which the attachment is available. + */ + mimeType?: string[] | null; + /** + * The resource name; + */ + name?: string | null; + } + /** + * The request to add one or more permissions on the note. Currently, only the `WRITER` role may be specified. If adding a permission fails, then the entire request fails and no changes are made. + */ + export interface Schema$BatchCreatePermissionsRequest { + /** + * The request message specifying the resources to create. + */ + requests?: Schema$CreatePermissionRequest[]; + } + /** + * The response for creating permissions on a note. + */ + export interface Schema$BatchCreatePermissionsResponse { + /** + * Permissions created. + */ + permissions?: Schema$Permission[]; + } + /** + * The request to remove one or more permissions from a note. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note. + */ + export interface Schema$BatchDeletePermissionsRequest { + /** + * Required. The names of the permissions to delete. Format: `notes/{note\}/permissions/{permission\}` + */ + names?: string[] | null; + } + /** + * The request to add a single permission on the note. + */ + export interface Schema$CreatePermissionRequest { + /** + * Required. The parent note where this permission will be created. Format: `notes/{note\}` + */ + parent?: string | null; + /** + * Required. The permission to create. One of Permission.email, User.email or Group.email must be supplied. + */ + permission?: Schema$Permission; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * Describes a single Google Family. + */ + export interface Schema$Family {} + /** + * Describes a single Group. + */ + export interface Schema$Group { + /** + * The group email. + */ + email?: string | null; + } + /** + * The list of items for a single list note. + */ + export interface Schema$ListContent { + /** + * The items in the list. The number of items must be less than 1,000. + */ + listItems?: Schema$ListItem[]; + } + /** + * A single list item in a note's list. + */ + export interface Schema$ListItem { + /** + * Whether this item has been checked off or not. + */ + checked?: boolean | null; + /** + * If set, list of list items nested under this list item. Only one level of nesting is allowed. + */ + childListItems?: Schema$ListItem[]; + /** + * The text of this item. Length must be less than 1,000 characters. + */ + text?: Schema$TextContent; + } + /** + * The response when listing a page of notes. + */ + export interface Schema$ListNotesResponse { + /** + * Next page's `page_token` field. + */ + nextPageToken?: string | null; + /** + * A page of notes. + */ + notes?: Schema$Note[]; + } + /** + * A single note. + */ + export interface Schema$Note { + /** + * Output only. The attachments attached to this note. + */ + attachments?: Schema$Attachment[]; + /** + * The body of the note. + */ + body?: Schema$Section; + /** + * Output only. When this note was created. + */ + createTime?: string | null; + /** + * Output only. The resource name of this note. See general note on identifiers in KeepService. + */ + name?: string | null; + /** + * Output only. The list of permissions set on the note. Contains at least one entry for the note owner. + */ + permissions?: Schema$Permission[]; + /** + * The title of the note. Length must be less than 1,000 characters. + */ + title?: string | null; + /** + * Output only. `true` if this note has been trashed. If trashed, the note is eventually deleted. + */ + trashed?: boolean | null; + /** + * Output only. When this note was trashed. If `trashed`, the note is eventually deleted. If the note is not trashed, this field is not set (and the trashed field is `false`). + */ + trashTime?: string | null; + /** + * Output only. When this note was last modified. + */ + updateTime?: string | null; + } + /** + * A single permission on the note. Associates a `member` with a `role`. + */ + export interface Schema$Permission { + /** + * Output only. Whether this member has been deleted. If the member is recovered, this value is set to false and the recovered member retains the role on the note. + */ + deleted?: boolean | null; + /** + * The email associated with the member. If set on create, the `email` field in the `User` or `Group` message must either be empty or match this field. On read, may be unset if the member does not have an associated email. + */ + email?: string | null; + /** + * Output only. The Google Family to which this role applies. + */ + family?: Schema$Family; + /** + * Output only. The group to which this role applies. + */ + group?: Schema$Group; + /** + * Output only. The resource name. + */ + name?: string | null; + /** + * The role granted by this permission. The role determines the entity’s ability to read, write, and share notes. + */ + role?: string | null; + /** + * Output only. The user to whom this role applies. + */ + user?: Schema$User; + } + /** + * The content of the note. + */ + export interface Schema$Section { + /** + * Used if this section's content is a list. + */ + list?: Schema$ListContent; + /** + * Used if this section's content is a block of text. The length of the text content must be less than 20,000 characters. + */ + text?: Schema$TextContent; + } + /** + * The block of text for a single text section or list item. + */ + export interface Schema$TextContent { + /** + * The text of the note. The limits on this vary with the specific field using this type. + */ + text?: string | null; + } + /** + * Describes a single user. + */ + export interface Schema$User { + /** + * The user's email. + */ + email?: string | null; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions + ): GaxiosPromise; + download( + params?: Params$Resource$Media$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + callback: BodyResponseCallback + ): void; + download(callback: BodyResponseCallback): void; + download( + paramsOrCallback?: + | Params$Resource$Media$Download + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Download extends StandardParameters { + /** + * The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise. + */ + mimeType?: string; + /** + * Required. The name of the attachment. + */ + name?: string; + } + + export class Resource$Notes { + context: APIRequestContext; + permissions: Resource$Notes$Permissions; + constructor(context: APIRequestContext) { + this.context = context; + this.permissions = new Resource$Notes$Permissions(this.context); + } + + /** + * Creates a new note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Notes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Notes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Notes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Notes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Notes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Notes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Notes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Notes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/notes').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a note. Caller must have the `OWNER` role on the note to delete. Deleting a note removes the resource immediately and cannot be undone. Any collaborators will lose access to the note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Notes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Notes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Notes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Notes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Notes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Notes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Notes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Notes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Notes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Notes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Notes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Notes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Notes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Notes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Notes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Notes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists notes. Every list call returns a page of results with `page_size` as the upper bound of returned items. A `page_size` of zero allows the server to choose the upper bound. The ListNotesResponse contains at most `page_size` entries. If there are more things left to list, it provides a `next_page_token` value. (Page tokens are opaque values.) To get the next page of results, copy the result's `next_page_token` into the next request's `page_token`. Repeat until the `next_page_token` returned with a page of results is empty. ListNotes return consistent results in the face of concurrent changes, or signals that it cannot with an ABORTED error. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Notes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Notes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Notes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Notes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Notes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Notes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Notes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Notes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/notes').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Notes$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$Note; + } + export interface Params$Resource$Notes$Delete extends StandardParameters { + /** + * Required. Name of the note to delete. + */ + name?: string; + } + export interface Params$Resource$Notes$Get extends StandardParameters { + /** + * Required. Name of the resource. + */ + name?: string; + } + export interface Params$Resource$Notes$List extends StandardParameters { + /** + * Filter for list results. If no filter is supplied, the `trashed` filter is applied by default. Valid fields to filter by are: `create_time`, `update_time`, `trash_time`, and `trashed`. Filter syntax follows the [Google AIP filtering spec](https://aip.dev/160). + */ + filter?: string; + /** + * The maximum number of results to return. + */ + pageSize?: number; + /** + * The previous page's `next_page_token` field. + */ + pageToken?: string; + } + + export class Resource$Notes$Permissions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates one or more permissions on the note. Only permissions with the `WRITER` role may be created. If adding any permission fails, then the entire request fails and no changes are made. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchCreate( + params: Params$Resource$Notes$Permissions$Batchcreate, + options: StreamMethodOptions + ): GaxiosPromise; + batchCreate( + params?: Params$Resource$Notes$Permissions$Batchcreate, + options?: MethodOptions + ): GaxiosPromise; + batchCreate( + params: Params$Resource$Notes$Permissions$Batchcreate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Notes$Permissions$Batchcreate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchCreate( + params: Params$Resource$Notes$Permissions$Batchcreate, + callback: BodyResponseCallback + ): void; + batchCreate( + callback: BodyResponseCallback + ): void; + batchCreate( + paramsOrCallback?: + | Params$Resource$Notes$Permissions$Batchcreate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Notes$Permissions$Batchcreate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Notes$Permissions$Batchcreate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/permissions:batchCreate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Deletes one or more permissions on the note. The specified entities will immediately lose access. A permission with the `OWNER` role can't be removed. If removing a permission fails, then the entire request fails and no changes are made. Returns a 400 bad request error if a specified permission does not exist on the note. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + batchDelete( + params: Params$Resource$Notes$Permissions$Batchdelete, + options: StreamMethodOptions + ): GaxiosPromise; + batchDelete( + params?: Params$Resource$Notes$Permissions$Batchdelete, + options?: MethodOptions + ): GaxiosPromise; + batchDelete( + params: Params$Resource$Notes$Permissions$Batchdelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Notes$Permissions$Batchdelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchDelete( + params: Params$Resource$Notes$Permissions$Batchdelete, + callback: BodyResponseCallback + ): void; + batchDelete(callback: BodyResponseCallback): void; + batchDelete( + paramsOrCallback?: + | Params$Resource$Notes$Permissions$Batchdelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Notes$Permissions$Batchdelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Notes$Permissions$Batchdelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://keep.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/permissions:batchDelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Notes$Permissions$Batchcreate + extends StandardParameters { + /** + * The parent resource shared by all Permissions being created. Format: `notes/{note\}` If this is set, the parent field in the CreatePermission messages must either be empty or match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchCreatePermissionsRequest; + } + export interface Params$Resource$Notes$Permissions$Batchdelete + extends StandardParameters { + /** + * The parent resource shared by all permissions being deleted. Format: `notes/{note\}` If this is set, the parent of all of the permissions specified in the DeletePermissionRequest messages must match this field. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchDeletePermissionsRequest; + } +} diff --git a/src/apis/keep/webpack.config.js b/src/apis/keep/webpack.config.js new file mode 100644 index 0000000000..5fde3132d7 --- /dev/null +++ b/src/apis/keep/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Keep', + filename: 'keep.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index d21ad773e6..79c9da0cad 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -551,7 +551,7 @@ export namespace logging_v2 { */ createTime?: string | null; /** - * Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status + * Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/analyze/custom-index) for details.For example: jsonPayload.request.status */ fieldPath?: string | null; /** @@ -720,7 +720,7 @@ export namespace logging_v2 { */ projectIds?: string[] | null; /** - * Required. Names of one or more parent resources from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list. A maximum of 100 resources may be specified in a single request. + * Required. Names of one or more parent resources from which to retrieve log entries. Resources may either be resource containers or specific LogViews. For the case of resource containers, all logs ingested into that container will be returned regardless of which LogBuckets they are actually stored in - i.e. these queries may fan out to multiple regions. In the event of region unavailability, specify a specific set of LogViews that do not include the unavailable region. projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list. A maximum of 100 resources may be specified in a single request. */ resourceNames?: string[] | null; } @@ -5586,6 +5586,10 @@ export namespace logging_v2 { } export interface Params$Resource$Billingaccounts$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -7622,7 +7626,7 @@ export namespace logging_v2 { export interface Params$Resource$Folders$Updatesettings extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" */ name?: string; /** @@ -11414,6 +11418,10 @@ export namespace logging_v2 { } export interface Params$Resource$Folders$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -15543,7 +15551,7 @@ export namespace logging_v2 { export interface Params$Resource$Organizations$Updatesettings extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" */ name?: string; /** @@ -19358,6 +19366,10 @@ export namespace logging_v2 { } export interface Params$Resource$Organizations$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -24208,6 +24220,10 @@ export namespace logging_v2 { } export interface Params$Resource$Projects$Locations$Savedqueries$List extends StandardParameters { + /** + * Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED + */ + filter?: string; /** * Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. */ @@ -26468,7 +26484,7 @@ export namespace logging_v2 { export interface Params$Resource$V2$Updatesettings extends StandardParameters { /** - * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" + * Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" */ name?: string; /** diff --git a/src/apis/manufacturers/v1.ts b/src/apis/manufacturers/v1.ts index 3249b43069..acdf6b3644 100644 --- a/src/apis/manufacturers/v1.ts +++ b/src/apis/manufacturers/v1.ts @@ -200,6 +200,10 @@ export namespace manufacturers_v1 { * A list of included destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 */ includedDestination?: string[] | null; + /** + * Optional. List of countries to show this product in. Countries provided in this attribute will override any of the countries configured at feed level. The values should be: the [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the countries in which this item will be shown. + */ + intendedCountry?: string[] | null; /** * The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. */ @@ -356,10 +360,22 @@ export namespace manufacturers_v1 { * The destination status. */ export interface Schema$DestinationStatus { + /** + * Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is approved. + */ + approvedCountries?: string[] | null; /** * The name of the destination. */ destination?: string | null; + /** + * Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved. + */ + disapprovedCountries?: string[] | null; + /** + * Output only. List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval. + */ + pendingCountries?: string[] | null; /** * The status of the destination. */ @@ -475,6 +491,10 @@ export namespace manufacturers_v1 { * Product issue. */ export interface Schema$Issue { + /** + * Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product. + */ + applicableCountries?: string[] | null; /** * If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. */ @@ -734,6 +754,10 @@ export namespace manufacturers_v1 { * The status of the destinations. */ destinationStatuses?: Schema$DestinationStatus[]; + /** + * Optional. The feed label for the product. + */ + feedLabel?: string | null; /** * A server-generated list of issues associated with the product. */ diff --git a/src/apis/meet/v2.ts b/src/apis/meet/v2.ts index cf765e1b28..e9e8b4b387 100644 --- a/src/apis/meet/v2.ts +++ b/src/apis/meet/v2.ts @@ -391,15 +391,15 @@ export namespace meet_v2 { */ config?: Schema$SpaceConfig; /** - * Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + * Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. */ meetingCode?: string | null; /** - * Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + * Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. */ meetingUri?: string | null; /** - * Immutable. Resource name of the space. Format: `spaces/{space\}` + * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string | null; } @@ -1856,7 +1856,7 @@ export namespace meet_v2 { } /** - * Ends an active conference (if there's one). + * Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1944,7 +1944,7 @@ export namespace meet_v2 { } /** - * Gets a space by `space_id` or `meeting_code`. + * Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2028,7 +2028,7 @@ export namespace meet_v2 { } /** - * Updates a space. + * Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2121,7 +2121,7 @@ export namespace meet_v2 { export interface Params$Resource$Spaces$Endactiveconference extends StandardParameters { /** - * Required. Resource name of the space. + * Required. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; @@ -2132,17 +2132,17 @@ export namespace meet_v2 { } export interface Params$Resource$Spaces$Get extends StandardParameters { /** - * Required. Resource name of the space. + * Required. Resource name of the space. Format: `spaces/{space\}` or `spaces/{meetingCode\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode\}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; } export interface Params$Resource$Spaces$Patch extends StandardParameters { /** - * Immutable. Resource name of the space. Format: `spaces/{space\}` + * Immutable. Resource name of the space. Format: `spaces/{space\}`. `{space\}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). */ name?: string; /** - * Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request. + * Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided(not set, set with empty paths, or only has "" as paths), it defaults to update all fields provided with values in the request. Using "*" as update_mask will update all fields, including deleting fields not set in the request. */ updateMask?: string; diff --git a/src/apis/merchantapi/accounts_v1beta.ts b/src/apis/merchantapi/accounts_v1beta.ts index 3cdcc54bd6..86c4096918 100644 --- a/src/apis/merchantapi/accounts_v1beta.ts +++ b/src/apis/merchantapi/accounts_v1beta.ts @@ -218,23 +218,6 @@ export namespace merchantapi_accounts_v1beta { */ title?: string | null; } - /** - * The tax settings of a merchant account. All methods require the admin role. - */ - export interface Schema$AccountTax { - /** - * Output only. The ID of the account to which these account tax settings belong. - */ - account?: string | null; - /** - * Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account\}\}" - */ - name?: string | null; - /** - * Tax rules. "Define the tax rules in each region. No tax will be presented if a region has no rule." - */ - taxRules?: Schema$TaxRule[]; - } /** * Additional instructions to add account services during creation of the account. */ @@ -386,7 +369,7 @@ export namespace merchantapi_accounts_v1beta { */ account?: Schema$Account; /** - * Optional. If specified, an account service between the account to be created and the provider account is initialized as part of the creation. + * Required. An account service between the account to be created and the provider account is initialized as part of the creation. At least one such service needs to be provided. Currently only `account_aggregation` is supported which means the newly created account will be a subaccount of the provider defined in the `account_aggregation` service. */ service?: Schema$AddAccountService[]; /** @@ -644,19 +627,6 @@ export namespace merchantapi_accounts_v1beta { */ reportingContext?: string | null; } - /** - * Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. - */ - export interface Schema$Interval { - /** - * Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end. - */ - endTime?: string | null; - /** - * Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start. - */ - startTime?: string | null; - } /** * Response message for the `ListAccountIssues` method. */ @@ -683,19 +653,6 @@ export namespace merchantapi_accounts_v1beta { */ nextPageToken?: string | null; } - /** - * Response to account tax list request This method can only be called on a multi-client account, otherwise it'll return an error. - */ - export interface Schema$ListAccountTaxResponse { - /** - * Page of accounttax settings - */ - accountTaxes?: Schema$AccountTax[]; - /** - * The token for the retrieval of the next page of account tax settings. - */ - nextPageToken?: string | null; - } /** * Response message for the `ListOnlineReturnPolicies` method. */ @@ -1329,52 +1286,6 @@ export namespace merchantapi_accounts_v1beta { */ rows?: Schema$Row[]; } - /** - * A range of postal codes that defines the area. - */ - export interface Schema$TaxPostalCodeRange { - /** - * The end of the postal code range. Will be the same as start if not specified. - */ - end?: string | null; - /** - * Required. The start of the postal code range, which is also the smallest in the range. - */ - start?: string | null; - } - /** - * Primary type convension percent micro : 100% = 1 000 000 and 1% = 10 000 cannot be negative. Information about tax nexus and related parameters applicable to orders delivered to the area covered by a single tax admin. Nexus is created when a merchant is doing business in an area administered by tax admin (only US states are supported for nexus configuration). If merchant has nexus in a US state, merchant needs to pay tax to all tax authorities associated with the shipping destination. Next Id : 8 - */ - export interface Schema$TaxRule { - /** - * Required. Time period when this rule is effective. If the duration is missing from effective_time listed, then it is open ended to the future. The start of this time period is inclusive, and the end is exclusive. - */ - effectiveTimePeriod?: Schema$Interval; - /** - * The admin_id or criteria_id of the region in which this rule is applicable. - */ - locationId?: string | null; - /** - * The range of postal codes in which this rule is applicable. - */ - postCodeRange?: Schema$TaxPostalCodeRange; - /** - * Region code in which this rule is applicable - */ - regionCode?: string | null; - /** - * A fixed rate specified in micros, where 100% = 1_000_000. Suitable for origin-based states. - */ - selfSpecifiedRateMicros?: string | null; - /** - * If set, shipping charge is taxed (at the same rate as product) when delivering to this admin's area. Can only be set on US states without category. - */ - shippingTaxed?: boolean | null; - /** - * Rate that depends on delivery location: if merchant has a nexus in corresponding US state, rates from authorities with jurisdiction over delivery area are added up. - */ - useGoogleRate?: boolean | null; - } /** * A `TermsOfService`. */ @@ -1409,7 +1320,7 @@ export namespace merchantapi_accounts_v1beta { */ accepted?: Schema$Accepted; /** - * Identifier. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` + * Identifier. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}` For example, an identifier could be: `MERCHANT_CENTER-US` */ name?: string | null; /** @@ -1594,7 +1505,9 @@ export namespace merchantapi_accounts_v1beta { export class Resource$Accounts { context: APIRequestContext; - accounttax: Resource$Accounts$Accounttax; + businessIdentity: Resource$Accounts$Businessidentity; + businessInfo: Resource$Accounts$Businessinfo; + emailpreferences: Resource$Accounts$Emailpreferences; homepage: Resource$Accounts$Homepage; issues: Resource$Accounts$Issues; onlineReturnPolicies: Resource$Accounts$Onlinereturnpolicies; @@ -1605,7 +1518,13 @@ export namespace merchantapi_accounts_v1beta { users: Resource$Accounts$Users; constructor(context: APIRequestContext) { this.context = context; - this.accounttax = new Resource$Accounts$Accounttax(this.context); + this.businessIdentity = new Resource$Accounts$Businessidentity( + this.context + ); + this.businessInfo = new Resource$Accounts$Businessinfo(this.context); + this.emailpreferences = new Resource$Accounts$Emailpreferences( + this.context + ); this.homepage = new Resource$Accounts$Homepage(this.context); this.issues = new Resource$Accounts$Issues(this.context); this.onlineReturnPolicies = new Resource$Accounts$Onlinereturnpolicies( @@ -1883,59 +1802,61 @@ export namespace merchantapi_accounts_v1beta { } /** - * Retrieves the business identity of an account. + * Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, + list( + params: Params$Resource$Accounts$List, options: StreamMethodOptions ): GaxiosPromise; - getBusinessIdentity( - params?: Params$Resource$Accounts$Getbusinessidentity, + list( + params?: Params$Resource$Accounts$List, options?: MethodOptions - ): GaxiosPromise; - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getBusinessIdentity( - params: Params$Resource$Accounts$Getbusinessidentity, - callback: BodyResponseCallback + list( + params: Params$Resource$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getBusinessIdentity( - callback: BodyResponseCallback + list( + params: Params$Resource$Accounts$List, + callback: BodyResponseCallback ): void; - getBusinessIdentity( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Accounts$Getbusinessidentity - | BodyResponseCallback + | Params$Resource$Accounts$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getbusinessidentity; + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getbusinessidentity; + params = {} as Params$Resource$Accounts$List; options = {}; } @@ -1948,7 +1869,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( + url: (rootUrl + '/accounts/v1beta/accounts').replace( /([^:]\/)\/+/g, '$1' ), @@ -1958,72 +1879,79 @@ export namespace merchantapi_accounts_v1beta { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves the business info of an account. + * List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent\} AND service(type="ACCOUNT_AGGREGATION"))` * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, options: StreamMethodOptions ): GaxiosPromise; - getBusinessInfo( - params?: Params$Resource$Accounts$Getbusinessinfo, + listSubaccounts( + params?: Params$Resource$Accounts$Listsubaccounts, options?: MethodOptions - ): GaxiosPromise; - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, + ): GaxiosPromise; + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getBusinessInfo( - params: Params$Resource$Accounts$Getbusinessinfo, - callback: BodyResponseCallback + listSubaccounts( + params: Params$Resource$Accounts$Listsubaccounts, + callback: BodyResponseCallback ): void; - getBusinessInfo(callback: BodyResponseCallback): void; - getBusinessInfo( + listSubaccounts( + callback: BodyResponseCallback + ): void; + listSubaccounts( paramsOrCallback?: - | Params$Resource$Accounts$Getbusinessinfo - | BodyResponseCallback + | Params$Resource$Accounts$Listsubaccounts + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getbusinessinfo; + {}) as Params$Resource$Accounts$Listsubaccounts; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getbusinessinfo; + params = {} as Params$Resource$Accounts$Listsubaccounts; options = {}; } @@ -2036,82 +1964,80 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/accounts/v1beta/{+provider}:listSubaccounts' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['provider'], + pathParams: ['provider'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Retrieves a store's homepage. + * Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getHomepage( - params: Params$Resource$Accounts$Gethomepage, + patch( + params: Params$Resource$Accounts$Patch, options: StreamMethodOptions ): GaxiosPromise; - getHomepage( - params?: Params$Resource$Accounts$Gethomepage, + patch( + params?: Params$Resource$Accounts$Patch, options?: MethodOptions - ): GaxiosPromise; - getHomepage( - params: Params$Resource$Accounts$Gethomepage, + ): GaxiosPromise; + patch( + params: Params$Resource$Accounts$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getHomepage( - params: Params$Resource$Accounts$Gethomepage, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Accounts$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getHomepage( - params: Params$Resource$Accounts$Gethomepage, - callback: BodyResponseCallback + patch( + params: Params$Resource$Accounts$Patch, + callback: BodyResponseCallback ): void; - getHomepage(callback: BodyResponseCallback): void; - getHomepage( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Accounts$Gethomepage - | BodyResponseCallback + | Params$Resource$Accounts$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Gethomepage; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Gethomepage; + params = {} as Params$Resource$Accounts$Patch; options = {}; } @@ -2128,7 +2054,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -2139,161 +2065,141 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Createandconfigure + extends StandardParameters { /** - * Retrieve shipping setting information. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Request body metadata */ - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, - options: StreamMethodOptions - ): GaxiosPromise; - getShippingSettings( - params?: Params$Resource$Accounts$Getshippingsettings, - options?: MethodOptions - ): GaxiosPromise; - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getShippingSettings( - params: Params$Resource$Accounts$Getshippingsettings, - callback: BodyResponseCallback - ): void; - getShippingSettings( - callback: BodyResponseCallback - ): void; - getShippingSettings( - paramsOrCallback?: - | Params$Resource$Accounts$Getshippingsettings - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Getshippingsettings; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Getshippingsettings; - options = {}; - } + requestBody?: Schema$CreateAndConfigureAccountRequest; + } + export interface Params$Resource$Accounts$Delete extends StandardParameters { + /** + * Required. The name of the account to delete. Format: `accounts/{account\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Required. The name of the account to retrieve. Format: `accounts/{account\}` + */ + name?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax). + */ + filter?: string; + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. + */ + pageToken?: string; + } + export interface Params$Resource$Accounts$Listsubaccounts + extends StandardParameters { + /** + * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. + */ + pageSize?: number; + /** + * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The parent account. Format: `accounts/{account\}` + */ + provider?: string; + } + export interface Params$Resource$Accounts$Patch extends StandardParameters { + /** + * Identifier. The resource name of the account. Format: `accounts/{account\}` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * Request body metadata + */ + requestBody?: Schema$Account; + } - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } + export class Resource$Accounts$Businessidentity { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on. + * Retrieves the business identity of an account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Accounts$List, + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Accounts$List, + getBusinessIdentity( + params?: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accounts$List, + ): GaxiosPromise; + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$List, - callback: BodyResponseCallback + getBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Getbusinessidentity, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + getBusinessIdentity( + callback: BodyResponseCallback + ): void; + getBusinessIdentity( paramsOrCallback?: - | Params$Resource$Accounts$List - | BodyResponseCallback + | Params$Resource$Accounts$Businessidentity$Getbusinessidentity + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$List; + params = + {} as Params$Resource$Accounts$Businessidentity$Getbusinessidentity; options = {}; } @@ -2306,7 +2212,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/accounts').replace( + url: (rootUrl + '/accounts/v1beta/{+name}').replace( /([^:]\/)\/+/g, '$1' ), @@ -2316,165 +2222,75 @@ export namespace merchantapi_accounts_v1beta { options ), params, - requiredParams: [], - pathParams: [], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent\} AND service(type="ACCOUNT_AGGREGATION"))` + * Updates the business identity of an account. Executing this method requires admin access. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options: StreamMethodOptions ): GaxiosPromise; - listSubaccounts( - params?: Params$Resource$Accounts$Listsubaccounts, + updateBusinessIdentity( + params?: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options?: MethodOptions - ): GaxiosPromise; - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, + ): GaxiosPromise; + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listSubaccounts( - params: Params$Resource$Accounts$Listsubaccounts, - callback: BodyResponseCallback + updateBusinessIdentity( + params: Params$Resource$Accounts$Businessidentity$Updatebusinessidentity, + callback: BodyResponseCallback ): void; - listSubaccounts( - callback: BodyResponseCallback + updateBusinessIdentity( + callback: BodyResponseCallback ): void; - listSubaccounts( + updateBusinessIdentity( paramsOrCallback?: - | Params$Resource$Accounts$Listsubaccounts - | BodyResponseCallback + | Params$Resource$Accounts$Businessidentity$Updatebusinessidentity + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Listsubaccounts; + {}) as Params$Resource$Accounts$Businessidentity$Updatebusinessidentity; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Listsubaccounts; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/accounts/v1beta/{+provider}:listSubaccounts' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['provider'], - pathParams: ['provider'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Accounts$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Accounts$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Accounts$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Patch; + params = + {} as Params$Resource$Accounts$Businessidentity$Updatebusinessidentity; options = {}; } @@ -2502,69 +2318,98 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Businessidentity$Getbusinessidentity + extends StandardParameters { /** - * Updates the business identity of an account. Executing this method requires admin access. + * Required. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` + */ + name?: string; + } + export interface Params$Resource$Accounts$Businessidentity$Updatebusinessidentity + extends StandardParameters { + /** + * Identifier. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BusinessIdentity; + } + + export class Resource$Accounts$Businessinfo { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves the business info of an account. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options: StreamMethodOptions ): GaxiosPromise; - updateBusinessIdentity( - params?: Params$Resource$Accounts$Updatebusinessidentity, + getBusinessInfo( + params?: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options?: MethodOptions - ): GaxiosPromise; - updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, + ): GaxiosPromise; + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateBusinessIdentity( - params: Params$Resource$Accounts$Updatebusinessidentity, - callback: BodyResponseCallback + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateBusinessIdentity( - callback: BodyResponseCallback + getBusinessInfo( + params: Params$Resource$Accounts$Businessinfo$Getbusinessinfo, + callback: BodyResponseCallback ): void; - updateBusinessIdentity( + getBusinessInfo(callback: BodyResponseCallback): void; + getBusinessInfo( paramsOrCallback?: - | Params$Resource$Accounts$Updatebusinessidentity - | BodyResponseCallback + | Params$Resource$Accounts$Businessinfo$Getbusinessinfo + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Updatebusinessidentity; + {}) as Params$Resource$Accounts$Businessinfo$Getbusinessinfo; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Updatebusinessidentity; + params = {} as Params$Resource$Accounts$Businessinfo$Getbusinessinfo; options = {}; } @@ -2581,7 +2426,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -2592,12 +2437,12 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } @@ -2610,25 +2455,25 @@ export namespace merchantapi_accounts_v1beta { * @returns A promise if used with async/await, or void if used with a callback. */ updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options: StreamMethodOptions ): GaxiosPromise; updateBusinessInfo( - params?: Params$Resource$Accounts$Updatebusinessinfo, + params?: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options?: MethodOptions ): GaxiosPromise; updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; updateBusinessInfo( - params: Params$Resource$Accounts$Updatebusinessinfo, + params: Params$Resource$Accounts$Businessinfo$Updatebusinessinfo, callback: BodyResponseCallback ): void; updateBusinessInfo( @@ -2636,7 +2481,7 @@ export namespace merchantapi_accounts_v1beta { ): void; updateBusinessInfo( paramsOrCallback?: - | Params$Resource$Accounts$Updatebusinessinfo + | Params$Resource$Accounts$Businessinfo$Updatebusinessinfo | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2649,12 +2494,12 @@ export namespace merchantapi_accounts_v1beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Updatebusinessinfo; + {}) as Params$Resource$Accounts$Businessinfo$Updatebusinessinfo; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Updatebusinessinfo; + params = {} as Params$Resource$Accounts$Businessinfo$Updatebusinessinfo; options = {}; } @@ -2690,59 +2535,93 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Accounts$Businessinfo$Getbusinessinfo + extends StandardParameters { /** - * Updates a store's homepage. Executing this method requires admin access. + * Required. The resource name of the business info. Format: `accounts/{account\}/businessInfo` + */ + name?: string; + } + export interface Params$Resource$Accounts$Businessinfo$Updatebusinessinfo + extends StandardParameters { + /** + * Identifier. The resource name of the business info. Format: `accounts/{account\}/businessInfo` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BusinessInfo; + } + + export class Resource$Accounts$Emailpreferences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Returns the email preferences for a Merchant Center account user. Use the name=accounts/x/users/me/emailPreferences alias to get preferences for the authenticated user. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, options: StreamMethodOptions ): GaxiosPromise; - updateHomepage( - params?: Params$Resource$Accounts$Updatehomepage, + getEmailPreferences( + params?: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, options?: MethodOptions - ): GaxiosPromise; - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, + ): GaxiosPromise; + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - updateHomepage( - params: Params$Resource$Accounts$Updatehomepage, - callback: BodyResponseCallback + getEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Getemailpreferences, + callback: BodyResponseCallback ): void; - updateHomepage(callback: BodyResponseCallback): void; - updateHomepage( + getEmailPreferences( + callback: BodyResponseCallback + ): void; + getEmailPreferences( paramsOrCallback?: - | Params$Resource$Accounts$Updatehomepage - | BodyResponseCallback + | Params$Resource$Accounts$Emailpreferences$Getemailpreferences + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Updatehomepage; + {}) as Params$Resource$Accounts$Emailpreferences$Getemailpreferences; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Updatehomepage; + params = + {} as Params$Resource$Accounts$Emailpreferences$Getemailpreferences; options = {}; } @@ -2759,7 +2638,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -2770,214 +2649,70 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Accounts$Createandconfigure - extends StandardParameters { - /** - * Request body metadata - */ - requestBody?: Schema$CreateAndConfigureAccountRequest; - } - export interface Params$Resource$Accounts$Delete extends StandardParameters { - /** - * Required. The name of the account to delete. Format: `accounts/{account\}` - */ - name?: string; - } - export interface Params$Resource$Accounts$Get extends StandardParameters { - /** - * Required. The name of the account to retrieve. Format: `accounts/{account\}` - */ - name?: string; - } - export interface Params$Resource$Accounts$Getbusinessidentity - extends StandardParameters { - /** - * Required. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` - */ - name?: string; - } - export interface Params$Resource$Accounts$Getbusinessinfo - extends StandardParameters { - /** - * Required. The resource name of the business info. Format: `accounts/{account\}/businessInfo` - */ - name?: string; - } - export interface Params$Resource$Accounts$Gethomepage - extends StandardParameters { - /** - * Required. The name of the homepage to retrieve. Format: `accounts/{account\}/homepage` - */ - name?: string; - } - export interface Params$Resource$Accounts$Getshippingsettings - extends StandardParameters { - /** - * Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsetting` - */ - name?: string; - } - export interface Params$Resource$Accounts$List extends StandardParameters { - /** - * Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax). - */ - filter?: string; - /** - * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. - */ - pageToken?: string; - } - export interface Params$Resource$Accounts$Listsubaccounts - extends StandardParameters { - /** - * Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500. - */ - pageSize?: number; - /** - * Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. The parent account. Format: `accounts/{account\}` - */ - provider?: string; - } - export interface Params$Resource$Accounts$Patch extends StandardParameters { - /** - * Identifier. The resource name of the account. Format: `accounts/{account\}` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Account; - } - export interface Params$Resource$Accounts$Updatebusinessidentity - extends StandardParameters { - /** - * Identifier. The resource name of the business identity. Format: `accounts/{account\}/businessIdentity` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BusinessIdentity; - } - export interface Params$Resource$Accounts$Updatebusinessinfo - extends StandardParameters { - /** - * Identifier. The resource name of the business info. Format: `accounts/{account\}/businessInfo` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$BusinessInfo; - } - export interface Params$Resource$Accounts$Updatehomepage - extends StandardParameters { - /** - * Identifier. The resource name of the store's homepage. Format: `accounts/{account\}/homepage` - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Homepage; - } - - export class Resource$Accounts$Accounttax { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Returns the tax rules that match the conditions of GetAccountTaxRequest + * Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/x/users/me/emailPreferences alias to update preferences for the authenticated user. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Accounts$Accounttax$Get, + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Accounts$Accounttax$Get, + updateEmailPreferences( + params?: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accounts$Accounttax$Get, + ): GaxiosPromise; + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Accounts$Accounttax$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Accounts$Accounttax$Get, - callback: BodyResponseCallback + updateEmailPreferences( + params: Params$Resource$Accounts$Emailpreferences$Updateemailpreferences, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + updateEmailPreferences( + callback: BodyResponseCallback + ): void; + updateEmailPreferences( paramsOrCallback?: - | Params$Resource$Accounts$Accounttax$Get - | BodyResponseCallback + | Params$Resource$Accounts$Emailpreferences$Updateemailpreferences + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Accounttax$Get; + {}) as Params$Resource$Accounts$Emailpreferences$Updateemailpreferences; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Accounttax$Get; + params = + {} as Params$Resource$Accounts$Emailpreferences$Updateemailpreferences; options = {}; } @@ -2994,7 +2729,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -3005,72 +2740,98 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Accounts$Emailpreferences$Getemailpreferences + extends StandardParameters { + /** + * Required. The name of the `EmailPreferences` resource. Format: `accounts/{account\}/users/{email\}/emailPreferences` + */ + name?: string; + } + export interface Params$Resource$Accounts$Emailpreferences$Updateemailpreferences + extends StandardParameters { + /** + * Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EmailPreferences; + } + + export class Resource$Accounts$Homepage { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error. + * Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Accounts$Accounttax$List, + claim( + params: Params$Resource$Accounts$Homepage$Claim, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Accounts$Accounttax$List, + claim( + params?: Params$Resource$Accounts$Homepage$Claim, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accounts$Accounttax$List, + ): GaxiosPromise; + claim( + params: Params$Resource$Accounts$Homepage$Claim, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$Accounttax$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + claim( + params: Params$Resource$Accounts$Homepage$Claim, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Accounts$Accounttax$List, - callback: BodyResponseCallback + claim( + params: Params$Resource$Accounts$Homepage$Claim, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + claim(callback: BodyResponseCallback): void; + claim( paramsOrCallback?: - | Params$Resource$Accounts$Accounttax$List - | BodyResponseCallback + | Params$Resource$Accounts$Homepage$Claim + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Accounttax$List; + {}) as Params$Resource$Accounts$Homepage$Claim; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Accounttax$List; + params = {} as Params$Resource$Accounts$Homepage$Claim; options = {}; } @@ -3083,82 +2844,82 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+parent}/accounttax').replace( + url: (rootUrl + '/accounts/v1beta/{+name}:claim').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the tax settings of the account. + * Retrieves a store's homepage. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Accounts$Accounttax$Patch, + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Accounts$Accounttax$Patch, + getHomepage( + params?: Params$Resource$Accounts$Homepage$Gethomepage, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Accounttax$Patch, + ): GaxiosPromise; + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Accounttax$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Accounts$Accounttax$Patch, - callback: BodyResponseCallback + getHomepage( + params: Params$Resource$Accounts$Homepage$Gethomepage, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + getHomepage(callback: BodyResponseCallback): void; + getHomepage( paramsOrCallback?: - | Params$Resource$Accounts$Accounttax$Patch - | BodyResponseCallback + | Params$Resource$Accounts$Homepage$Gethomepage + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Accounttax$Patch; + {}) as Params$Resource$Accounts$Homepage$Gethomepage; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Accounttax$Patch; + params = {} as Params$Resource$Accounts$Homepage$Gethomepage; options = {}; } @@ -3175,7 +2936,7 @@ export namespace merchantapi_accounts_v1beta { /([^:]\/)\/+/g, '$1' ), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -3186,95 +2947,49 @@ export namespace merchantapi_accounts_v1beta { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Accounts$Accounttax$Get - extends StandardParameters { - /** - * Required. The name from which tax settings will be retrieved - */ - name?: string; - } - export interface Params$Resource$Accounts$Accounttax$List - extends StandardParameters { - /** - * The maximum number of tax settings to return in the response, used for paging. - */ - pageSize?: number; - /** - * The token returned by the previous request. - */ - pageToken?: string; - /** - * Required. The parent, which owns this collection of account tax. Format: accounts/{account\} - */ - parent?: string; - } - export interface Params$Resource$Accounts$Accounttax$Patch - extends StandardParameters { - /** - * Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account\}\}" - */ - name?: string; - /** - * The list of fields to be updated - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AccountTax; - } - - export class Resource$Accounts$Homepage { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Claims a store's homepage. Executing this method requires admin access. If the homepage is already claimed, this will recheck the verification (unless the merchant is exempted from claiming, which also exempts from verification) and return a successful response. If ownership can no longer be verified, it will return an error, but it won't clear the claim. In case of failure, a canonical error message will be returned: * PERMISSION_DENIED: user doesn't have the necessary permissions on this MC account; * FAILED_PRECONDITION: - The account is not a Merchant Center account; - MC account doesn't have a homepage; - claiming failed (in this case the error message will contain more details). + * Unclaims a store's homepage. Executing this method requires admin access. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - claim( - params: Params$Resource$Accounts$Homepage$Claim, + unclaim( + params: Params$Resource$Accounts$Homepage$Unclaim, options: StreamMethodOptions ): GaxiosPromise; - claim( - params?: Params$Resource$Accounts$Homepage$Claim, + unclaim( + params?: Params$Resource$Accounts$Homepage$Unclaim, options?: MethodOptions ): GaxiosPromise; - claim( - params: Params$Resource$Accounts$Homepage$Claim, + unclaim( + params: Params$Resource$Accounts$Homepage$Unclaim, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - claim( - params: Params$Resource$Accounts$Homepage$Claim, + unclaim( + params: Params$Resource$Accounts$Homepage$Unclaim, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - claim( - params: Params$Resource$Accounts$Homepage$Claim, + unclaim( + params: Params$Resource$Accounts$Homepage$Unclaim, callback: BodyResponseCallback ): void; - claim(callback: BodyResponseCallback): void; - claim( + unclaim(callback: BodyResponseCallback): void; + unclaim( paramsOrCallback?: - | Params$Resource$Accounts$Homepage$Claim + | Params$Resource$Accounts$Homepage$Unclaim | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3287,12 +3002,12 @@ export namespace merchantapi_accounts_v1beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Homepage$Claim; + {}) as Params$Resource$Accounts$Homepage$Unclaim; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Homepage$Claim; + params = {} as Params$Resource$Accounts$Homepage$Unclaim; options = {}; } @@ -3305,7 +3020,7 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}:claim').replace( + url: (rootUrl + '/accounts/v1beta/{+name}:unclaim').replace( /([^:]\/)\/+/g, '$1' ), @@ -3330,39 +3045,39 @@ export namespace merchantapi_accounts_v1beta { } /** - * Unclaims a store's homepage. Executing this method requires admin access. + * Updates a store's homepage. Executing this method requires admin access. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - unclaim( - params: Params$Resource$Accounts$Homepage$Unclaim, + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, options: StreamMethodOptions ): GaxiosPromise; - unclaim( - params?: Params$Resource$Accounts$Homepage$Unclaim, + updateHomepage( + params?: Params$Resource$Accounts$Homepage$Updatehomepage, options?: MethodOptions ): GaxiosPromise; - unclaim( - params: Params$Resource$Accounts$Homepage$Unclaim, + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - unclaim( - params: Params$Resource$Accounts$Homepage$Unclaim, + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - unclaim( - params: Params$Resource$Accounts$Homepage$Unclaim, + updateHomepage( + params: Params$Resource$Accounts$Homepage$Updatehomepage, callback: BodyResponseCallback ): void; - unclaim(callback: BodyResponseCallback): void; - unclaim( + updateHomepage(callback: BodyResponseCallback): void; + updateHomepage( paramsOrCallback?: - | Params$Resource$Accounts$Homepage$Unclaim + | Params$Resource$Accounts$Homepage$Updatehomepage | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3375,12 +3090,12 @@ export namespace merchantapi_accounts_v1beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Homepage$Unclaim; + {}) as Params$Resource$Accounts$Homepage$Updatehomepage; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Homepage$Unclaim; + params = {} as Params$Resource$Accounts$Homepage$Updatehomepage; options = {}; } @@ -3393,11 +3108,11 @@ export namespace merchantapi_accounts_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/accounts/v1beta/{+name}:unclaim').replace( + url: (rootUrl + '/accounts/v1beta/{+name}').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'PATCH', apiVersion: '', }, options @@ -3430,6 +3145,13 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$ClaimHomepageRequest; } + export interface Params$Resource$Accounts$Homepage$Gethomepage + extends StandardParameters { + /** + * Required. The name of the homepage to retrieve. Format: `accounts/{account\}/homepage` + */ + name?: string; + } export interface Params$Resource$Accounts$Homepage$Unclaim extends StandardParameters { /** @@ -3442,6 +3164,22 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$UnclaimHomepageRequest; } + export interface Params$Resource$Accounts$Homepage$Updatehomepage + extends StandardParameters { + /** + * Identifier. The resource name of the store's homepage. Format: `accounts/{account\}/homepage` + */ + name?: string; + /** + * Required. List of fields being updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Homepage; + } export class Resource$Accounts$Issues { context: APIRequestContext; @@ -4707,16 +4445,107 @@ export namespace merchantapi_accounts_v1beta { */ updateMask?: string; - /** - * Request body metadata - */ - requestBody?: Schema$Region; - } + /** + * Request body metadata + */ + requestBody?: Schema$Region; + } + + export class Resource$Accounts$Shippingsettings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieve shipping setting information. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options: StreamMethodOptions + ): GaxiosPromise; + getShippingSettings( + params?: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options?: MethodOptions + ): GaxiosPromise; + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getShippingSettings( + params: Params$Resource$Accounts$Shippingsettings$Getshippingsettings, + callback: BodyResponseCallback + ): void; + getShippingSettings( + callback: BodyResponseCallback + ): void; + getShippingSettings( + paramsOrCallback?: + | Params$Resource$Accounts$Shippingsettings$Getshippingsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Shippingsettings$Getshippingsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Accounts$Shippingsettings$Getshippingsettings; + options = {}; + } - export class Resource$Accounts$Shippingsettings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/accounts/v1beta/{+name}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** @@ -4807,6 +4636,13 @@ export namespace merchantapi_accounts_v1beta { } } + export interface Params$Resource$Accounts$Shippingsettings$Getshippingsettings + extends StandardParameters { + /** + * Required. The name of the shipping setting to retrieve. Format: `accounts/{account\}/shippingsetting` + */ + name?: string; + } export interface Params$Resource$Accounts$Shippingsettings$Insert extends StandardParameters { /** @@ -5026,7 +4862,7 @@ export namespace merchantapi_accounts_v1beta { export interface Params$Resource$Accounts$Termsofserviceagreementstates$Get extends StandardParameters { /** - * Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` + * Required. The resource name of the terms of service version. Format: `accounts/{account\}/termsOfServiceAgreementState/{identifier\}` The identifier format is: `{TermsOfServiceKind\}-{country\}` */ name?: string; } @@ -5308,96 +5144,6 @@ export namespace merchantapi_accounts_v1beta { } } - /** - * Returns the email preferences for a Merchant Center account user. Use the name=accounts/x/users/me/emailPreferences alias to get preferences for the authenticated user. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - options: StreamMethodOptions - ): GaxiosPromise; - getEmailPreferences( - params?: Params$Resource$Accounts$Users$Getemailpreferences, - options?: MethodOptions - ): GaxiosPromise; - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getEmailPreferences( - params: Params$Resource$Accounts$Users$Getemailpreferences, - callback: BodyResponseCallback - ): void; - getEmailPreferences( - callback: BodyResponseCallback - ): void; - getEmailPreferences( - paramsOrCallback?: - | Params$Resource$Accounts$Users$Getemailpreferences - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Users$Getemailpreferences; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Users$Getemailpreferences; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists all users of a Merchant Center account. * @@ -5576,96 +5322,6 @@ export namespace merchantapi_accounts_v1beta { return createAPIRequest(parameters); } } - - /** - * Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/x/users/me/emailPreferences alias to update preferences for the authenticated user. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - options: StreamMethodOptions - ): GaxiosPromise; - updateEmailPreferences( - params?: Params$Resource$Accounts$Users$Updateemailpreferences, - options?: MethodOptions - ): GaxiosPromise; - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - params: Params$Resource$Accounts$Users$Updateemailpreferences, - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - callback: BodyResponseCallback - ): void; - updateEmailPreferences( - paramsOrCallback?: - | Params$Resource$Accounts$Users$Updateemailpreferences - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Users$Updateemailpreferences; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Users$Updateemailpreferences; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://merchantapi.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/accounts/v1beta/{+name}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Accounts$Users$Create @@ -5698,13 +5354,6 @@ export namespace merchantapi_accounts_v1beta { */ name?: string; } - export interface Params$Resource$Accounts$Users$Getemailpreferences - extends StandardParameters { - /** - * Required. The name of the `EmailPreferences` resource. Format: `accounts/{account\}/users/{email\}/emailPreferences` - */ - name?: string; - } export interface Params$Resource$Accounts$Users$List extends StandardParameters { /** @@ -5736,22 +5385,6 @@ export namespace merchantapi_accounts_v1beta { */ requestBody?: Schema$User; } - export interface Params$Resource$Accounts$Users$Updateemailpreferences - extends StandardParameters { - /** - * Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. - */ - name?: string; - /** - * Required. List of fields being updated. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EmailPreferences; - } export class Resource$Termsofservice { context: APIRequestContext; diff --git a/src/apis/merchantapi/products_v1beta.ts b/src/apis/merchantapi/products_v1beta.ts index 04aa7e0145..59d25c5040 100644 --- a/src/apis/merchantapi/products_v1beta.ts +++ b/src/apis/merchantapi/products_v1beta.ts @@ -727,6 +727,10 @@ export namespace merchantapi_products_v1beta { * The amount of loyalty points earned on a purchase. */ loyaltyPoints?: string | null; + /** + * A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + */ + memberPriceEffectiveDate?: Schema$Interval; /** * The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. */ diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 3c2da91445..56ed90edda 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -393,6 +393,23 @@ export namespace metastore_v1 { */ subnetwork?: string | null; } + /** + * Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty. + */ + export interface Schema$CustomRegionMetadata { + /** + * The read-only regions for this custom region. + */ + optionalReadOnlyRegions?: string[] | null; + /** + * The read-write regions for this custom region. + */ + requiredReadWriteRegions?: string[] | null; + /** + * The Spanner witness region for this custom region. + */ + witnessRegion?: string | null; + } /** * A specification of the location of and metadata about a database dump from a relational database management system. */ @@ -757,6 +774,10 @@ export namespace metastore_v1 { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * Possible configurations supported if the current region is a custom region. + */ + customRegionMetadata?: Schema$CustomRegionMetadata[]; /** * The multi-region metadata if the current region is a multi-region. */ diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index 46a731f014..4a7d0b6bf2 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -411,6 +411,36 @@ export namespace metastore_v1alpha { */ subnetwork?: string | null; } + /** + * Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + */ + export interface Schema$CustomRegionConfig { + /** + * Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readOnlyRegions?: string[] | null; + /** + * Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readWriteRegions?: string[] | null; + } + /** + * Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty. + */ + export interface Schema$CustomRegionMetadata { + /** + * The read-only regions for this custom region. + */ + optionalReadOnlyRegions?: string[] | null; + /** + * The read-write regions for this custom region. + */ + requiredReadWriteRegions?: string[] | null; + /** + * The Spanner witness region for this custom region. + */ + witnessRegion?: string | null; + } /** * A specification of the location of and metadata about a database dump from a relational database management system. */ @@ -793,6 +823,10 @@ export namespace metastore_v1alpha { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * Possible configurations supported if the current region is a custom region. + */ + customRegionMetadata?: Schema$CustomRegionMetadata[]; /** * The multi-region metadata if the current region is a multi-region. */ @@ -953,6 +987,16 @@ export namespace metastore_v1alpha { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The multi-region config for the Dataproc Metastore service. + */ + export interface Schema$MultiRegionConfig { + /** + * Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + */ + certificates?: Schema$RootCACertificate[]; + customRegionConfig?: Schema$CustomRegionConfig; + } /** * The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty. */ @@ -1144,6 +1188,19 @@ export namespace metastore_v1alpha { */ restoreType?: string | null; } + /** + * A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + */ + export interface Schema$RootCACertificate { + /** + * The root CA certificate in PEM format. The maximum length is 65536 bytes. + */ + certificate?: string | null; + /** + * The certificate expiration time in timestamp format. + */ + expirationTime?: string | null; + } /** * Represents the scaling configuration of a metastore service. */ @@ -1247,6 +1304,10 @@ export namespace metastore_v1alpha { * Output only. The metadata management activities of the metastore service. */ metadataManagementActivity?: Schema$MetadataManagementActivity; + /** + * Optional. Specifies the multi-region configuration information for the Hive metastore service. + */ + multiRegionConfig?: Schema$MultiRegionConfig; /** * Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number\}/locations/{location_id\}/services/{service_id\}. */ diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index b88d386c26..f52d41dce6 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -411,6 +411,36 @@ export namespace metastore_v1beta { */ subnetwork?: string | null; } + /** + * Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + */ + export interface Schema$CustomRegionConfig { + /** + * Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readOnlyRegions?: string[] | null; + /** + * Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + */ + readWriteRegions?: string[] | null; + } + /** + * Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty. + */ + export interface Schema$CustomRegionMetadata { + /** + * The read-only regions for this custom region. + */ + optionalReadOnlyRegions?: string[] | null; + /** + * The read-write regions for this custom region. + */ + requiredReadWriteRegions?: string[] | null; + /** + * The Spanner witness region for this custom region. + */ + witnessRegion?: string | null; + } /** * A specification of the location of and metadata about a database dump from a relational database management system. */ @@ -793,6 +823,10 @@ export namespace metastore_v1beta { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * Possible configurations supported if the current region is a custom region. + */ + customRegionMetadata?: Schema$CustomRegionMetadata[]; /** * The multi-region metadata if the current region is a multi-region. */ @@ -953,6 +987,16 @@ export namespace metastore_v1beta { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The multi-region config for the Dataproc Metastore service. + */ + export interface Schema$MultiRegionConfig { + /** + * Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + */ + certificates?: Schema$RootCACertificate[]; + customRegionConfig?: Schema$CustomRegionConfig; + } /** * The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty. */ @@ -1144,6 +1188,19 @@ export namespace metastore_v1beta { */ restoreType?: string | null; } + /** + * A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + */ + export interface Schema$RootCACertificate { + /** + * The root CA certificate in PEM format. The maximum length is 65536 bytes. + */ + certificate?: string | null; + /** + * The certificate expiration time in timestamp format. + */ + expirationTime?: string | null; + } /** * Represents the scaling configuration of a metastore service. */ @@ -1247,6 +1304,10 @@ export namespace metastore_v1beta { * Output only. The metadata management activities of the metastore service. */ metadataManagementActivity?: Schema$MetadataManagementActivity; + /** + * Optional. Specifies the multi-region configuration information for the Hive metastore service. + */ + multiRegionConfig?: Schema$MultiRegionConfig; /** * Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number\}/locations/{location_id\}/services/{service_id\}. */ diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 34cc4ecaac..5472dfa3c3 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -732,7 +732,7 @@ export namespace migrationcenter_v1alpha1 { */ machinePreferences?: Schema$MachinePreferences; /** - * Optional. Preferences for multithreading support. + * Optional. Preferences for multithreading support on Windows Server. */ multithreading?: string | null; /** @@ -2610,7 +2610,7 @@ export namespace migrationcenter_v1alpha1 { */ commitmentPlan?: string | null; /** - * Optional. License type of the OS image. + * Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). */ licenseType?: string | null; } @@ -3158,7 +3158,7 @@ export namespace migrationcenter_v1alpha1 { */ machinePreferences?: Schema$VirtualMachinePreferences; /** - * Compute monthly cost for this preference set. + * Output only. Compute monthly cost for this preference set. */ monthlyCostCompute?: Schema$Money; /** @@ -3170,23 +3170,23 @@ export namespace migrationcenter_v1alpha1 { */ monthlyCostDatabaseLicensing?: Schema$Money; /** - * Network Egress monthly cost for this preference set. Only present for virtual machines. + * Output only. Network Egress monthly cost for this preference set. Only present for virtual machines. */ monthlyCostNetworkEgress?: Schema$Money; /** - * Operating system licensing monthly cost for this preference set. Only present for virtual machines. + * Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines. */ monthlyCostOsLicense?: Schema$Money; /** - * Miscellaneous monthly cost for this preference set. + * Output only. Miscellaneous monthly cost for this preference set. */ monthlyCostOther?: Schema$Money; /** - * Storage monthly cost for this preference set. + * Output only. Storage monthly cost for this preference set. */ monthlyCostStorage?: Schema$Money; /** - * Total monthly cost for this preference set. + * Output only. Total monthly cost for this preference set. */ monthlyCostTotal?: Schema$Money; /** diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 7098a3609b..f273639e43 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -190,7 +190,7 @@ export namespace monitoring_v3 { */ mutationRecord?: Schema$MutationRecord; /** - * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ name?: string | null; /** @@ -223,7 +223,7 @@ export namespace monitoring_v3 { */ notificationChannelStrategy?: Schema$NotificationChannelStrategy[]; /** - * Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + * Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. */ notificationRateLimit?: Schema$NotificationRateLimit; } @@ -1584,7 +1584,7 @@ export namespace monitoring_v3 { */ mutationRecords?: Schema$MutationRecord[]; /** - * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string | null; /** @@ -2088,6 +2088,10 @@ export namespace monitoring_v3 { * A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. */ export interface Schema$TimeSeries { + /** + * Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. + */ + description?: string | null; /** * Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. */ @@ -2109,7 +2113,7 @@ export namespace monitoring_v3 { */ resource?: Schema$MonitoredResource; /** - * The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. + * The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty. */ unit?: string | null; /** @@ -3234,7 +3238,7 @@ export namespace monitoring_v3 { export interface Params$Resource$Projects$Alertpolicies$List extends StandardParameters { /** - * If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). + * Optional. If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ filter?: string; /** @@ -3242,22 +3246,22 @@ export namespace monitoring_v3 { */ name?: string; /** - * A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). + * Optional. A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ orderBy?: string; /** - * The maximum number of results to return in a single response. + * Optional. The maximum number of results to return in a single response. */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. + * Optional. If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. */ pageToken?: string; } export interface Params$Resource$Projects$Alertpolicies$Patch extends StandardParameters { /** - * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ name?: string; /** @@ -5662,7 +5666,7 @@ export namespace monitoring_v3 { export interface Params$Resource$Projects$Notificationchannels$List extends StandardParameters { /** - * If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). + * Optional. If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ filter?: string; /** @@ -5670,26 +5674,26 @@ export namespace monitoring_v3 { */ name?: string; /** - * A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). + * Optional. A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ orderBy?: string; /** - * The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. + * Optional. The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. */ pageSize?: number; /** - * If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. + * Optional. If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. */ pageToken?: string; } export interface Params$Resource$Projects$Notificationchannels$Patch extends StandardParameters { /** - * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * Identifier. The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string; /** - * The fields to update. + * Optional. The fields to update. */ updateMask?: string; diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index 54860e4921..95a91ad014 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -628,6 +628,10 @@ export namespace networkconnectivity_v1 { * Optional. IP ranges allowed to be included from peering. */ includeExportRanges?: string[] | null; + /** + * Output only. The list of Producer VPC spokes that this VPC spoke is a service consumer VPC spoke for. These producer VPCs are connected through VPC peering to this spoke's backing VPC network. + */ + producerVpcSpokes?: string[] | null; /** * Required. The URI of the VPC network resource. */ @@ -1512,7 +1516,7 @@ export namespace networkconnectivity_v1 { */ pscConnections?: Schema$PscConnection[]; /** - * The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. + * The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. */ serviceClass?: string | null; /** diff --git a/src/apis/networkconnectivity/v1alpha1.ts b/src/apis/networkconnectivity/v1alpha1.ts index 753d606784..871955ded4 100644 --- a/src/apis/networkconnectivity/v1alpha1.ts +++ b/src/apis/networkconnectivity/v1alpha1.ts @@ -308,6 +308,10 @@ export namespace networkconnectivity_v1alpha1 { * User-defined labels. */ labels?: {[key: string]: string} | null; + /** + * Optional. Should be present if usage is set to FOR_MIGRATION. + */ + migration?: Schema$Migration; /** * Immutable. The name of an internal range. Format: projects/{project\}/locations/{location\}/internalRanges/{internal_range\} See: https://google.aip.dev/122#fields-representing-resource-names */ @@ -434,6 +438,19 @@ export namespace networkconnectivity_v1alpha1 { */ name?: string | null; } + /** + * Specification for migration with source and target resource names. + */ + export interface Schema$Migration { + /** + * Immutable. Resource path as an URI of the source resource, for example a subnet. The project for the source resource should match the project for the InternalRange. An example: /projects/{project\}/regions/{region\}/subnetworks/{subnet\} + */ + source?: string | null; + /** + * Immutable. Resource path of the target resource. The target project can be different, as in the cases when migrating to peer networks. The resource For example: /projects/{project\}/regions/{region\}/subnetworks/{subnet\} + */ + target?: string | null; + } /** * Represents the metadata of the long-running operation. */ diff --git a/src/apis/networkmanagement/v1.ts b/src/apis/networkmanagement/v1.ts index 6a3b661727..92631dab93 100644 --- a/src/apis/networkmanagement/v1.ts +++ b/src/apis/networkmanagement/v1.ts @@ -555,7 +555,7 @@ export namespace networkmanagement_v1 { title?: string | null; } /** - * For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. + * For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. */ export interface Schema$FirewallInfo { /** @@ -567,7 +567,7 @@ export namespace networkmanagement_v1 { */ direction?: string | null; /** - * The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. + * The display name of the firewall rule. This field might be empty for firewall policy rules. */ displayName?: string | null; /** @@ -579,9 +579,13 @@ export namespace networkmanagement_v1 { */ networkUri?: string | null; /** - * The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules. + * The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. */ policy?: string | null; + /** + * The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. + */ + policyUri?: string | null; /** * The priority of the firewall rule. */ @@ -591,11 +595,11 @@ export namespace networkmanagement_v1 { */ targetServiceAccounts?: string[] | null; /** - * The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. + * The target tags defined by the VPC firewall rule. This field is not applicable to firewall policy rules. */ targetTags?: string[] | null; /** - * The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. + * The URI of the firewall rule. This field is not applicable to implied VPC firewall rules. */ uri?: string | null; } @@ -727,6 +731,10 @@ export namespace networkmanagement_v1 { * URI of a Compute Engine network. */ networkUri?: string | null; + /** + * URI of the PSC network attachment the NIC is attached to (if relevant). + */ + pscNetworkAttachmentUri?: string | null; /** * Service account authorized for the instance. */ diff --git a/src/apis/networkmanagement/v1beta1.ts b/src/apis/networkmanagement/v1beta1.ts index a48d88e28a..631795bec8 100644 --- a/src/apis/networkmanagement/v1beta1.ts +++ b/src/apis/networkmanagement/v1beta1.ts @@ -559,7 +559,7 @@ export namespace networkmanagement_v1beta1 { title?: string | null; } /** - * For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a hierarchical firewall policy rule. + * For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. */ export interface Schema$FirewallInfo { /** @@ -571,7 +571,7 @@ export namespace networkmanagement_v1beta1 { */ direction?: string | null; /** - * The display name of the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. + * The display name of the firewall rule. This field might be empty for firewall policy rules. */ displayName?: string | null; /** @@ -583,9 +583,13 @@ export namespace networkmanagement_v1beta1 { */ networkUri?: string | null; /** - * The hierarchical firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules. + * The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. */ policy?: string | null; + /** + * The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. + */ + policyUri?: string | null; /** * The priority of the firewall rule. */ @@ -595,11 +599,11 @@ export namespace networkmanagement_v1beta1 { */ targetServiceAccounts?: string[] | null; /** - * The target tags defined by the VPC firewall rule. This field is not applicable to hierarchical firewall policy rules. + * The target tags defined by the VPC firewall rule. This field is not applicable to firewall policy rules. */ targetTags?: string[] | null; /** - * The URI of the VPC firewall rule. This field is not applicable to implied firewall rules or hierarchical firewall policy rules. + * The URI of the firewall rule. This field is not applicable to implied VPC firewall rules. */ uri?: string | null; } @@ -731,6 +735,10 @@ export namespace networkmanagement_v1beta1 { * URI of a Compute Engine network. */ networkUri?: string | null; + /** + * URI of the PSC network attachment the NIC is attached to (if relevant). + */ + pscNetworkAttachmentUri?: string | null; /** * Service account authorized for the instance. */ @@ -805,6 +813,23 @@ export namespace networkmanagement_v1beta1 { */ operations?: Schema$Operation[]; } + /** + * Response for the `ListVpcFlowLogsConfigs` method. + */ + export interface Schema$ListVpcFlowLogsConfigsResponse { + /** + * Page token to fetch the next set of configurations. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached (when querying all locations with `-`). + */ + unreachable?: string[] | null; + /** + * List of VPC Flow Log configurations. + */ + vpcFlowLogsConfigs?: Schema$VpcFlowLogsConfig[]; + } /** * For display only. Metadata associated with a specific load balancer backend. */ @@ -1483,6 +1508,63 @@ export namespace networkmanagement_v1beta1 { */ uri?: string | null; } + /** + * A configuration to generate VPC Flow Logs. + */ + export interface Schema$VpcFlowLogsConfig { + /** + * Optional. The aggregation interval for the logs. Default value is INTERVAL_5_SEC. + */ + aggregationInterval?: string | null; + /** + * Output only. The time the config was created. + */ + createTime?: string | null; + /** + * Optional. The user-supplied description of the VPC Flow Logs configuration. Maximum of 512 characters. + */ + description?: string | null; + /** + * Optional. Export filter used to define which VPC Flow Logs should be logged. + */ + filterExpr?: string | null; + /** + * Optional. The value of the field must be in (0, 1]. The sampling rate of VPC Flow Logs where 1.0 means all collected logs are reported. Setting the sampling rate to 0.0 is not allowed. If you want to disable VPC Flow Logs, use the state field instead. Default value is 1.0. + */ + flowSampling?: number | null; + /** + * Traffic will be logged from the Interconnect Attachment. Format: projects/{project_id\}/regions/{region\}/interconnectAttachments/{name\} + */ + interconnectAttachment?: string | null; + /** + * Optional. Resource labels to represent user-provided metadata. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default value is INCLUDE_ALL_METADATA. + */ + metadata?: string | null; + /** + * Optional. Custom metadata fields to include in the reported VPC flow logs. Can only be specified if "metadata" was set to CUSTOM_METADATA. + */ + metadataFields?: string[] | null; + /** + * Identifier. Unique name of the configuration using the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + */ + name?: string | null; + /** + * Optional. The state of the VPC Flow Log configuration. Default value is ENABLED. When creating a new configuration, it must be enabled. + */ + state?: string | null; + /** + * Output only. The time the config was updated. + */ + updateTime?: string | null; + /** + * Traffic will be logged from the VPN Tunnel. Format: projects/{project_id\}/regions/{region\}/vpnTunnels/{name\} + */ + vpnTunnel?: string | null; + } /** * For display only. Metadata associated with a Compute Engine VPN gateway. */ @@ -1566,9 +1648,12 @@ export namespace networkmanagement_v1beta1 { export class Resource$Projects$Locations { context: APIRequestContext; global: Resource$Projects$Locations$Global; + vpcFlowLogsConfigs: Resource$Projects$Locations$Vpcflowlogsconfigs; constructor(context: APIRequestContext) { this.context = context; this.global = new Resource$Projects$Locations$Global(this.context); + this.vpcFlowLogsConfigs = + new Resource$Projects$Locations$Vpcflowlogsconfigs(this.context); } /** @@ -3144,4 +3229,534 @@ export namespace networkmanagement_v1beta1 { */ pageToken?: string; } + + export class Resource$Projects$Locations$Vpcflowlogsconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. Creating a configuration with state=DISABLED will fail. 2. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - creating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/vpcFlowLogsConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a specific `VpcFlowLogsConfig`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the details of a specific `VpcFlowLogsConfig`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all `VpcFlowLogsConfigs` in a given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/vpcFlowLogsConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing `VpcFlowLogsConfig`. If a configuration with the exact same settings already exists (even if the ID is different), the creation fails. Notes: 1. The following fields are not considrered as `settings` for the purpose of the check mentioned above, therefore - updating another configuration with the same fields but different values for the following fields will fail as well: - name - create_time - update_time - labels - description + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkmanagement.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Create + extends StandardParameters { + /** + * Required. The parent resource of the VPC Flow Logs configuration to create: `projects/{project_id\}/locations/global` + */ + parent?: string; + /** + * Required. ID of the `VpcFlowLogsConfig`. + */ + vpcFlowLogsConfigId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VpcFlowLogsConfig; + } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Delete + extends StandardParameters { + /** + * Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Get + extends StandardParameters { + /** + * Required. `VpcFlowLogsConfig` resource name using the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$List + extends StandardParameters { + /** + * Optional. Lists the `VpcFlowLogsConfigs` that match the filter expression. A filter expression must use the supported [CEL logic operators] (https://cloud.google.com/vpc/docs/about-flow-logs-records#supported_cel_logic_operators). + */ + filter?: string; + /** + * Optional. Field to use to sort the list. + */ + orderBy?: string; + /** + * Optional. Number of `VpcFlowLogsConfigs` to return. + */ + pageSize?: number; + /** + * Optional. Page token from an earlier query, as returned in `next_page_token`. + */ + pageToken?: string; + /** + * Required. The parent resource of the VpcFlowLogsConfig: `projects/{project_id\}/locations/global` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Vpcflowlogsconfigs$Patch + extends StandardParameters { + /** + * Identifier. Unique name of the configuration using the form: `projects/{project_id\}/locations/global/vpcFlowLogsConfigs/{vpc_flow_logs_config_id\}` + */ + name?: string; + /** + * Required. Mask of fields to update. At least one path must be supplied in this field. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VpcFlowLogsConfig; + } } diff --git a/src/apis/networksecurity/v1.ts b/src/apis/networksecurity/v1.ts index 9efb09e6ff..800b58932c 100644 --- a/src/apis/networksecurity/v1.ts +++ b/src/apis/networksecurity/v1.ts @@ -167,6 +167,10 @@ export namespace networksecurity_v1 { * Required. Name of the AddressGroup resource. It matches pattern `projects/x/locations/{location\}/addressGroups/`. */ name?: string | null; + /** + * Optional. List of supported purposes of the Address Group. + */ + purpose?: string[] | null; /** * Output only. Server-defined fully-qualified URL for this resource. */ @@ -891,15 +895,15 @@ export namespace networksecurity_v1 { */ export interface Schema$MTLSPolicy { /** - * Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate. + * Required if the policy is to be used with Traffic Director. For Application Load Balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate. */ clientValidationCa?: Schema$ValidationCA[]; /** - * When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty. + * When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. */ clientValidationMode?: string | null; /** - * Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers. + * Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. */ clientValidationTrustConfig?: string | null; } @@ -988,7 +992,7 @@ export namespace networksecurity_v1 { sources?: Schema$Source[]; } /** - * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10 + * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12 */ export interface Schema$SecurityProfile { /** @@ -1025,7 +1029,7 @@ export namespace networksecurity_v1 { updateTime?: string | null; } /** - * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9 + * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 11 */ export interface Schema$SecurityProfileGroup { /** @@ -1049,7 +1053,7 @@ export namespace networksecurity_v1 { */ name?: string | null; /** - * Optional. Reference to a SecurityProfile with the threat prevention configuration for the SecurityProfileGroup. + * Optional. Reference to a SecurityProfile with the ThreatPrevention configuration. */ threatPreventionProfile?: string | null; /** @@ -1058,11 +1062,11 @@ export namespace networksecurity_v1 { updateTime?: string | null; } /** - * ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. + * ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by Application Load Balancers can be attached only to TargetHttpsProxy with an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. */ export interface Schema$ServerTlsPolicy { /** - * This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80. + * This field applies only for Traffic Director policies. It is must be set to false for Application Load Balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80. */ allowOpen?: boolean | null; /** @@ -1078,7 +1082,7 @@ export namespace networksecurity_v1 { */ labels?: {[key: string]: string} | null; /** - * This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. + * This field is required if the policy is used with Application Load Balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. */ mtlsPolicy?: Schema$MTLSPolicy; /** @@ -1086,7 +1090,7 @@ export namespace networksecurity_v1 { */ name?: string | null; /** - * Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported. + * Optional if policy is to be used with Traffic Director. For Application Load Balancers must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported. */ serverCertificate?: Schema$GoogleCloudNetworksecurityV1CertificateProvider; /** @@ -4245,6 +4249,7 @@ export namespace networksecurity_v1 { context: APIRequestContext; addressGroups: Resource$Projects$Locations$Addressgroups; authorizationPolicies: Resource$Projects$Locations$Authorizationpolicies; + authzPolicies: Resource$Projects$Locations$Authzpolicies; clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; @@ -4259,6 +4264,9 @@ export namespace networksecurity_v1 { ); this.authorizationPolicies = new Resource$Projects$Locations$Authorizationpolicies(this.context); + this.authzPolicies = new Resource$Projects$Locations$Authzpolicies( + this.context + ); this.clientTlsPolicies = new Resource$Projects$Locations$Clienttlspolicies(this.context); this.firewallEndpointAssociations = @@ -6599,6 +6607,338 @@ export namespace networksecurity_v1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Authzpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + export class Resource$Projects$Locations$Clienttlspolicies { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index d9db37e525..f95fa6d0cf 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -217,6 +217,232 @@ export namespace networksecurity_v1beta1 { */ updateTime?: string | null; } + /** + * `AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes. + */ + export interface Schema$AuthzPolicy { + /** + * Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request. + */ + action?: string | null; + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified. + */ + customProvider?: Schema$AuthzPolicyCustomProvider; + /** + * Optional. A human-readable description of the resource. + */ + description?: string | null; + /** + * Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action. + */ + httpRules?: Schema$AuthzPolicyAuthzRule[]; + /** + * Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + */ + labels?: {[key: string]: string} | null; + /** + * Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project\}/locations/{location\}/authzPolicies/{authz_policy\}`. + */ + name?: string | null; + /** + * Required. Specifies the set of resources to which this policy should be applied to. + */ + target?: Schema$AuthzPolicyTarget; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } + /** + * Conditions to match against the incoming request. + */ + export interface Schema$AuthzPolicyAuthzRule { + /** + * Optional. Describes properties of one or more sources of a request. + */ + from?: Schema$AuthzPolicyAuthzRuleFrom; + /** + * Optional. Describes properties of one or more targets of a request. + */ + to?: Schema$AuthzPolicyAuthzRuleTo; + /** + * Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes. + */ + when?: string | null; + } + /** + * Describes properties of one or more sources of a request. + */ + export interface Schema$AuthzPolicyAuthzRuleFrom { + /** + * Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified. + */ + notSources?: Schema$AuthzPolicyAuthzRuleFromRequestSource[]; + /** + * Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match. + */ + sources?: Schema$AuthzPolicyAuthzRuleFromRequestSource[]; + } + /** + * Describes the properties of a single source. + */ + export interface Schema$AuthzPolicyAuthzRuleFromRequestSource { + /** + * Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals. + */ + principals?: Schema$AuthzPolicyAuthzRuleStringMatch[]; + /** + * Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources. + */ + resources?: Schema$AuthzPolicyAuthzRuleRequestResource[]; + } + /** + * Determines how a HTTP header should be matched. + */ + export interface Schema$AuthzPolicyAuthzRuleHeaderMatch { + /** + * Optional. Specifies the name of the header in the request. + */ + name?: string | null; + /** + * Optional. Specifies how the header match will be performed. + */ + value?: Schema$AuthzPolicyAuthzRuleStringMatch; + } + /** + * Describes the properties of a client VM resource accessing the internal application load balancers. + */ + export interface Schema$AuthzPolicyAuthzRuleRequestResource { + /** + * Optional. An IAM service account to match against the source service account of the VM sending the request. + */ + iamServiceAccount?: Schema$AuthzPolicyAuthzRuleStringMatch; + /** + * Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + */ + tagValueIdSet?: Schema$AuthzPolicyAuthzRuleRequestResourceTagValueIdSet; + } + /** + * Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. + */ + export interface Schema$AuthzPolicyAuthzRuleRequestResourceTagValueIdSet { + /** + * Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches. + */ + ids?: string[] | null; + } + /** + * Determines how a string value should be matched. + */ + export interface Schema$AuthzPolicyAuthzRuleStringMatch { + /** + * The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` + */ + contains?: string | null; + /** + * The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. + */ + exact?: string | null; + /** + * If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true. + */ + ignoreCase?: boolean | null; + /** + * The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz`` + */ + prefix?: string | null; + /** + * The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc`` + */ + suffix?: string | null; + } + /** + * Describes properties of one or more targets of a request. + */ + export interface Schema$AuthzPolicyAuthzRuleTo { + /** + * Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified. + */ + notOperations?: Schema$AuthzPolicyAuthzRuleToRequestOperation[]; + /** + * Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches. + */ + operations?: Schema$AuthzPolicyAuthzRuleToRequestOperation[]; + } + /** + * Describes properties of one or more targets of a request. + */ + export interface Schema$AuthzPolicyAuthzRuleToRequestOperation { + /** + * Optional. A list of headers to match against in http header. + */ + headerSet?: Schema$AuthzPolicyAuthzRuleToRequestOperationHeaderSet; + /** + * Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. + */ + hosts?: Schema$AuthzPolicyAuthzRuleStringMatch[]; + /** + * Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive. + */ + methods?: string[] | null; + /** + * Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + */ + paths?: Schema$AuthzPolicyAuthzRuleStringMatch[]; + } + /** + * Describes a set of HTTP headers to match against. + */ + export interface Schema$AuthzPolicyAuthzRuleToRequestOperationHeaderSet { + /** + * Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. + */ + headers?: Schema$AuthzPolicyAuthzRuleHeaderMatch[]; + } + /** + * Allows delegating authorization decisions to Cloud IAP or to Service Extensions. + */ + export interface Schema$AuthzPolicyCustomProvider { + /** + * Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified. + */ + authzExtension?: Schema$AuthzPolicyCustomProviderAuthzExtension; + /** + * Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. + */ + cloudIap?: Schema$AuthzPolicyCustomProviderCloudIap; + } + /** + * Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified. + */ + export interface Schema$AuthzPolicyCustomProviderAuthzExtension { + /** + * Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider. + */ + resources?: string[] | null; + } + /** + * Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. + */ + export interface Schema$AuthzPolicyCustomProviderCloudIap {} + /** + * Specifies the set of targets to which this policy should be applied to. + */ + export interface Schema$AuthzPolicyTarget { + /** + * Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + */ + loadBalancingScheme?: string | null; + /** + * Required. A list of references to the Forwarding Rules on which this policy will be applied. + */ + resources?: string[] | null; + } /** * The request message for Operations.CancelOperation. */ @@ -685,6 +911,23 @@ export namespace networksecurity_v1beta1 { */ nextPageToken?: string | null; } + /** + * Message for response to listing `AuthzPolicy` resources. + */ + export interface Schema$ListAuthzPoliciesResponse { + /** + * The list of `AuthzPolicy` resources. + */ + authzPolicies?: Schema$AuthzPolicy[]; + /** + * A token identifying a page of results that the server returns. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response returned by the ListClientTlsPolicies method. */ @@ -895,15 +1138,15 @@ export namespace networksecurity_v1beta1 { */ export interface Schema$MTLSPolicy { /** - * Required if the policy is to be used with Traffic Director. For external HTTPS load balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate. + * Required if the policy is to be used with Traffic Director. For Application Load Balancers it must be empty. Defines the mechanism to obtain the Certificate Authority certificate to validate the client certificate. */ clientValidationCa?: Schema$ValidationCA[]; /** - * When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the external HTTPS load balancing. For Traffic Director it must be empty. + * When the client presents an invalid certificate or no certificate to the load balancer, the `client_validation_mode` specifies how the client connection is handled. Required if the policy is to be used with the Application Load Balancers. For Traffic Director it must be empty. */ clientValidationMode?: string | null; /** - * Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with external HTTPS load balancers. + * Reference to the TrustConfig from certificatemanager.googleapis.com namespace. If specified, the chain validation will be performed against certificates configured in the given TrustConfig. Allowed only if the policy is to be used with Application Load Balancers. */ clientValidationTrustConfig?: string | null; } @@ -992,7 +1235,7 @@ export namespace networksecurity_v1beta1 { sources?: Schema$Source[]; } /** - * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 10 + * SecurityProfile is a resource that defines the behavior for one of many ProfileTypes. Next ID: 12 */ export interface Schema$SecurityProfile { /** @@ -1029,7 +1272,7 @@ export namespace networksecurity_v1beta1 { updateTime?: string | null; } /** - * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 9 + * SecurityProfileGroup is a resource that defines the behavior for various ProfileTypes. Next ID: 11 */ export interface Schema$SecurityProfileGroup { /** @@ -1053,7 +1296,7 @@ export namespace networksecurity_v1beta1 { */ name?: string | null; /** - * Optional. Reference to a SecurityProfile with the threat prevention configuration for the SecurityProfileGroup. + * Optional. Reference to a SecurityProfile with the ThreatPrevention configuration. */ threatPreventionProfile?: string | null; /** @@ -1062,11 +1305,11 @@ export namespace networksecurity_v1beta1 { updateTime?: string | null; } /** - * ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by external HTTPS load balancers can be attached only to TargetHttpsProxy with an `EXTERNAL` or `EXTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. + * ServerTlsPolicy is a resource that specifies how a server should authenticate incoming requests. This resource itself does not affect configuration unless it is attached to a target HTTPS proxy or endpoint config selector resource. ServerTlsPolicy in the form accepted by Application Load Balancers can be attached only to TargetHttpsProxy with an `EXTERNAL`, `EXTERNAL_MANAGED` or `INTERNAL_MANAGED` load balancing scheme. Traffic Director compatible ServerTlsPolicies can be attached to EndpointPolicy and TargetHttpsProxy with Traffic Director `INTERNAL_SELF_MANAGED` load balancing scheme. */ export interface Schema$ServerTlsPolicy { /** - * This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80. + * This field applies only for Traffic Director policies. It is must be set to false for Application Load Balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80. */ allowOpen?: boolean | null; /** @@ -1082,7 +1325,7 @@ export namespace networksecurity_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * This field is required if the policy is used with external HTTPS load balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. + * This field is required if the policy is used with Application Load Balancers. This field can be empty for Traffic Director. Defines a mechanism to provision peer validation certificates for peer to peer authentication (Mutual TLS - mTLS). If not specified, client certificate will not be requested. The connection is treated as TLS and not mTLS. If `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. */ mtlsPolicy?: Schema$MTLSPolicy; /** @@ -1090,7 +1333,7 @@ export namespace networksecurity_v1beta1 { */ name?: string | null; /** - * Optional if policy is to be used with Traffic Director. For external HTTPS load balancer must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported. + * Optional if policy is to be used with Traffic Director. For Application Load Balancers must be empty. Defines a mechanism to provision server identity (public and private keys). Cannot be combined with `allow_open` as a permissive mode that allows both plain text and TLS is not supported. */ serverCertificate?: Schema$GoogleCloudNetworksecurityV1beta1CertificateProvider; /** @@ -4252,6 +4495,7 @@ export namespace networksecurity_v1beta1 { context: APIRequestContext; addressGroups: Resource$Projects$Locations$Addressgroups; authorizationPolicies: Resource$Projects$Locations$Authorizationpolicies; + authzPolicies: Resource$Projects$Locations$Authzpolicies; clientTlsPolicies: Resource$Projects$Locations$Clienttlspolicies; firewallEndpointAssociations: Resource$Projects$Locations$Firewallendpointassociations; gatewaySecurityPolicies: Resource$Projects$Locations$Gatewaysecuritypolicies; @@ -4266,6 +4510,9 @@ export namespace networksecurity_v1beta1 { ); this.authorizationPolicies = new Resource$Projects$Locations$Authorizationpolicies(this.context); + this.authzPolicies = new Resource$Projects$Locations$Authzpolicies( + this.context + ); this.clientTlsPolicies = new Resource$Projects$Locations$Clienttlspolicies(this.context); this.firewallEndpointAssociations = @@ -6606,6 +6853,862 @@ export namespace networksecurity_v1beta1 { requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Authzpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new AuthzPolicy in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Authzpolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Authzpolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Authzpolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Authzpolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Authzpolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authzpolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/authzPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single AuthzPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Authzpolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Authzpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Authzpolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Authzpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Authzpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authzpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single AuthzPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Authzpolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Authzpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Authzpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authzpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Authzpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authzpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy( + callback: BodyResponseCallback + ): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists AuthzPolicies in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Authzpolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Authzpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Authzpolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authzpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Authzpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authzpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/authzPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single AuthzPolicy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Authzpolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Authzpolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Authzpolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Authzpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Authzpolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Authzpolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy( + callback: BodyResponseCallback + ): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networksecurity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Authzpolicies$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `AuthzPolicy` resource to be created. + */ + authzPolicyId?: string; + /** + * Required. The parent resource of the `AuthzPolicy` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AuthzPolicy; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Delete + extends StandardParameters { + /** + * Required. The name of the `AuthzPolicy` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/authzPolicies/{authz_policy\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Get + extends StandardParameters { + /** + * Required. A name of the `AuthzPolicy` resource to get. Must be in the format `projects/{project\}/locations/{location\}/authzPolicies/{authz_policy\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Getiampolicy + extends StandardParameters { + /** + * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `AuthzPolicy` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project\}/locations/{location\}/authzPolicies/{authz_policy\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AuthzPolicy; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Authzpolicies$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleIamV1TestIamPermissionsRequest; + } + export class Resource$Projects$Locations$Clienttlspolicies { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index a705b10037..ce932fafb5 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -239,7 +239,7 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + * Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. */ name?: string | null; /** @@ -376,7 +376,7 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. + * Identifier. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. */ name?: string | null; /** @@ -441,7 +441,7 @@ export namespace networkservices_v1 { */ meshes?: string[] | null; /** - * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` + * Identifier. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` */ name?: string | null; /** @@ -653,7 +653,7 @@ export namespace networkservices_v1 { */ meshes?: string[] | null; /** - * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + * Identifier. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. */ name?: string | null; /** @@ -1368,7 +1368,7 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. + * Identifier. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. */ name?: string | null; /** @@ -1476,7 +1476,7 @@ export namespace networkservices_v1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the ServiceBinding resource. It matches pattern `projects/x/locations/global/serviceBindings/service_binding_name`. + * Identifier. Name of the ServiceBinding resource. It matches pattern `projects/x/locations/global/serviceBindings/service_binding_name`. */ name?: string | null; /** @@ -1602,7 +1602,7 @@ export namespace networkservices_v1 { */ meshes?: string[] | null; /** - * Required. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. + * Identifier. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. */ name?: string | null; /** @@ -1717,7 +1717,7 @@ export namespace networkservices_v1 { */ meshes?: string[] | null; /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string | null; /** @@ -3295,96 +3295,6 @@ export namespace networkservices_v1 { } } - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Lists EndpointPolicies in a given project and location. * @@ -3569,60 +3479,128 @@ export namespace networkservices_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Create + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". + */ + endpointPolicyId?: string; + /** + * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Get + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$List + extends StandardParameters { + /** + * Maximum number of EndpointPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch + extends StandardParameters { + /** + * Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + + export class Resource$Projects$Locations$Gateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Gateway in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + create( + params?: Params$Resource$Projects$Locations$Gateways$Create, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Gateways$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Gateways$Create, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Gateways$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Gateways$Create; options = {}; } @@ -3636,7 +3614,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -3646,80 +3624,72 @@ export namespace networkservices_v1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Deletes a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + delete( + params?: Params$Resource$Projects$Locations$Gateways$Delete, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Gateways$Delete, + callback: BodyResponseCallback ): void; - testIamPermissions( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Gateways$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Gateways$Delete; options = {}; } @@ -3733,1620 +3703,8 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Endpointpolicies$Create - extends StandardParameters { - /** - * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". - */ - endpointPolicyId?: string; - /** - * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete - extends StandardParameters { - /** - * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Get - extends StandardParameters { - /** - * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$List - extends StandardParameters { - /** - * Maximum number of EndpointPolicies to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch - extends StandardParameters { - /** - * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Gateways { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new Gateway in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Gateways$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Gateways$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Gateways$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Gateways$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Gateways$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists Gateways in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Gateways$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single Gateway. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Gateways$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Gateways$Create - extends StandardParameters { - /** - * Required. Short name of the Gateway resource to be created. - */ - gatewayId?: string; - /** - * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Delete - extends StandardParameters { - /** - * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Get - extends StandardParameters { - /** - * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$List - extends StandardParameters { - /** - * Maximum number of Gateways to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Patch - extends StandardParameters { - /** - * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the Gateway 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Gateways$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Grpcroutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new GrpcRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Grpcroutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Grpcroutes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists GrpcRoutes in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Grpcroutes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Grpcroutes$Create - extends StandardParameters { - /** - * Required. Short name of the GrpcRoute resource to be created. - */ - grpcRouteId?: string; - /** - * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Delete - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Get - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$List - extends StandardParameters { - /** - * Maximum number of GrpcRoutes to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Patch - extends StandardParameters { - /** - * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - - export class Resource$Projects$Locations$Httproutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new HttpRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Httproutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single HttpRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Httproutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options @@ -5367,7 +3725,7 @@ export namespace networkservices_v1 { } /** - * Gets details of a single HttpRoute. + * Gets details of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5375,49 +3733,49 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Httproutes$Get, + params?: Params$Resource$Projects$Locations$Gateways$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Get; + {}) as Params$Resource$Projects$Locations$Gateways$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Get; + params = {} as Params$Resource$Projects$Locations$Gateways$Get; options = {}; } @@ -5443,17 +3801,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists HttpRoute in a given project and location. + * Lists Gateways in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5461,54 +3819,54 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Httproutes$List, + params?: Params$Resource$Projects$Locations$Gateways$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$List; + {}) as Params$Resource$Projects$Locations$Gateways$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$List; + params = {} as Params$Resource$Projects$Locations$Gateways$List; options = {}; } @@ -5522,7 +3880,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( + url: (rootUrl + '/v1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -5537,17 +3895,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single HttpRoute. + * Updates the parameters of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5555,31 +3913,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Httproutes$Patch, + params?: Params$Resource$Projects$Locations$Gateways$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Patch + | Params$Resource$Projects$Locations$Gateways$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5592,12 +3950,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Patch; + {}) as Params$Resource$Projects$Locations$Gateways$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; + params = {} as Params$Resource$Projects$Locations$Gateways$Patch; options = {}; } @@ -5633,76 +3991,76 @@ export namespace networkservices_v1 { } } - export interface Params$Resource$Projects$Locations$Httproutes$Create + export interface Params$Resource$Projects$Locations$Gateways$Create extends StandardParameters { /** - * Required. Short name of the HttpRoute resource to be created. + * Required. Short name of the Gateway resource to be created. */ - httpRouteId?: string; + gatewayId?: string; /** - * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export interface Params$Resource$Projects$Locations$Httproutes$Delete + export interface Params$Resource$Projects$Locations$Gateways$Delete extends StandardParameters { /** - * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Get + export interface Params$Resource$Projects$Locations$Gateways$Get extends StandardParameters { /** - * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$List + export interface Params$Resource$Projects$Locations$Gateways$List extends StandardParameters { /** - * Maximum number of HttpRoutes to return per call. + * Maximum number of Gateways to return per call. */ pageSize?: number; /** - * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Patch + export interface Params$Resource$Projects$Locations$Gateways$Patch extends StandardParameters { /** - * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + * Identifier. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute 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. + * Optional. Field mask is used to specify the fields to be overwritten in the Gateway 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. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export class Resource$Projects$Locations$Lbrouteextensions { + export class Resource$Projects$Locations$Grpcroutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbRouteExtension` resource in a given project and location. + * Creates a new GrpcRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5710,31 +4068,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params?: Params$Resource$Projects$Locations$Grpcroutes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | Params$Resource$Projects$Locations$Grpcroutes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5747,13 +4105,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; options = {}; } @@ -5767,7 +4124,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -5792,7 +4149,7 @@ export namespace networkservices_v1 { } /** - * Deletes the specified `LbRouteExtension` resource. + * Deletes a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5800,31 +4157,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | Params$Resource$Projects$Locations$Grpcroutes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5837,13 +4194,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; options = {}; } @@ -5879,7 +4235,7 @@ export namespace networkservices_v1 { } /** - * Gets details of the specified `LbRouteExtension` resource. + * Gets details of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5887,49 +4243,49 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params?: Params$Resource$Projects$Locations$Grpcroutes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; options = {}; } @@ -5955,17 +4311,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists `LbRouteExtension` resources in a given project and location. + * Lists GrpcRoutes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5973,57 +4329,54 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params?: Params$Resource$Projects$Locations$Grpcroutes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + {}) as Params$Resource$Projects$Locations$Grpcroutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; options = {}; } @@ -6037,7 +4390,7 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -6052,19 +4405,17 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbRouteExtension` resource. + * Updates the parameters of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6072,31 +4423,31 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | Params$Resource$Projects$Locations$Grpcroutes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6109,13 +4460,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; options = {}; } @@ -6151,147 +4501,301 @@ export namespace networkservices_v1 { } } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + export interface Params$Resource$Projects$Locations$Grpcroutes$Create extends StandardParameters { /** - * Required. User-provided ID of the `LbRouteExtension` resource to be created. + * Required. Short name of the GrpcRoute resource to be created. */ - lbRouteExtensionId?: string; + grpcRouteId?: string; /** - * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. */ parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + export interface Params$Resource$Projects$Locations$Grpcroutes$Delete extends StandardParameters { /** - * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + export interface Params$Resource$Projects$Locations$Grpcroutes$Get extends StandardParameters { /** - * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + export interface Params$Resource$Projects$Locations$Grpcroutes$List extends StandardParameters { /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + * Maximum number of GrpcRoutes to return per call. */ pageSize?: number; /** - * Optional. A token identifying a page of results that the server returns. + * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + export interface Params$Resource$Projects$Locations$Grpcroutes$Patch extends StandardParameters { /** - * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Identifier. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute 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. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export class Resource$Projects$Locations$Lbtrafficextensions { + export class Resource$Projects$Locations$Httproutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbTrafficExtension` resource in a given project and location. + * Creates a new HttpRoute in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Httproutes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single HttpRoute. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Httproutes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params?: Params$Resource$Projects$Locations$Httproutes$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {}) as Params$Resource$Projects$Locations$Httproutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + params = {} as Params$Resource$Projects$Locations$Httproutes$Get; options = {}; } @@ -6305,83 +4809,84 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified `LbTrafficExtension` resource. + * Lists HttpRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params?: Params$Resource$Projects$Locations$Httproutes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + {}) as Params$Resource$Projects$Locations$Httproutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Httproutes$List; options = {}; } @@ -6395,83 +4900,82 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of the specified `LbTrafficExtension` resource. + * Updates the parameters of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params?: Params$Resource$Projects$Locations$Httproutes$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + {}) as Params$Resource$Projects$Locations$Httproutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; options = {}; } @@ -6486,7 +4990,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -6497,75 +5001,137 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Httproutes$Create + extends StandardParameters { + /** + * Required. Short name of the HttpRoute resource to be created. + */ + httpRouteId?: string; + /** + * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + export interface Params$Resource$Projects$Locations$Httproutes$Delete + extends StandardParameters { + /** + * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Get + extends StandardParameters { + /** + * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$List + extends StandardParameters { + /** + * Maximum number of HttpRoutes to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Patch + extends StandardParameters { + /** + * Identifier. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + + export class Resource$Projects$Locations$Lbrouteextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists `LbTrafficExtension` resources in a given project and location. + * Creates a new `LbRouteExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; options = {}; } @@ -6579,11 +5145,11 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( + url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -6594,51 +5160,49 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbTrafficExtension` resource. + * Deletes the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -6651,13 +5215,13 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; options = {}; } @@ -6672,7 +5236,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -6691,148 +5255,59 @@ export namespace networkservices_v1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create - extends StandardParameters { - /** - * Required. User-provided ID of the `LbTrafficExtension` resource to be created. - */ - lbTrafficExtensionId?: string; - /** - * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - extends StandardParameters { - /** - * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get - extends StandardParameters { - /** - * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List - extends StandardParameters { - /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results that the server returns. - */ - pageToken?: string; - /** - * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch - extends StandardParameters { - /** - * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - - export class Resource$Projects$Locations$Meshes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new Mesh in a given project and location. + * Gets details of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Meshes$Create, + get( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Create; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Create; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; options = {}; } @@ -6846,82 +5321,87 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Mesh. + * Lists `LbRouteExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Delete; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; options = {}; } @@ -6935,79 +5415,85 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single Mesh. + * Updates the parameters of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Get; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Get; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; options = {}; } @@ -7022,7 +5508,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -7033,67 +5519,157 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `LbTrafficExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; options = {}; } @@ -7107,85 +5683,83 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Meshes in a given project and location. + * Deletes the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Meshes$List, + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Meshes$List, + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Meshes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$List; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$List; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; options = {}; } @@ -7199,82 +5773,83 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Mesh. + * Gets details of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Patch; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Patch; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; options = {}; } @@ -7289,7 +5864,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -7300,67 +5875,75 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists `LbTrafficExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; options = {}; } @@ -7374,90 +5957,85 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; options = {}; } @@ -7471,186 +6049,168 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Meshes$Create + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create extends StandardParameters { /** - * Required. Short name of the Mesh resource to be created. + * Required. User-provided ID of the `LbTrafficExtension` resource to be created. */ - meshId?: string; + lbTrafficExtensionId?: string; /** - * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$Mesh; + requestBody?: Schema$LbTrafficExtension; } - export interface Params$Resource$Projects$Locations$Meshes$Delete + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete extends StandardParameters { /** - * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Get + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get extends StandardParameters { /** - * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Getiampolicy + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Filtering results. */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Hint for how to order the results. */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Meshes$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Meshes to return per call. + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */ pageSize?: number; /** - * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + * Optional. A token identifying a page of results that the server returns. */ pageToken?: string; /** - * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Patch + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch extends StandardParameters { /** - * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. + * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the Mesh 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Mesh; - } - export interface Params$Resource$Projects$Locations$Meshes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Meshes$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$LbTrafficExtension; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Meshes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Creates a new Mesh in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Meshes$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Meshes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Meshes$Create; options = {}; } @@ -7664,29 +6224,32 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/meshes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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`. + * Deletes a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7694,49 +6257,135 @@ export namespace networkservices_v1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Meshes$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Meshes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Mesh. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Meshes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Meshes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Meshes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Meshes$Get; options = {}; } @@ -7751,7 +6400,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -7762,67 +6411,70 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists Meshes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Meshes$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Meshes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Meshes$List; options = {}; } @@ -7836,84 +6488,82 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/meshes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates the parameters of a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Meshes$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Meshes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Meshes$Patch; options = {}; } @@ -7927,11 +6577,8 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -7942,121 +6589,222 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Meshes$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. Short name of the Mesh resource to be created. */ - name?: string; + meshId?: string; + /** + * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$CancelOperationRequest; + requestBody?: Schema$Mesh; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Meshes$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Meshes$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Meshes$List extends StandardParameters { /** - * The standard list filter. + * Maximum number of Meshes to return per call. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Meshes$Patch + extends StandardParameters { + /** + * Identifier. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. */ name?: string; /** - * The standard list page size. + * Optional. Field mask is used to specify the fields to be overwritten in the Mesh 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. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$Mesh; } - export class Resource$Projects$Locations$Servicebindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a new ServiceBinding in a given project and location. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Create; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Create; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -8070,64 +6818,61 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceBinding. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Delete + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -8140,13 +6885,12 @@ export namespace networkservices_v1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Delete; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -8161,7 +6905,7 @@ export namespace networkservices_v1 { options: Object.assign( { url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -8182,57 +6926,62 @@ export namespace networkservices_v1 { } /** - * Gets details of a single ServiceBinding. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Get; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -8246,7 +6995,10 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -8258,68 +7010,121 @@ export namespace networkservices_v1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Servicebindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Servicebindings$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {} as Params$Resource$Projects$Locations$Servicebindings$Create; options = {}; } @@ -8333,89 +7138,83 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceBinding in a given project and location. + * Deletes a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params?: Params$Resource$Projects$Locations$Servicebindings$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$List; + {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$List; + params = + {} as Params$Resource$Projects$Locations$Servicebindings$Delete; options = {}; } @@ -8429,83 +7228,79 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets details of a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Servicebindings$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; options = {}; } @@ -8519,90 +7314,86 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Servicebindings$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Servicebindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Servicebindings$List; options = {}; } @@ -8616,27 +7407,27 @@ export namespace networkservices_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -8671,17 +7462,6 @@ export namespace networkservices_v1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } export interface Params$Resource$Projects$Locations$Servicebindings$List extends StandardParameters { /** @@ -8697,30 +7477,6 @@ export namespace networkservices_v1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } export class Resource$Projects$Locations$Servicelbpolicies { context: APIRequestContext; @@ -10048,7 +8804,7 @@ export namespace networkservices_v1 { export interface Params$Resource$Projects$Locations$Tcproutes$Patch extends StandardParameters { /** - * Required. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. + * Identifier. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. */ name?: string; /** @@ -10558,7 +9314,7 @@ export namespace networkservices_v1 { export interface Params$Resource$Projects$Locations$Tlsroutes$Patch extends StandardParameters { /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string; /** diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index dc178033b0..a4bef8549e 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -150,6 +150,63 @@ export namespace networkservices_v1beta1 { */ logType?: string | null; } + /** + * `AuthzExtension` is a resource that allows traffic forwarding to a callout backend to make an authorization decision. + */ + export interface Schema$AuthzExtension { + /** + * Required. The `:authority` header in the gRPC request sent from Envoy to the extension service. + */ + authority?: string | null; + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A human-readable description of the resource. + */ + description?: string | null; + /** + * Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. + */ + failOpen?: boolean | null; + /** + * Optional. List of the HTTP headers to forward to the extension (from the client). If omitted, all headers are sent. Each element is a string indicating the header name. + */ + forwardHeaders?: string[] | null; + /** + * Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources. + */ + labels?: {[key: string]: string} | null; + /** + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + */ + loadBalancingScheme?: string | null; + /** + * Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id\}` - substituted with the forwarding rule's fully qualified resource name. + */ + metadata?: {[key: string]: any} | null; + /** + * Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project\}/locations/{location\}/authzExtensions/{authz_extension\}`. + */ + name?: string | null; + /** + * Required. The reference to the service that runs the extension. Currently only callout extensions are supported here. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project\}/regions/{region\}/backendServices/{backendService\}` or `https://www.googleapis.com/compute/v1/projects/{project\}/global/backendServices/{backendService\}`. + */ + service?: string | null; + /** + * Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. + */ + timeout?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + /** + * Optional. The format of communication supported by the callout extension. If not specified, the default is `EXT_PROC_GRPC`. + */ + wireFormat?: string | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -213,7 +270,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + * Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. */ name?: string | null; /** @@ -350,7 +407,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. + * Identifier. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. */ name?: string | null; /** @@ -415,7 +472,7 @@ export namespace networkservices_v1beta1 { */ meshes?: string[] | null; /** - * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` + * Identifier. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` */ name?: string | null; /** @@ -627,7 +684,7 @@ export namespace networkservices_v1beta1 { */ meshes?: string[] | null; /** - * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + * Identifier. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. */ name?: string | null; /** @@ -1111,6 +1168,23 @@ export namespace networkservices_v1beta1 { */ updateTime?: string | null; } + /** + * Message for response to listing `AuthzExtension` resources. + */ + export interface Schema$ListAuthzExtensionsResponse { + /** + * The list of `AuthzExtension` resources. + */ + authzExtensions?: Schema$AuthzExtension[]; + /** + * A token identifying a page of results that the server returns. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response returned by the ListEndpointPolicies method. */ @@ -1342,7 +1416,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. + * Identifier. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. */ name?: string | null; /** @@ -1476,7 +1550,7 @@ export namespace networkservices_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Required. Name of the ServiceBinding resource. It matches pattern `projects/x/locations/global/serviceBindings/service_binding_name`. + * Identifier. Name of the ServiceBinding resource. It matches pattern `projects/x/locations/global/serviceBindings/service_binding_name`. */ name?: string | null; /** @@ -1602,7 +1676,7 @@ export namespace networkservices_v1beta1 { */ meshes?: string[] | null; /** - * Required. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. + * Identifier. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. */ name?: string | null; /** @@ -1717,7 +1791,7 @@ export namespace networkservices_v1beta1 { */ meshes?: string[] | null; /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string | null; /** @@ -1806,6 +1880,7 @@ export namespace networkservices_v1beta1 { export class Resource$Projects$Locations { context: APIRequestContext; + authzExtensions: Resource$Projects$Locations$Authzextensions; endpointPolicies: Resource$Projects$Locations$Endpointpolicies; gateways: Resource$Projects$Locations$Gateways; grpcRoutes: Resource$Projects$Locations$Grpcroutes; @@ -1820,6 +1895,9 @@ export namespace networkservices_v1beta1 { tlsRoutes: Resource$Projects$Locations$Tlsroutes; constructor(context: APIRequestContext) { this.context = context; + this.authzExtensions = new Resource$Projects$Locations$Authzextensions( + this.context + ); this.endpointPolicies = new Resource$Projects$Locations$Endpointpolicies( this.context ); @@ -2055,14 +2133,14 @@ export namespace networkservices_v1beta1 { pageToken?: string; } - export class Resource$Projects$Locations$Endpointpolicies { + export class Resource$Projects$Locations$Authzextensions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new EndpointPolicy in a given project and location. + * Creates a new `AuthzExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2070,31 +2148,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Endpointpolicies$Create, + params: Params$Resource$Projects$Locations$Authzextensions$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Create, + params?: Params$Resource$Projects$Locations$Authzextensions$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Endpointpolicies$Create, + params: Params$Resource$Projects$Locations$Authzextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Endpointpolicies$Create, + params: Params$Resource$Projects$Locations$Authzextensions$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Endpointpolicies$Create, + params: Params$Resource$Projects$Locations$Authzextensions$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Create + | Params$Resource$Projects$Locations$Authzextensions$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2107,13 +2185,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Create; + {}) as Params$Resource$Projects$Locations$Authzextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Create; + {} as Params$Resource$Projects$Locations$Authzextensions$Create; options = {}; } @@ -2127,7 +2205,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/endpointPolicies').replace( + url: (rootUrl + '/v1beta1/{+parent}/authzExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -2152,7 +2230,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes a single EndpointPolicy. + * Deletes the specified `AuthzExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2160,31 +2238,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, + params: Params$Resource$Projects$Locations$Authzextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Delete, + params?: Params$Resource$Projects$Locations$Authzextensions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, + params: Params$Resource$Projects$Locations$Authzextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, + params: Params$Resource$Projects$Locations$Authzextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, + params: Params$Resource$Projects$Locations$Authzextensions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Delete + | Params$Resource$Projects$Locations$Authzextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2197,13 +2275,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Delete; + {}) as Params$Resource$Projects$Locations$Authzextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Delete; + {} as Params$Resource$Projects$Locations$Authzextensions$Delete; options = {}; } @@ -2239,7 +2317,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of a single EndpointPolicy. + * Gets details of the specified `AuthzExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2247,49 +2325,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Endpointpolicies$Get, + params: Params$Resource$Projects$Locations$Authzextensions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Get, + params?: Params$Resource$Projects$Locations$Authzextensions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Endpointpolicies$Get, + params: Params$Resource$Projects$Locations$Authzextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpointpolicies$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authzextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Endpointpolicies$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authzextensions$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authzextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Get; + {}) as Params$Resource$Projects$Locations$Authzextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpointpolicies$Get; + params = {} as Params$Resource$Projects$Locations$Authzextensions$Get; options = {}; } @@ -2315,107 +2393,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists EndpointPolicies in a given project and location. + * Lists `AuthzExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2423,56 +2411,56 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Endpointpolicies$List, + params: Params$Resource$Projects$Locations$Authzextensions$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Endpointpolicies$List, + params?: Params$Resource$Projects$Locations$Authzextensions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Endpointpolicies$List, + params: Params$Resource$Projects$Locations$Authzextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Endpointpolicies$List, + params: Params$Resource$Projects$Locations$Authzextensions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Endpointpolicies$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Authzextensions$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Authzextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$List; + {}) as Params$Resource$Projects$Locations$Authzextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Endpointpolicies$List; + params = {} as Params$Resource$Projects$Locations$Authzextensions$List; options = {}; } @@ -2486,7 +2474,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/endpointPolicies').replace( + url: (rootUrl + '/v1beta1/{+parent}/authzExtensions').replace( /([^:]\/)\/+/g, '$1' ), @@ -2501,19 +2489,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single EndpointPolicy. + * Updates the parameters of the specified `AuthzExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2521,31 +2507,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + params: Params$Resource$Projects$Locations$Authzextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + params?: Params$Resource$Projects$Locations$Authzextensions$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + params: Params$Resource$Projects$Locations$Authzextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + params: Params$Resource$Projects$Locations$Authzextensions$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + params: Params$Resource$Projects$Locations$Authzextensions$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Patch + | Params$Resource$Projects$Locations$Authzextensions$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2558,13 +2544,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Patch; + {}) as Params$Resource$Projects$Locations$Authzextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Patch; + params = {} as Params$Resource$Projects$Locations$Authzextensions$Patch; options = {}; } @@ -2598,300 +2583,98 @@ export namespace networkservices_v1beta1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Authzextensions$Create + extends StandardParameters { /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * Required. User-provided ID of the `AuthzExtension` resource to be created. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Endpointpolicies$Create - extends StandardParameters { + authzExtensionId?: string; /** - * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". + * Required. The parent resource of the `AuthzExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ - endpointPolicyId?: string; + parent?: string; /** - * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - parent?: string; + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$EndpointPolicy; + requestBody?: Schema$AuthzExtension; } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete + export interface Params$Resource$Projects$Locations$Authzextensions$Delete extends StandardParameters { /** - * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + * Required. The name of the `AuthzExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/authzExtensions/{authz_extension\}`. */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Get + export interface Params$Resource$Projects$Locations$Authzextensions$Get extends StandardParameters { /** - * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + * Required. A name of the `AuthzExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/authzExtensions/{authz_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Getiampolicy + export interface Params$Resource$Projects$Locations$Authzextensions$List extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Filtering results. */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Hint for how to order the results. */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of EndpointPolicies to return per call. + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */ pageSize?: number; /** - * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. + * Optional. A token identifying a page of results that the server returns. */ pageToken?: string; /** - * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the `AuthzExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch + export interface Params$Resource$Projects$Locations$Authzextensions$Patch extends StandardParameters { /** - * Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + * Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project\}/locations/{location\}/authzExtensions/{authz_extension\}`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$EndpointPolicy; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Endpointpolicies$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Required. Used to specify the fields to be overwritten in the `AuthzExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$AuthzExtension; } - export class Resource$Projects$Locations$Gateways { + export class Resource$Projects$Locations$Endpointpolicies { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new Gateway in a given project and location. + * Creates a new EndpointPolicy in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2899,31 +2682,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Gateways$Create, + params: Params$Resource$Projects$Locations$Endpointpolicies$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Gateways$Create, + params?: Params$Resource$Projects$Locations$Endpointpolicies$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Gateways$Create, + params: Params$Resource$Projects$Locations$Endpointpolicies$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Gateways$Create, + params: Params$Resource$Projects$Locations$Endpointpolicies$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Gateways$Create, + params: Params$Resource$Projects$Locations$Endpointpolicies$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Create + | Params$Resource$Projects$Locations$Endpointpolicies$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -2936,12 +2719,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Create; + {}) as Params$Resource$Projects$Locations$Endpointpolicies$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Create; + params = + {} as Params$Resource$Projects$Locations$Endpointpolicies$Create; options = {}; } @@ -2955,7 +2739,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( + url: (rootUrl + '/v1beta1/{+parent}/endpointPolicies').replace( /([^:]\/)\/+/g, '$1' ), @@ -2980,7 +2764,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes a single Gateway. + * Deletes a single EndpointPolicy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2988,31 +2772,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, + params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Gateways$Delete, + params?: Params$Resource$Projects$Locations$Endpointpolicies$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, + params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, + params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Gateways$Delete, + params: Params$Resource$Projects$Locations$Endpointpolicies$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Delete + | Params$Resource$Projects$Locations$Endpointpolicies$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3025,12 +2809,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Delete; + {}) as Params$Resource$Projects$Locations$Endpointpolicies$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Delete; + params = + {} as Params$Resource$Projects$Locations$Endpointpolicies$Delete; options = {}; } @@ -3066,7 +2851,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of a single Gateway. + * Gets details of a single EndpointPolicy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3074,49 +2859,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Gateways$Get, + params: Params$Resource$Projects$Locations$Endpointpolicies$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Gateways$Get, + params?: Params$Resource$Projects$Locations$Endpointpolicies$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Gateways$Get, + params: Params$Resource$Projects$Locations$Endpointpolicies$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Gateways$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Endpointpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Gateways$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Endpointpolicies$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpointpolicies$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Get; + {}) as Params$Resource$Projects$Locations$Endpointpolicies$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Get; + params = {} as Params$Resource$Projects$Locations$Endpointpolicies$Get; options = {}; } @@ -3142,67 +2927,74 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Lists EndpointPolicies in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, + list( + params: Params$Resource$Projects$Locations$Endpointpolicies$List, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Getiampolicy, + list( + params?: Params$Resource$Projects$Locations$Endpointpolicies$List, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Endpointpolicies$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Endpointpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Getiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Endpointpolicies$List, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpointpolicies$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Endpointpolicies$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Endpointpolicies$List; options = {}; } @@ -3216,7 +3008,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/endpointPolicies').replace( /([^:]\/)\/+/g, '$1' ), @@ -3226,77 +3018,75 @@ export namespace networkservices_v1beta1 { options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists Gateways in a given project and location. + * Updates the parameters of a single EndpointPolicy. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Gateways$List, + patch( + params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Gateways$List, + patch( + params?: Params$Resource$Projects$Locations$Endpointpolicies$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Gateways$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Gateways$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Endpointpolicies$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Endpointpolicies$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$List; + {}) as Params$Resource$Projects$Locations$Endpointpolicies$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$List; + params = + {} as Params$Resource$Projects$Locations$Endpointpolicies$Patch; options = {}; } @@ -3310,64 +3100,130 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Create + extends StandardParameters { /** - * Updates the parameters of a single Gateway. + * Required. Short name of the EndpointPolicy resource to be created. E.g. "CustomECS". + */ + endpointPolicyId?: string; + /** + * Required. The parent resource of the EndpointPolicy. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Delete + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to delete. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Get + extends StandardParameters { + /** + * Required. A name of the EndpointPolicy to get. Must be in the format `projects/x/locations/global/endpointPolicies/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$List + extends StandardParameters { + /** + * Maximum number of EndpointPolicies to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListEndpointPoliciesResponse` Indicates that this is a continuation of a prior `ListEndpointPolicies` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the EndpointPolicies should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Endpointpolicies$Patch + extends StandardParameters { + /** + * Identifier. Name of the EndpointPolicy resource. It matches pattern `projects/{project\}/locations/global/endpointPolicies/{endpoint_policy\}`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the EndpointPolicy 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EndpointPolicy; + } + + export class Resource$Projects$Locations$Gateways { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new Gateway in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Gateways$Patch, + create( + params?: Params$Resource$Projects$Locations$Gateways$Create, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Gateways$Patch, + create( + params: Params$Resource$Projects$Locations$Gateways$Create, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Patch + | Params$Resource$Projects$Locations$Gateways$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -3380,12 +3236,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Patch; + {}) as Params$Resource$Projects$Locations$Gateways$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Patch; + params = {} as Params$Resource$Projects$Locations$Gateways$Create; options = {}; } @@ -3399,897 +3255,11 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions - ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Gateways$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Setiampolicy - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Gateways$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions - ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Gateways$Testiampermissions, - callback: BodyResponseCallback - ): void; - testIamPermissions( - callback: BodyResponseCallback - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Gateways$Testiampermissions - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Gateways$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Gateways$Create - extends StandardParameters { - /** - * Required. Short name of the Gateway resource to be created. - */ - gatewayId?: string; - /** - * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Delete - extends StandardParameters { - /** - * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Get - extends StandardParameters { - /** - * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$List - extends StandardParameters { - /** - * Maximum number of Gateways to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Gateways$Patch - extends StandardParameters { - /** - * Required. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the Gateway 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Gateway; - } - export interface Params$Resource$Projects$Locations$Gateways$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Gateways$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } - - export class Resource$Projects$Locations$Grpcroutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new GrpcRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Grpcroutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Grpcroutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Deletes a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Grpcroutes$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets details of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Grpcroutes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Grpcroutes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Lists GrpcRoutes in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Grpcroutes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Grpcroutes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Updates the parameters of a single GrpcRoute. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Projects$Locations$Grpcroutes$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Grpcroutes$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Projects$Locations$Grpcroutes$Create - extends StandardParameters { - /** - * Required. Short name of the GrpcRoute resource to be created. - */ - grpcRouteId?: string; - /** - * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Delete - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Get - extends StandardParameters { - /** - * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$List - extends StandardParameters { - /** - * Maximum number of GrpcRoutes to return per call. - */ - pageSize?: number; - /** - * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. - */ - pageToken?: string; - /** - * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Grpcroutes$Patch - extends StandardParameters { - /** - * Required. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` - */ - name?: string; - /** - * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GrpcRoute; - } - - export class Resource$Projects$Locations$Httproutes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Creates a new HttpRoute in a given project and location. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Httproutes$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Httproutes$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://networkservices.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options @@ -4310,7 +3280,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes a single HttpRoute. + * Deletes a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4318,31 +3288,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Httproutes$Delete, + params?: Params$Resource$Projects$Locations$Gateways$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, + params: Params$Resource$Projects$Locations$Gateways$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, + params: Params$Resource$Projects$Locations$Gateways$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Httproutes$Delete, + params: Params$Resource$Projects$Locations$Gateways$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Delete + | Params$Resource$Projects$Locations$Gateways$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4355,12 +3325,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Delete; + {}) as Params$Resource$Projects$Locations$Gateways$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + params = {} as Params$Resource$Projects$Locations$Gateways$Delete; options = {}; } @@ -4396,7 +3366,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of a single HttpRoute. + * Gets details of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4404,49 +3374,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Httproutes$Get, + params?: Params$Resource$Projects$Locations$Gateways$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, + params: Params$Resource$Projects$Locations$Gateways$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Httproutes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Get; + {}) as Params$Resource$Projects$Locations$Gateways$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Get; + params = {} as Params$Resource$Projects$Locations$Gateways$Get; options = {}; } @@ -4472,17 +3442,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists HttpRoute in a given project and location. + * Lists Gateways in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4490,54 +3460,54 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Httproutes$List, + params?: Params$Resource$Projects$Locations$Gateways$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, + params: Params$Resource$Projects$Locations$Gateways$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Httproutes$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Gateways$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Gateways$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$List; + {}) as Params$Resource$Projects$Locations$Gateways$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$List; + params = {} as Params$Resource$Projects$Locations$Gateways$List; options = {}; } @@ -4551,7 +3521,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( + url: (rootUrl + '/v1beta1/{+parent}/gateways').replace( /([^:]\/)\/+/g, '$1' ), @@ -4566,17 +3536,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single HttpRoute. + * Updates the parameters of a single Gateway. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4584,31 +3554,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Httproutes$Patch, + params?: Params$Resource$Projects$Locations$Gateways$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Httproutes$Patch, + params: Params$Resource$Projects$Locations$Gateways$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Httproutes$Patch + | Params$Resource$Projects$Locations$Gateways$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4621,12 +3591,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Httproutes$Patch; + {}) as Params$Resource$Projects$Locations$Gateways$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; + params = {} as Params$Resource$Projects$Locations$Gateways$Patch; options = {}; } @@ -4662,76 +3632,76 @@ export namespace networkservices_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Httproutes$Create + export interface Params$Resource$Projects$Locations$Gateways$Create extends StandardParameters { /** - * Required. Short name of the HttpRoute resource to be created. + * Required. Short name of the Gateway resource to be created. */ - httpRouteId?: string; + gatewayId?: string; /** - * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the Gateway. Must be in the format `projects/x/locations/x`. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export interface Params$Resource$Projects$Locations$Httproutes$Delete + export interface Params$Resource$Projects$Locations$Gateways$Delete extends StandardParameters { /** - * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to delete. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Get + export interface Params$Resource$Projects$Locations$Gateways$Get extends StandardParameters { /** - * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + * Required. A name of the Gateway to get. Must be in the format `projects/x/locations/x/gateways/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$List + export interface Params$Resource$Projects$Locations$Gateways$List extends StandardParameters { /** - * Maximum number of HttpRoutes to return per call. + * Maximum number of Gateways to return per call. */ pageSize?: number; /** - * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + * The value returned by the last `ListGatewaysResponse` Indicates that this is a continuation of a prior `ListGateways` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the Gateways should be listed, specified in the format `projects/x/locations/x`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Httproutes$Patch + export interface Params$Resource$Projects$Locations$Gateways$Patch extends StandardParameters { /** - * Required. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + * Identifier. Name of the Gateway resource. It matches pattern `projects/x/locations/x/gateways/`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute 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. + * Optional. Field mask is used to specify the fields to be overwritten in the Gateway 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. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$HttpRoute; + requestBody?: Schema$Gateway; } - export class Resource$Projects$Locations$Lbrouteextensions { + export class Resource$Projects$Locations$Grpcroutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbRouteExtension` resource in a given project and location. + * Creates a new GrpcRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4739,31 +3709,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params?: Params$Resource$Projects$Locations$Grpcroutes$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + params: Params$Resource$Projects$Locations$Grpcroutes$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | Params$Resource$Projects$Locations$Grpcroutes$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4776,13 +3746,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Create; options = {}; } @@ -4796,7 +3765,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -4821,7 +3790,7 @@ export namespace networkservices_v1beta1 { } /** - * Deletes the specified `LbRouteExtension` resource. + * Deletes a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4829,31 +3798,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params?: Params$Resource$Projects$Locations$Grpcroutes$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + params: Params$Resource$Projects$Locations$Grpcroutes$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | Params$Resource$Projects$Locations$Grpcroutes$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -4866,13 +3835,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Delete; options = {}; } @@ -4908,7 +3876,7 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of the specified `LbRouteExtension` resource. + * Gets details of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4916,49 +3884,49 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params?: Params$Resource$Projects$Locations$Grpcroutes$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + params: Params$Resource$Projects$Locations$Grpcroutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Get; options = {}; } @@ -4984,17 +3952,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists `LbRouteExtension` resources in a given project and location. + * Lists GrpcRoutes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5002,57 +3970,54 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params?: Params$Resource$Projects$Locations$Grpcroutes$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + params: Params$Resource$Projects$Locations$Grpcroutes$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbrouteextensions$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Grpcroutes$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Grpcroutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + {}) as Params$Resource$Projects$Locations$Grpcroutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$List; options = {}; } @@ -5066,7 +4031,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/grpcRoutes').replace( /([^:]\/)\/+/g, '$1' ), @@ -5081,19 +4046,17 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbRouteExtension` resource. + * Updates the parameters of a single GrpcRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5101,31 +4064,31 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params?: Params$Resource$Projects$Locations$Grpcroutes$Patch, options?: MethodOptions ): GaxiosPromise; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + params: Params$Resource$Projects$Locations$Grpcroutes$Patch, callback: BodyResponseCallback ): void; patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | Params$Resource$Projects$Locations$Grpcroutes$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5138,13 +4101,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + {}) as Params$Resource$Projects$Locations$Grpcroutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + params = {} as Params$Resource$Projects$Locations$Grpcroutes$Patch; options = {}; } @@ -5180,147 +4142,301 @@ export namespace networkservices_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + export interface Params$Resource$Projects$Locations$Grpcroutes$Create extends StandardParameters { /** - * Required. User-provided ID of the `LbRouteExtension` resource to be created. + * Required. Short name of the GrpcRoute resource to be created. */ - lbRouteExtensionId?: string; + grpcRouteId?: string; /** - * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + * Required. The parent resource of the GrpcRoute. Must be in the format `projects/x/locations/global`. */ parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + export interface Params$Resource$Projects$Locations$Grpcroutes$Delete extends StandardParameters { /** - * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to delete. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + export interface Params$Resource$Projects$Locations$Grpcroutes$Get extends StandardParameters { /** - * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Required. A name of the GrpcRoute to get. Must be in the format `projects/x/locations/global/grpcRoutes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + export interface Params$Resource$Projects$Locations$Grpcroutes$List extends StandardParameters { /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + * Maximum number of GrpcRoutes to return per call. */ pageSize?: number; /** - * Optional. A token identifying a page of results that the server returns. + * The value returned by the last `ListGrpcRoutesResponse` Indicates that this is a continuation of a prior `ListGrpcRoutes` call, and that the system should return the next page of data. */ pageToken?: string; /** - * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + * Required. The project and location from which the GrpcRoutes should be listed, specified in the format `projects/x/locations/global`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + export interface Params$Resource$Projects$Locations$Grpcroutes$Patch extends StandardParameters { /** - * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + * Identifier. Name of the GrpcRoute resource. It matches pattern `projects/x/locations/global/grpcRoutes/` */ name?: string; /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + * Optional. Field mask is used to specify the fields to be overwritten in the GrpcRoute 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. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LbRouteExtension; + requestBody?: Schema$GrpcRoute; } - export class Resource$Projects$Locations$Lbtrafficextensions { + export class Resource$Projects$Locations$Httproutes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a new `LbTrafficExtension` resource in a given project and location. + * Creates a new HttpRoute in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Httproutes$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Httproutes$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single HttpRoute. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Httproutes$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Httproutes$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Httproutes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Httproutes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Httproutes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + get( + params?: Params$Resource$Projects$Locations$Httproutes$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Httproutes$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + {}) as Params$Resource$Projects$Locations$Httproutes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + params = {} as Params$Resource$Projects$Locations$Httproutes$Get; options = {}; } @@ -5334,83 +4450,84 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes the specified `LbTrafficExtension` resource. + * Lists HttpRoute in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + list( + params?: Params$Resource$Projects$Locations$Httproutes$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Httproutes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Httproutes$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + {}) as Params$Resource$Projects$Locations$Httproutes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + params = {} as Params$Resource$Projects$Locations$Httproutes$List; options = {}; } @@ -5424,83 +4541,82 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/httpRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets details of the specified `LbTrafficExtension` resource. + * Updates the parameters of a single HttpRoute. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + patch( + params?: Params$Resource$Projects$Locations$Httproutes$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Httproutes$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Httproutes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + {}) as Params$Resource$Projects$Locations$Httproutes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + params = {} as Params$Resource$Projects$Locations$Httproutes$Patch; options = {}; } @@ -5515,7 +4631,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -5526,75 +4642,137 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + + export interface Params$Resource$Projects$Locations$Httproutes$Create + extends StandardParameters { + /** + * Required. Short name of the HttpRoute resource to be created. + */ + httpRouteId?: string; + /** + * Required. The parent resource of the HttpRoute. Must be in the format `projects/x/locations/global`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + export interface Params$Resource$Projects$Locations$Httproutes$Delete + extends StandardParameters { + /** + * Required. A name of the HttpRoute to delete. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Get + extends StandardParameters { + /** + * Required. A name of the HttpRoute to get. Must be in the format `projects/x/locations/global/httpRoutes/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$List + extends StandardParameters { + /** + * Maximum number of HttpRoutes to return per call. + */ + pageSize?: number; + /** + * The value returned by the last `ListHttpRoutesResponse` Indicates that this is a continuation of a prior `ListHttpRoutes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the HttpRoutes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Httproutes$Patch + extends StandardParameters { + /** + * Identifier. Name of the HttpRoute resource. It matches pattern `projects/x/locations/global/httpRoutes/http_route_name\>`. + */ + name?: string; + /** + * Optional. Field mask is used to specify the fields to be overwritten in the HttpRoute 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. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HttpRoute; + } + + export class Resource$Projects$Locations$Lbrouteextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Lists `LbTrafficExtension` resources in a given project and location. + * Creates a new `LbRouteExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + create( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; options = {}; } @@ -5608,11 +4786,11 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options @@ -5623,51 +4801,49 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Updates the parameters of the specified `LbTrafficExtension` resource. + * Deletes the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -5680,13 +4856,13 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; options = {}; } @@ -5701,7 +4877,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'DELETE', apiVersion: '', }, options @@ -5720,148 +4896,59 @@ export namespace networkservices_v1beta1 { return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create - extends StandardParameters { - /** - * Required. User-provided ID of the `LbTrafficExtension` resource to be created. - */ - lbTrafficExtensionId?: string; - /** - * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. - */ - parent?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete - extends StandardParameters { - /** - * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get - extends StandardParameters { - /** - * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List - extends StandardParameters { - /** - * Optional. Filtering results. - */ - filter?: string; - /** - * Optional. Hint for how to order the results. - */ - orderBy?: string; - /** - * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. - */ - pageSize?: number; - /** - * Optional. A token identifying a page of results that the server returns. - */ - pageToken?: string; - /** - * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. - */ - parent?: string; - } - export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch - extends StandardParameters { - /** - * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. - */ - name?: string; - /** - * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LbTrafficExtension; - } - - export class Resource$Projects$Locations$Meshes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * Creates a new Mesh in a given project and location. + * Gets details of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Meshes$Create, + get( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Meshes$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Create; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Create; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; options = {}; } @@ -5875,82 +4962,87 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single Mesh. + * Lists `LbRouteExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Meshes$Delete, + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Meshes$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Delete; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; options = {}; } @@ -5964,79 +5056,85 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets details of a single Mesh. + * Updates the parameters of the specified `LbRouteExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Meshes$Get, + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Meshes$Get, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Get; + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Get; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; options = {}; } @@ -6051,7 +5149,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -6062,67 +5160,157 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Identifier. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `LbTrafficExtension` resource in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Getiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; options = {}; } @@ -6136,85 +5324,83 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists Meshes in a given project and location. + * Deletes the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Meshes$List, + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Meshes$List, + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Meshes$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Meshes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$List; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$List; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; options = {}; } @@ -6228,82 +5414,83 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates the parameters of a single Mesh. + * Gets details of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Projects$Locations$Meshes$Patch, + get( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Projects$Locations$Meshes$Patch, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Patch - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Patch; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Patch; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; options = {}; } @@ -6318,7 +5505,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'GET', apiVersion: '', }, options @@ -6329,67 +5516,75 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Lists `LbTrafficExtension` resources in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + list( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Meshes$Setiampolicy, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Meshes$Setiampolicy; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; options = {}; } @@ -6403,90 +5598,85 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Updates the parameters of the specified `LbTrafficExtension` resource. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + patch( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Meshes$Testiampermissions, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + callback: BodyResponseCallback ): void; - testIamPermissions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Meshes$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Meshes$Testiampermissions; + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; options = {}; } @@ -6500,186 +5690,168 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Meshes$Create + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create extends StandardParameters { /** - * Required. Short name of the Mesh resource to be created. + * Required. User-provided ID of the `LbTrafficExtension` resource to be created. */ - meshId?: string; + lbTrafficExtensionId?: string; /** - * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. */ parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; /** * Request body metadata */ - requestBody?: Schema$Mesh; + requestBody?: Schema$LbTrafficExtension; } - export interface Params$Resource$Projects$Locations$Meshes$Delete + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete extends StandardParameters { /** - * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Get + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get extends StandardParameters { /** - * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. + * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Getiampolicy + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List extends StandardParameters { /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). + * Optional. Filtering results. */ - 'options.requestedPolicyVersion'?: number; + filter?: string; /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Hint for how to order the results. */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Meshes$List - extends StandardParameters { + orderBy?: string; /** - * Maximum number of Meshes to return per call. + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. */ pageSize?: number; /** - * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + * Optional. A token identifying a page of results that the server returns. */ pageToken?: string; /** - * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. */ parent?: string; } - export interface Params$Resource$Projects$Locations$Meshes$Patch + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch extends StandardParameters { /** - * Required. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. + * Required. Identifier. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. */ name?: string; /** - * Optional. Field mask is used to specify the fields to be overwritten in the Mesh 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. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Mesh; - } - export interface Params$Resource$Projects$Locations$Meshes$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Meshes$Testiampermissions - extends StandardParameters { + requestId?: string; /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. + * Optional. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. */ - resource?: string; + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$TestIamPermissionsRequest; + requestBody?: Schema$LbTrafficExtension; } - export class Resource$Projects$Locations$Operations { + export class Resource$Projects$Locations$Meshes { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * 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`. + * Creates a new Mesh in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Meshes$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Meshes$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Meshes$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Meshes$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + params = {} as Params$Resource$Projects$Locations$Meshes$Create; options = {}; } @@ -6693,7 +5865,7 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( /([^:]\/)\/+/g, '$1' ), @@ -6703,22 +5875,22 @@ export namespace networkservices_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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`. + * Deletes a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6726,49 +5898,135 @@ export namespace networkservices_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Operations$Delete, + params?: Params$Resource$Projects$Locations$Meshes$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, + params: Params$Resource$Projects$Locations$Meshes$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Meshes$Delete, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; + delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Meshes$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Meshes$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single Mesh. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Meshes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Meshes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Meshes$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Meshes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Meshes$Get; options = {}; } @@ -6783,7 +6041,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -6794,67 +6052,70 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Lists Meshes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Operations$Get, + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Operations$Get, + list( + params?: Params$Resource$Projects$Locations$Meshes$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Operations$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Meshes$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Operations$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Meshes$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$Get; + {}) as Params$Resource$Projects$Locations$Meshes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Meshes$List; options = {}; } @@ -6868,84 +6129,82 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+parent}/meshes').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Updates the parameters of a single Mesh. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Operations$List, + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Operations$List, + patch( + params?: Params$Resource$Projects$Locations$Meshes$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Operations$List, + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Operations$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Meshes$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Meshes$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Operations$List; + {}) as Params$Resource$Projects$Locations$Meshes$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Operations$List; + params = {} as Params$Resource$Projects$Locations$Meshes$Patch; options = {}; } @@ -6959,11 +6218,8 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', apiVersion: '', }, options @@ -6974,121 +6230,225 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Operations$Cancel + export interface Params$Resource$Projects$Locations$Meshes$Create extends StandardParameters { /** - * The name of the operation resource to be cancelled. + * Required. Short name of the Mesh resource to be created. */ - name?: string; + meshId?: string; + /** + * Required. The parent resource of the Mesh. Must be in the format `projects/x/locations/global`. + */ + parent?: string; /** * Request body metadata */ - requestBody?: Schema$CancelOperationRequest; + requestBody?: Schema$Mesh; } - export interface Params$Resource$Projects$Locations$Operations$Delete + export interface Params$Resource$Projects$Locations$Meshes$Delete extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. A name of the Mesh to delete. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$Get + export interface Params$Resource$Projects$Locations$Meshes$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. A name of the Mesh to get. Must be in the format `projects/x/locations/global/meshes/x`. */ name?: string; } - export interface Params$Resource$Projects$Locations$Operations$List + export interface Params$Resource$Projects$Locations$Meshes$List extends StandardParameters { /** - * The standard list filter. + * Maximum number of Meshes to return per call. */ - filter?: string; + pageSize?: number; /** - * The name of the operation's parent resource. + * The value returned by the last `ListMeshesResponse` Indicates that this is a continuation of a prior `ListMeshes` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. The project and location from which the Meshes should be listed, specified in the format `projects/x/locations/global`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Meshes$Patch + extends StandardParameters { + /** + * Identifier. Name of the Mesh resource. It matches pattern `projects/x/locations/global/meshes/`. */ name?: string; /** - * The standard list page size. + * Optional. Field mask is used to specify the fields to be overwritten in the Mesh 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. */ - pageSize?: number; + updateMask?: string; + /** - * The standard list page token. + * Request body metadata */ - pageToken?: string; + requestBody?: Schema$Mesh; } - export class Resource$Projects$Locations$Servicebindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Creates a new ServiceBinding in a given project and location. + * 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`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions ): GaxiosPromise; - create( - params?: Params$Resource$Projects$Locations$Servicebindings$Create, + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Projects$Locations$Servicebindings$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Create - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Create; + {}) as Params$Resource$Projects$Locations$Operations$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Create; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; options = {}; } @@ -7102,64 +6462,61 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a single ServiceBinding. + * 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. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions ): GaxiosPromise; - delete( - params?: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params?: Params$Resource$Projects$Locations$Operations$Get, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Projects$Locations$Servicebindings$Delete, + get( + params: Params$Resource$Projects$Locations$Operations$Get, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Delete + | Params$Resource$Projects$Locations$Operations$Get | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -7172,13 +6529,12 @@ export namespace networkservices_v1beta1 { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; + {}) as Params$Resource$Projects$Locations$Operations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Delete; + params = {} as Params$Resource$Projects$Locations$Operations$Get; options = {}; } @@ -7193,7 +6549,7 @@ export namespace networkservices_v1beta1 { options: Object.assign( { url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options @@ -7214,57 +6570,62 @@ export namespace networkservices_v1beta1 { } /** - * Gets details of a single ServiceBinding. + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Projects$Locations$Servicebindings$Get, + list( + params?: Params$Resource$Projects$Locations$Operations$List, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Servicebindings$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): + | void + | GaxiosPromise + | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Get; + {}) as Params$Resource$Projects$Locations$Operations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; + params = {} as Params$Resource$Projects$Locations$Operations$List; options = {}; } @@ -7278,7 +6639,10 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', apiVersion: '', }, @@ -7290,68 +6654,121 @@ export namespace networkservices_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Servicebindings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Servicebindings$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Servicebindings$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Servicebindings$Getiampolicy; + {} as Params$Resource$Projects$Locations$Servicebindings$Create; options = {}; } @@ -7365,89 +6782,83 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists ServiceBinding in a given project and location. + * Deletes a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Projects$Locations$Servicebindings$List, + delete( + params?: Params$Resource$Projects$Locations$Servicebindings$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Servicebindings$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Servicebindings$Delete, + callback: BodyResponseCallback ): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$List; + {}) as Params$Resource$Projects$Locations$Servicebindings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Servicebindings$List; + params = + {} as Params$Resource$Projects$Locations$Servicebindings$Delete; options = {}; } @@ -7461,83 +6872,79 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Gets details of a single ServiceBinding. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Servicebindings$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Servicebindings$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Servicebindings$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Servicebindings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Servicebindings$Get; options = {}; } @@ -7551,90 +6958,86 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. + * Lists ServiceBinding in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions ): GaxiosPromise; - testIamPermissions( - params?: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Servicebindings$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Servicebindings$Testiampermissions, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Servicebindings$List, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - testIamPermissions( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - | BodyResponseCallback + | Params$Resource$Projects$Locations$Servicebindings$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Servicebindings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Servicebindings$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Servicebindings$List; options = {}; } @@ -7648,27 +7051,27 @@ export namespace networkservices_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1beta1/{+parent}/serviceBindings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } @@ -7703,17 +7106,6 @@ export namespace networkservices_v1beta1 { */ name?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Getiampolicy - extends StandardParameters { - /** - * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - } export interface Params$Resource$Projects$Locations$Servicebindings$List extends StandardParameters { /** @@ -7729,30 +7121,6 @@ export namespace networkservices_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Servicebindings$Setiampolicy - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SetIamPolicyRequest; - } - export interface Params$Resource$Projects$Locations$Servicebindings$Testiampermissions - extends StandardParameters { - /** - * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. - */ - resource?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$TestIamPermissionsRequest; - } export class Resource$Projects$Locations$Servicelbpolicies { context: APIRequestContext; @@ -9080,7 +8448,7 @@ export namespace networkservices_v1beta1 { export interface Params$Resource$Projects$Locations$Tcproutes$Patch extends StandardParameters { /** - * Required. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. + * Identifier. Name of the TcpRoute resource. It matches pattern `projects/x/locations/global/tcpRoutes/tcp_route_name\>`. */ name?: string; /** @@ -9590,7 +8958,7 @@ export namespace networkservices_v1beta1 { export interface Params$Resource$Projects$Locations$Tlsroutes$Patch extends StandardParameters { /** - * Required. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. + * Identifier. Name of the TlsRoute resource. It matches pattern `projects/x/locations/global/tlsRoutes/tls_route_name\>`. */ name?: string; /** diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index bc110cf544..f9f84b188c 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -389,6 +389,10 @@ export namespace notebooks_v2 { * Optional. Custom metadata to apply to this instance. */ metadata?: {[key: string]: string} | null; + /** + * Optional. The minimum CPU platform to use for this instance. The list of valid values can be found in https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform#availablezones + */ + minCpuPlatform?: string | null; /** * Optional. The network interfaces for the VM. Supports only one interface. */ diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index e5636cc536..7fc3a2dfe8 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -541,10 +541,6 @@ export namespace ondemandscanning_v1 { * The status of an SBOM generation. */ sbomStatus?: Schema$SBOMStatus; - /** - * The status of an vulnerability attestation generation. - */ - vulnerabilityAttestation?: Schema$VulnerabilityAttestation; } /** * Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. @@ -1653,23 +1649,6 @@ export namespace ondemandscanning_v1 { */ vulnerabilityId?: string | null; } - /** - * The status of an vulnerability attestation generation. - */ - export interface Schema$VulnerabilityAttestation { - /** - * If failure, the error reason for why the attestation generation failed. - */ - error?: string | null; - /** - * The last time we attempted to generate an attestation. - */ - lastAttemptTime?: string | null; - /** - * The success/failure state of the latest attestation attempt. - */ - state?: string | null; - } /** * An occurrence of a severity vulnerability on a resource. */ diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index f0e997d02b..5c7bd6fc2f 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -537,10 +537,6 @@ export namespace ondemandscanning_v1beta1 { * The status of an SBOM generation. */ sbomStatus?: Schema$SBOMStatus; - /** - * The status of an vulnerability attestation generation. - */ - vulnerabilityAttestation?: Schema$VulnerabilityAttestation; } /** * Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. @@ -1649,23 +1645,6 @@ export namespace ondemandscanning_v1beta1 { */ vulnerabilityId?: string | null; } - /** - * The status of an vulnerability attestation generation. - */ - export interface Schema$VulnerabilityAttestation { - /** - * If failure, the error reason for why the attestation generation failed. - */ - error?: string | null; - /** - * The last time we attempted to generate an attestation. - */ - lastAttemptTime?: string | null; - /** - * The success/failure state of the latest attestation attempt. - */ - state?: string | null; - } /** * An occurrence of a severity vulnerability on a resource. */ diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 49f66ab656..e336632cc6 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -881,7 +881,7 @@ export namespace places_v1 { */ export interface Schema$GoogleMapsPlacesV1PlaceOpeningHours { /** - * Is this place open right now? Always present unless we lack time-of-day or timezone data for these opening hours. + * Whether the opening hours period is currently active. For regular opening hours and current opening hours, this field means whether the place is open. For secondary opening hours and current secondary opening hours, this field means whether the secondary hours of this place is active. */ openNow?: boolean | null; /** diff --git a/src/apis/playdeveloperreporting/v1alpha1.ts b/src/apis/playdeveloperreporting/v1alpha1.ts index f546f25708..ff32490d47 100644 --- a/src/apis/playdeveloperreporting/v1alpha1.ts +++ b/src/apis/playdeveloperreporting/v1alpha1.ts @@ -576,11 +576,11 @@ export namespace playdeveloperreporting_v1alpha1 { */ export interface Schema$GooglePlayDeveloperReportingV1alpha1QueryErrorCountMetricSetRequest { /** - * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. + * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. */ dimensions?: string[] | null; /** - * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions. + * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. */ filter?: string | null; /** diff --git a/src/apis/playdeveloperreporting/v1beta1.ts b/src/apis/playdeveloperreporting/v1beta1.ts index f2c395d6b7..a43b428715 100644 --- a/src/apis/playdeveloperreporting/v1beta1.ts +++ b/src/apis/playdeveloperreporting/v1beta1.ts @@ -576,11 +576,11 @@ export namespace playdeveloperreporting_v1beta1 { */ export interface Schema$GooglePlayDeveloperReportingV1beta1QueryErrorCountMetricSetRequest { /** - * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. + * Dimensions to slice the data by. **Supported dimensions:** * `apiLevel` (string): the API level of Android that was running on the user's device, e.g., 26. * `versionCode` (int64): unique identifier of the user's device model. The form of the identifier is 'deviceBrand/device', where deviceBrand corresponds to Build.BRAND and device corresponds to Build.DEVICE, e.g., google/coral. * `deviceModel` (string): unique identifier of the user's device model. * `deviceType` (string): identifier of the device's form factor, e.g., PHONE. * `reportType` (string): the type of error. The value should correspond to one of the possible values in ErrorType. * `issueId` (string): the id an error was assigned to. The value should correspond to the `{issue\}` component of the issue name. * `deviceRamBucket` (int64): RAM of the device, in MB, in buckets (3GB, 4GB, etc.). * `deviceSocMake` (string): Make of the device's primary system-on-chip, e.g., Samsung. [Reference](https://developer.android.com/reference/android/os/Build#SOC_MANUFACTURER) * `deviceSocModel` (string): Model of the device's primary system-on-chip, e.g., "Exynos 2100". [Reference](https://developer.android.com/reference/android/os/Build#SOC_MODEL) * `deviceCpuMake` (string): Make of the device's CPU, e.g., Qualcomm. * `deviceCpuModel` (string): Model of the device's CPU, e.g., "Kryo 240". * `deviceGpuMake` (string): Make of the device's GPU, e.g., ARM. * `deviceGpuModel` (string): Model of the device's GPU, e.g., Mali. * `deviceGpuVersion` (string): Version of the device's GPU, e.g., T750. * `deviceVulkanVersion` (string): Vulkan version of the device, e.g., "4198400". * `deviceGlEsVersion` (string): OpenGL ES version of the device, e.g., "196610". * `deviceScreenSize` (string): Screen size of the device, e.g., NORMAL, LARGE. * `deviceScreenDpi` (string): Screen density of the device, e.g., mdpi, hdpi. */ dimensions?: string[] | null; /** - * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions. + * Filters to apply to data. The filtering expression follows [AIP-160](https://google.aip.dev/160) standard and supports filtering by equality of all breakdown dimensions and: * `isUserPerceived` (string): denotes whether error is user perceived or not, USER_PERCEIVED or NOT_USER_PERCEIVED. */ filter?: string | null; /** diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 2f7acbba05..dbf5cec16a 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -112,6 +112,7 @@ export namespace playintegrity_v1 { */ export class Playintegrity { context: APIRequestContext; + deviceRecall: Resource$Devicerecall; v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -120,6 +121,7 @@ export namespace playintegrity_v1 { google, }; + this.deviceRecall = new Resource$Devicerecall(this.context); this.v1 = new Resource$V1(this.context); } } @@ -203,9 +205,13 @@ export namespace playintegrity_v1 { tokenPayloadExternal?: Schema$TokenPayloadExternal; } /** - * Contains the device attestation information. Next tag: 4 + * Contains the device attestation information. */ export interface Schema$DeviceIntegrity { + /** + * Details about the device recall bits set by the developer. + */ + deviceRecall?: Schema$DeviceRecall; /** * Details about the integrity of the device the app is running on. */ @@ -215,6 +221,19 @@ export namespace playintegrity_v1 { */ recentDeviceActivity?: Schema$RecentDeviceActivity; } + /** + * Contains the recall bits per device set by the developer. + */ + export interface Schema$DeviceRecall { + /** + * Required. Contains the recall bits values. + */ + values?: Schema$Values; + /** + * Required. Contains the recall bits write dates. + */ + writeDates?: Schema$WriteDates; + } /** * Contains information about the environment Play Integrity API runs in, e.g. Play Protect verdict. */ @@ -296,6 +315,173 @@ export namespace playintegrity_v1 { */ testingDetails?: Schema$TestingDetails; } + /** + * Contains the recall bits values. + */ + export interface Schema$Values { + /** + * Required. First recall bit value. + */ + bitFirst?: boolean | null; + /** + * Required. Second recall bit value. + */ + bitSecond?: boolean | null; + /** + * Required. Third recall bit value. + */ + bitThird?: boolean | null; + } + /** + * Contains the recall bits write dates. + */ + export interface Schema$WriteDates { + /** + * Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the first bit. Note that this value won't be set if the first bit is false. + */ + yyyymmFirst?: number | null; + /** + * Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the second bit. Note that this value won't be set if the second bit is false. + */ + yyyymmSecond?: number | null; + /** + * Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the third bit. Note that this value won't be set if the third bit is false. + */ + yyyymmThird?: number | null; + } + /** + * Request to write device recall bits. + */ + export interface Schema$WriteDeviceRecallRequest { + /** + * Required. Integrity token obtained from calling Play Integrity API. + */ + integrityToken?: string | null; + /** + * Required. The new values for the device recall bits to be written. + */ + newValues?: Schema$Values; + } + /** + * Response for the Write Device Recall action. Currently empty. + */ + export interface Schema$WriteDeviceRecallResponse {} + + export class Resource$Devicerecall { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + write( + params: Params$Resource$Devicerecall$Write, + options: StreamMethodOptions + ): GaxiosPromise; + write( + params?: Params$Resource$Devicerecall$Write, + options?: MethodOptions + ): GaxiosPromise; + write( + params: Params$Resource$Devicerecall$Write, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Devicerecall$Write, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + write( + params: Params$Resource$Devicerecall$Write, + callback: BodyResponseCallback + ): void; + write( + callback: BodyResponseCallback + ): void; + write( + paramsOrCallback?: + | Params$Resource$Devicerecall$Write + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Devicerecall$Write; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Devicerecall$Write; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://playintegrity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+packageName}/deviceRecall:write').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['packageName'], + pathParams: ['packageName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Devicerecall$Write + extends StandardParameters { + /** + * Required. Package name of the app the attached integrity token belongs to. + */ + packageName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WriteDeviceRecallRequest; + } export class Resource$V1 { context: APIRequestContext; diff --git a/src/apis/pollen/v1.ts b/src/apis/pollen/v1.ts index 70b68bba1d..880228cc62 100644 --- a/src/apis/pollen/v1.ts +++ b/src/apis/pollen/v1.ts @@ -173,11 +173,11 @@ export namespace pollen_v1 { */ date?: Schema$Date; /** - * This list will include (up to) 15 pollen species affecting the location specified in the request. + * This list will include up to 15 pollen species affecting the location specified in the request. */ plantInfo?: Schema$PlantInfo[]; /** - * This list will include (up to) three pollen types (grass, weed, tree) affecting the location specified in the request. + * This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request. */ pollenTypeInfo?: Schema$PollenTypeInfo[]; } @@ -434,7 +434,7 @@ export namespace pollen_v1 { */ days?: number; /** - * Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. Default value is "en". + * Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is "en". */ languageCode?: string; /** @@ -446,15 +446,15 @@ export namespace pollen_v1 { */ 'location.longitude'?: number; /** - * Optional. The maximum number of daily info records to return per page. The default and max value is 5 (5 days of data). + * Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data. */ pageSize?: number; /** - * Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token all other request parameters provided must match the previous call that provided the page token. + * Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token. */ pageToken?: string; /** - * Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. + * Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is "true". */ plantsDescription?: boolean; } diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 6096aca179..4809a8b99d 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -266,6 +266,10 @@ export namespace pubsub_v1 { * Optional. The maximum duration that can elapse before a new Cloud Storage file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not exceed the subscription's acknowledgement deadline. */ maxDuration?: string | null; + /** + * Optional. The maximum number of messages that can be written to a Cloud Storage file before a new file is created. Min 1000 messages. + */ + maxMessages?: string | null; /** * Optional. The service account to use to write to Cloud Storage. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number\}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. */ diff --git a/src/apis/realtimebidding/v1.ts b/src/apis/realtimebidding/v1.ts index dea08e3a85..c5ff18355c 100644 --- a/src/apis/realtimebidding/v1.ts +++ b/src/apis/realtimebidding/v1.ts @@ -440,6 +440,14 @@ export namespace realtimebidding_v1 { * Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction. */ detectedAttributes?: string[] | null; + /** + * Output only. IDs of the detected categories, if any. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Can be used to filter the response of the creatives.list method. + */ + detectedCategories?: string[] | null; + /** + * Output only. The taxonomy in which the detected_categories field is expressed. + */ + detectedCategoriesTaxonomy?: string | null; /** * The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method. */ diff --git a/src/apis/recaptchaenterprise/v1.ts b/src/apis/recaptchaenterprise/v1.ts index 7ad883124b..f69f3c4a5c 100644 --- a/src/apis/recaptchaenterprise/v1.ts +++ b/src/apis/recaptchaenterprise/v1.ts @@ -154,6 +154,19 @@ export namespace recaptchaenterprise_v1 { */ username?: string | null; } + /** + * The AddIpOverride request message. + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest { + /** + * Required. IP override added to the key. + */ + ipOverrideData?: Schema$GoogleCloudRecaptchaenterpriseV1IpOverrideData; + } + /** + * Response for AddIpOverride. + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse {} /** * Settings specific to keys that can be used by Android apps. */ @@ -229,6 +242,10 @@ export namespace recaptchaenterprise_v1 { * Optional. Account verification information for identity verification. The assessment event must include a token and site key to use this feature. */ accountVerification?: Schema$GoogleCloudRecaptchaenterpriseV1AccountVerificationInfo; + /** + * Optional. The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. + */ + assessmentEnvironment?: Schema$GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment; /** * Optional. The event being assessed. */ @@ -266,6 +283,19 @@ export namespace recaptchaenterprise_v1 { */ tokenProperties?: Schema$GoogleCloudRecaptchaenterpriseV1TokenProperties; } + /** + * The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user. + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1AssessmentEnvironment { + /** + * Optional. Identifies the client module initiating the CreateAssessment request. This can be the link to the client module's project. Examples include: - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager" - "cloud.google.com/recaptcha/docs/implement-waf-akamai" - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare" - "wordpress.org/plugins/recaptcha-something" + */ + client?: string | null; + /** + * Optional. The version of the client module. For example, "1.0.0". + */ + version?: string | null; + } /** * Metrics related to challenges. */ @@ -578,6 +608,19 @@ export namespace recaptchaenterprise_v1 { */ appleDeveloperId?: Schema$GoogleCloudRecaptchaenterpriseV1AppleDeveloperId; } + /** + * Information about the IP or IP range override. + */ + export interface Schema$GoogleCloudRecaptchaenterpriseV1IpOverrideData { + /** + * Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48 + */ + ip?: string | null; + /** + * Required. Describes the type of IP override. + */ + overrideType?: string | null; + } /** * A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise. */ @@ -599,7 +642,7 @@ export namespace recaptchaenterprise_v1 { */ iosSettings?: Schema$GoogleCloudRecaptchaenterpriseV1IOSKeySettings; /** - * Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + * Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). */ labels?: {[key: string]: string} | null; /** @@ -697,7 +740,7 @@ export namespace recaptchaenterprise_v1 { */ export interface Schema$GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest { /** - * Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information. + * Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information. */ skipBillingCheck?: boolean | null; } @@ -2091,6 +2134,104 @@ export namespace recaptchaenterprise_v1 { this.context = context; } + /** + * Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addIpOverride( + params: Params$Resource$Projects$Keys$Addipoverride, + options: StreamMethodOptions + ): GaxiosPromise; + addIpOverride( + params?: Params$Resource$Projects$Keys$Addipoverride, + options?: MethodOptions + ): GaxiosPromise; + addIpOverride( + params: Params$Resource$Projects$Keys$Addipoverride, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addIpOverride( + params: Params$Resource$Projects$Keys$Addipoverride, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addIpOverride( + params: Params$Resource$Projects$Keys$Addipoverride, + callback: BodyResponseCallback + ): void; + addIpOverride( + callback: BodyResponseCallback + ): void; + addIpOverride( + paramsOrCallback?: + | Params$Resource$Projects$Keys$Addipoverride + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Keys$Addipoverride; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Keys$Addipoverride; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://recaptchaenterprise.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:addIpOverride').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates a new reCAPTCHA Enterprise key. * @@ -2852,6 +2993,18 @@ export namespace recaptchaenterprise_v1 { } } + export interface Params$Resource$Projects$Keys$Addipoverride + extends StandardParameters { + /** + * Required. The name of the key to which the IP override is added, in the format `projects/{project\}/keys/{key\}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest; + } export interface Params$Resource$Projects$Keys$Create extends StandardParameters { /** diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index c45d4170dc..f6389cad28 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -214,6 +214,10 @@ export namespace redis_v1 { * Output only. The timestamp associated with the cluster creation request. */ createTime?: string | null; + /** + * Optional. Cross cluster replication config. + */ + crossClusterReplicationConfig?: Schema$CrossClusterReplicationConfig; /** * Optional. The delete operation will fail when the value is set to true. */ @@ -255,7 +259,7 @@ export namespace redis_v1 { */ replicaCount?: number | null; /** - * Required. Number of shards for the Redis cluster. + * Optional. Number of shards for the Redis cluster. */ shardCount?: number | null; /** @@ -314,29 +318,38 @@ export namespace redis_v1 { version?: string | null; } /** - * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data - */ - export interface Schema$CustomMetadataData { - databaseMetadata?: Schema$DatabaseMetadata[]; - } - /** - * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings. + * Cross cluster replication config. */ - export interface Schema$DatabaseMetadata { + export interface Schema$CrossClusterReplicationConfig { /** - * Backup configuration for this database + * The role of the cluster in cross cluster replication. */ - backupConfiguration?: Schema$BackupConfiguration; + clusterRole?: string | null; /** - * Information about the last backup attempt for this database + * Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. */ - backupRun?: Schema$BackupRun; - product?: Schema$Product; - resourceId?: Schema$DatabaseResourceId; + membership?: Schema$Membership; /** - * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + * Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. */ - resourceName?: string | null; + primaryCluster?: Schema$RemoteCluster; + /** + * List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + */ + secondaryClusters?: Schema$RemoteCluster[]; + /** + * Output only. The last time cross cluster replication config was updated. + */ + updateTime?: string | null; + } + /** + * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data + */ + export interface Schema$CustomMetadataData { + /** + * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration. + */ + internalResourceMetadata?: Schema$InternalResourceMetadata[]; } /** * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. @@ -350,9 +363,6 @@ export namespace redis_v1 { * Required. Type feed to be ingested into condor */ feedType?: string | null; - /** - * More feed data would be added in subsequent CLs - */ observabilityMetricData?: Schema$ObservabilityMetricData; recommendationSignalData?: Schema$DatabaseResourceRecommendationSignalData; resourceHealthSignalData?: Schema$DatabaseResourceHealthSignalData; @@ -410,6 +420,10 @@ export namespace redis_v1 { * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. */ signalId?: string | null; + /** + * The severity of the signal, such as if it's a HIGH or LOW severity. + */ + signalSeverity?: string | null; /** * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc. */ @@ -429,7 +443,7 @@ export namespace redis_v1 { */ providerDescription?: string | null; /** - * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel + * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel */ resourceType?: string | null; /** @@ -849,6 +863,25 @@ export namespace redis_v1 { */ authString?: string | null; } + /** + * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance. + */ + export interface Schema$InternalResourceMetadata { + /** + * Backup configuration for this database + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Information about the last backup attempt for this database + */ + backupRun?: Schema$BackupRun; + product?: Schema$Product; + resourceId?: Schema$DatabaseResourceId; + /** + * Required. internal resource name for spanner this will be database name e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1" + */ + resourceName?: string | null; + } /** * Response for ListClusters. */ @@ -995,6 +1028,19 @@ export namespace redis_v1 { */ caCerts?: Schema$CertChain[]; } + /** + * An output only view of all the member clusters participating in the cross cluster replication. + */ + export interface Schema$Membership { + /** + * Output only. The primary cluster that acts as the source of replication for the secondary clusters. + */ + primaryCluster?: Schema$RemoteCluster; + /** + * Output only. The list of secondary clusters replicating from the primary cluster. + */ + secondaryClusters?: Schema$RemoteCluster[]; + } /** * Node specific properties. */ @@ -1206,6 +1252,19 @@ export namespace redis_v1 { */ exclusiveAction?: string | null; } + /** + * Details of the remote cluster associated with this cluster in a cross cluster replication setup. + */ + export interface Schema$RemoteCluster { + /** + * The full resource path of the remote cluster in the format: projects//locations//clusters/ + */ + cluster?: string | null; + /** + * Output only. The unique identifier of the remote cluster. + */ + uid?: string | null; + } /** * Request for RescheduleMaintenance. */ diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index cccb501888..139b7ecac2 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -214,6 +214,10 @@ export namespace redis_v1beta1 { * Output only. The timestamp associated with the cluster creation request. */ createTime?: string | null; + /** + * Optional. Cross cluster replication config. + */ + crossClusterReplicationConfig?: Schema$CrossClusterReplicationConfig; /** * Optional. The delete operation will fail when the value is set to true. */ @@ -255,7 +259,7 @@ export namespace redis_v1beta1 { */ replicaCount?: number | null; /** - * Required. Number of shards for the Redis cluster. + * Optional. Number of shards for the Redis cluster. */ shardCount?: number | null; /** @@ -314,29 +318,38 @@ export namespace redis_v1beta1 { version?: string | null; } /** - * Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data - */ - export interface Schema$CustomMetadataData { - databaseMetadata?: Schema$DatabaseMetadata[]; - } - /** - * Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings. + * Cross cluster replication config. */ - export interface Schema$DatabaseMetadata { + export interface Schema$CrossClusterReplicationConfig { /** - * Backup configuration for this database + * The role of the cluster in cross cluster replication. */ - backupConfiguration?: Schema$BackupConfiguration; + clusterRole?: string | null; /** - * Information about the last backup attempt for this database + * Output only. An output only view of all the member clusters participating in the cross cluster replication. This view will be provided by every member cluster irrespective of its cluster role(primary or secondary). A primary cluster can provide information about all the secondary clusters replicating from it. However, a secondary cluster only knows about the primary cluster from which it is replicating. However, for scenarios, where the primary cluster is unavailable(e.g. regional outage), a GetCluster request can be sent to any other member cluster and this field will list all the member clusters participating in cross cluster replication. */ - backupRun?: Schema$BackupRun; - product?: Schema$Product; - resourceId?: Schema$DatabaseResourceId; + membership?: Schema$Membership; /** - * Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + * Details of the primary cluster that is used as the replication source for this secondary cluster. This field is only set for a secondary cluster. */ - resourceName?: string | null; + primaryCluster?: Schema$RemoteCluster; + /** + * List of secondary clusters that are replicating from this primary cluster. This field is only set for a primary cluster. + */ + secondaryClusters?: Schema$RemoteCluster[]; + /** + * Output only. The last time cross cluster replication config was updated. + */ + updateTime?: string | null; + } + /** + * Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data + */ + export interface Schema$CustomMetadataData { + /** + * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration. + */ + internalResourceMetadata?: Schema$InternalResourceMetadata[]; } /** * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. @@ -350,9 +363,6 @@ export namespace redis_v1beta1 { * Required. Type feed to be ingested into condor */ feedType?: string | null; - /** - * More feed data would be added in subsequent CLs - */ observabilityMetricData?: Schema$ObservabilityMetricData; recommendationSignalData?: Schema$DatabaseResourceRecommendationSignalData; resourceHealthSignalData?: Schema$DatabaseResourceHealthSignalData; @@ -410,6 +420,10 @@ export namespace redis_v1beta1 { * Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. */ signalId?: string | null; + /** + * The severity of the signal, such as if it's a HIGH or LOW severity. + */ + signalSeverity?: string | null; /** * Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc. */ @@ -429,7 +443,7 @@ export namespace redis_v1beta1 { */ providerDescription?: string | null; /** - * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel + * Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel */ resourceType?: string | null; /** @@ -849,6 +863,25 @@ export namespace redis_v1beta1 { */ authString?: string | null; } + /** + * Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance. + */ + export interface Schema$InternalResourceMetadata { + /** + * Backup configuration for this database + */ + backupConfiguration?: Schema$BackupConfiguration; + /** + * Information about the last backup attempt for this database + */ + backupRun?: Schema$BackupRun; + product?: Schema$Product; + resourceId?: Schema$DatabaseResourceId; + /** + * Required. internal resource name for spanner this will be database name e.g."spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1" + */ + resourceName?: string | null; + } /** * Response for ListClusters. */ @@ -995,6 +1028,19 @@ export namespace redis_v1beta1 { */ caCerts?: Schema$CertChain[]; } + /** + * An output only view of all the member clusters participating in the cross cluster replication. + */ + export interface Schema$Membership { + /** + * Output only. The primary cluster that acts as the source of replication for the secondary clusters. + */ + primaryCluster?: Schema$RemoteCluster; + /** + * Output only. The list of secondary clusters replicating from the primary cluster. + */ + secondaryClusters?: Schema$RemoteCluster[]; + } /** * Node specific properties. */ @@ -1206,6 +1252,19 @@ export namespace redis_v1beta1 { */ exclusiveAction?: string | null; } + /** + * Details of the remote cluster associated with this cluster in a cross cluster replication setup. + */ + export interface Schema$RemoteCluster { + /** + * The full resource path of the remote cluster in the format: projects//locations//clusters/ + */ + cluster?: string | null; + /** + * Output only. The unique identifier of the remote cluster. + */ + uid?: string | null; + } /** * Request for RescheduleMaintenance. */ diff --git a/src/apis/retail/v2.ts b/src/apis/retail/v2.ts index 9adbae8e1e..28e6696240 100644 --- a/src/apis/retail/v2.ts +++ b/src/apis/retail/v2.ts @@ -1473,10 +1473,6 @@ export namespace retail_v2 { * The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. */ mergedFacetKey?: string | null; - /** - * Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - */ - mergedFacetValues?: Schema$GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue[]; } /** * Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -1521,6 +1517,14 @@ export namespace retail_v2 { * Response of the autocomplete query. */ export interface Schema$GoogleCloudRetailV2CompleteQueryResponse { + /** + * A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: * `brands` * `categories` + */ + attributeResults?: { + [ + key: string + ]: Schema$GoogleCloudRetailV2CompleteQueryResponseAttributeResult; + } | null; /** * A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance. */ @@ -1534,6 +1538,12 @@ export namespace retail_v2 { */ recentSearchResults?: Schema$GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult[]; } + /** + * Resource that represents attribute results. + */ + export interface Schema$GoogleCloudRetailV2CompleteQueryResponseAttributeResult { + suggestions?: string[] | null; + } /** * Resource that represents completion results. */ @@ -1550,7 +1560,7 @@ export namespace retail_v2 { suggestion?: string | null; } /** - * Recent search of this user. + * Deprecated: Recent search of this user. */ export interface Schema$GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult { /** diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 919a68fd63..4ab7937e6c 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -357,7 +357,7 @@ export namespace retail_v2alpha { */ export interface Schema$GoogleCloudRetailV2alphaAlertConfigAlertPolicy { /** - * The feature that provides alerting capability. Supported value is only `search-data-quality` for now. + * The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers. */ alertGroup?: string | null; /** @@ -494,10 +494,6 @@ export namespace retail_v2alpha { * Immutable. Full resource name of the branch, such as `projects/x/locations/global/catalogs/default_catalog/branches/branch_id`. */ name?: string | null; - /** - * Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view. - */ - productCounts?: {[key: string]: string} | null; /** * Output only. Statistics for number of products in the branch, provided for different scopes. This field is not populated in BranchView.BASIC view. */ @@ -661,10 +657,6 @@ export namespace retail_v2alpha { * The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. */ mergedFacetKey?: string | null; - /** - * Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - */ - mergedFacetValues?: Schema$GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue[]; } /** * Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -734,9 +726,6 @@ export namespace retail_v2alpha { * Resource that represents attribute results. */ export interface Schema$GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult { - /** - * The list of suggestions for the attribute. - */ suggestions?: string[] | null; } /** @@ -763,7 +752,7 @@ export namespace retail_v2alpha { totalProductCount?: number | null; } /** - * Recent search of this user. + * Deprecated: Recent search of this user. */ export interface Schema$GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult { /** @@ -1065,6 +1054,19 @@ export namespace retail_v2alpha { */ updateTime?: string | null; } + /** + * Request message for ExportProducts method. + */ + export interface Schema$GoogleCloudRetailV2alphaExportProductsRequest { + /** + * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-"tagA"`', which is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"` * Example 2: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" productType = "variant"` * Example 3: `tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"` * Example 4: `lastModifiedTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `availability = (IN_STOCK OR BACKORDER)` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2alphaOutputConfig; + } /** * Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ @@ -1082,6 +1084,19 @@ export namespace retail_v2alpha { */ outputResult?: Schema$GoogleCloudRetailV2alphaOutputResult; } + /** + * Request message for the `ExportUserEvents` method. + */ + export interface Schema$GoogleCloudRetailV2alphaExportUserEventsRequest { + /** + * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime \> "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime \> "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime \> "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2alphaOutputConfig; + } /** * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ @@ -7252,6 +7267,102 @@ export namespace retail_v2alpha { } } + /** + * Exports multiple Products. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+parent}/products:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a Product. * @@ -8070,6 +8181,18 @@ export namespace retail_v2alpha { */ name?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export + extends StandardParameters { + /** + * Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaExportProductsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Branches$Products$Get extends StandardParameters { /** @@ -11563,6 +11686,102 @@ export namespace retail_v2alpha { } } + /** + * Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Userevents$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+parent}/userEvents:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`. * @@ -11977,6 +12196,18 @@ export namespace retail_v2alpha { */ userEvent?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Export + extends StandardParameters { + /** + * Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaExportUserEventsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Import extends StandardParameters { /** diff --git a/src/apis/retail/v2beta.ts b/src/apis/retail/v2beta.ts index 143dd3cc2e..680991dbb4 100644 --- a/src/apis/retail/v2beta.ts +++ b/src/apis/retail/v2beta.ts @@ -895,6 +895,45 @@ export namespace retail_v2beta { * Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method. */ export interface Schema$GoogleCloudRetailV2betaAddLocalInventoriesResponse {} + /** + * Project level alert config. + */ + export interface Schema$GoogleCloudRetailV2betaAlertConfig { + /** + * Alert policies for a customer. They must be unique by [AlertPolicy.alert_group] + */ + alertPolicies?: Schema$GoogleCloudRetailV2betaAlertConfigAlertPolicy[]; + /** + * Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/x/alertConfig + */ + name?: string | null; + } + /** + * Alert policy for a customer. + */ + export interface Schema$GoogleCloudRetailV2betaAlertConfigAlertPolicy { + /** + * The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers. + */ + alertGroup?: string | null; + /** + * The enrollment status of a customer. + */ + enrollStatus?: string | null; + /** + * Recipients for the alert policy. One alert policy should not exceed 20 recipients. + */ + recipients?: Schema$GoogleCloudRetailV2betaAlertConfigAlertPolicyRecipient[]; + } + /** + * Recipient contact information. + */ + export interface Schema$GoogleCloudRetailV2betaAlertConfigAlertPolicyRecipient { + /** + * Email address of the recipient. + */ + emailAddress?: string | null; + } /** * Catalog level attribute config. */ @@ -1107,10 +1146,6 @@ export namespace retail_v2beta { * The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. */ mergedFacetKey?: string | null; - /** - * Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - */ - mergedFacetValues?: Schema$GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue[]; } /** * Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -1155,6 +1190,14 @@ export namespace retail_v2beta { * Response of the autocomplete query. */ export interface Schema$GoogleCloudRetailV2betaCompleteQueryResponse { + /** + * A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: * `brands` * `categories` + */ + attributeResults?: { + [ + key: string + ]: Schema$GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult; + } | null; /** * A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance. */ @@ -1168,6 +1211,12 @@ export namespace retail_v2beta { */ recentSearchResults?: Schema$GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult[]; } + /** + * Resource that represents attribute results. + */ + export interface Schema$GoogleCloudRetailV2betaCompleteQueryResponseAttributeResult { + suggestions?: string[] | null; + } /** * Resource that represents completion results. */ @@ -1184,7 +1233,7 @@ export namespace retail_v2beta { suggestion?: string | null; } /** - * Recent search of this user. + * Deprecated: Recent search of this user. */ export interface Schema$GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult { /** @@ -1451,6 +1500,19 @@ export namespace retail_v2beta { */ updateTime?: string | null; } + /** + * Request message for ExportProducts method. + */ + export interface Schema$GoogleCloudRetailV2betaExportProductsRequest { + /** + * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary` We expect only four types of fields: * `lastModifiedTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `lastModifiedTime` restriction should result in one, contiguous, valid, last-modified, time range. * `productType`: Supported values are `primary` and `variant`. The Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `productType` values by a space. * `availability`: Supported values are `IN_STOCK`, `OUT_OF_STOCK`, `PREORDER`, and `BACKORDER`. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and must be separated from the `availability` values by a space. * `Tag expressions`: Restricts output to products that match all of the specified tags. Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '`-"tagA"`', which is equivalent to '`NOT "tagA"`'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: * Example 1: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z"` * Example 2: `lastModifiedTime \> "2012-04-23T18:25:43.511Z" productType = "variant"` * Example 3: `tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z"` * Example 4: `lastModifiedTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `availability = (IN_STOCK OR BACKORDER)` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2betaOutputConfig; + } /** * Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ @@ -1468,6 +1530,19 @@ export namespace retail_v2beta { */ outputResult?: Schema$GoogleCloudRetailV2betaOutputResult; } + /** + * Request message for the `ExportUserEvents` method. + */ + export interface Schema$GoogleCloudRetailV2betaExportUserEventsRequest { + /** + * A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime \> "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime \> "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime \> "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime \> "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems` + */ + filter?: string | null; + /** + * Required. The output location of the data. + */ + outputConfig?: Schema$GoogleCloudRetailV2betaOutputConfig; + } /** * Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful. */ @@ -3814,6 +3889,218 @@ export namespace retail_v2beta { this.locations = new Resource$Projects$Locations(this.context); this.operations = new Resource$Projects$Operations(this.context); } + + /** + * Get the AlertConfig of the requested project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getAlertConfig( + params?: Params$Resource$Projects$Getalertconfig, + options?: MethodOptions + ): GaxiosPromise; + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAlertConfig( + params: Params$Resource$Projects$Getalertconfig, + callback: BodyResponseCallback + ): void; + getAlertConfig( + callback: BodyResponseCallback + ): void; + getAlertConfig( + paramsOrCallback?: + | Params$Resource$Projects$Getalertconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getalertconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getalertconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Update the alert config of the requested project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateAlertConfig( + params?: Params$Resource$Projects$Updatealertconfig, + options?: MethodOptions + ): GaxiosPromise; + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateAlertConfig( + params: Params$Resource$Projects$Updatealertconfig, + callback: BodyResponseCallback + ): void; + updateAlertConfig( + callback: BodyResponseCallback + ): void; + updateAlertConfig( + paramsOrCallback?: + | Params$Resource$Projects$Updatealertconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Updatealertconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updatealertconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Getalertconfig + extends StandardParameters { + /** + * Required. Full AlertConfig resource name. Format: projects/{project_number\}/alertConfig + */ + name?: string; + } + export interface Params$Resource$Projects$Updatealertconfig + extends StandardParameters { + /** + * Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/x/alertConfig + */ + name?: string; + /** + * Indicates which fields in the provided AlertConfig to update. If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaAlertConfig; } export class Resource$Projects$Locations { @@ -5928,6 +6215,102 @@ export namespace retail_v2beta { } } + /** + * Exports multiple Products. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+parent}/products:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets a Product. * @@ -6742,6 +7125,18 @@ export namespace retail_v2beta { */ name?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Branches$Products$Export + extends StandardParameters { + /** + * Required. Resource name of a Branch, and `default_branch` for branch_id component is supported. For example `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaExportProductsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Branches$Products$Get extends StandardParameters { /** @@ -9916,6 +10311,102 @@ export namespace retail_v2beta { } } + /** + * Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Catalogs$Userevents$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Catalogs$Userevents$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Catalogs$Userevents$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta/{+parent}/userEvents:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`. * @@ -10330,6 +10821,18 @@ export namespace retail_v2beta { */ userEvent?: string; } + export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Export + extends StandardParameters { + /** + * Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2betaExportUserEventsRequest; + } export interface Params$Resource$Projects$Locations$Catalogs$Userevents$Import extends StandardParameters { /** diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index d64a9f8658..99f898d48b 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -603,6 +603,10 @@ export namespace run_v1 { * Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. */ export interface Schema$ExecutionReference { + /** + * Optional. Status for the execution completion. + */ + completionStatus?: string | null; /** * Optional. Completion timestamp of the execution. */ @@ -611,6 +615,10 @@ export namespace run_v1 { * Optional. Creation timestamp of the execution. */ creationTimestamp?: string | null; + /** + * Optional. The read-only soft deletion timestamp of the execution. + */ + deletionTimestamp?: string | null; /** * Optional. Name of the execution. */ @@ -1183,23 +1191,6 @@ export namespace run_v1 { */ fileHash?: Schema$GoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$GoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -1244,13 +1235,9 @@ export namespace run_v1 { */ export interface Schema$GoogleDevtoolsCloudbuildV1HttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$GoogleDevtoolsCloudbuildV1GCSLocation; } /** * Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. @@ -2124,7 +2111,7 @@ export namespace run_v1 { */ export interface Schema$ObjectMeta { /** - * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Service, Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-base-image`: Service. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-name`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/enable-automatic-updates`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/image-uri`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. */ annotations?: {[key: string]: string} | null; /** @@ -2352,11 +2339,11 @@ export namespace run_v1 { */ export interface Schema$RevisionSpec { /** - * ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + * ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU \>= 1 and defaults to 1 when requested CPU < 1. */ containerConcurrency?: number | null; /** - * Required. Containers holds the single container that defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. In Cloud Run, only a single container may be provided. + * Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. */ containers?: Schema$Container[]; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 0a373f2b80..b7bffda204 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -443,6 +443,10 @@ export namespace run_v2 { * Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. */ export interface Schema$GoogleCloudRunV2ExecutionReference { + /** + * Status for the execution completion. + */ + completionStatus?: string | null; /** * Creation timestamp of the execution. */ @@ -451,6 +455,10 @@ export namespace run_v2 { * Creation timestamp of the execution. */ createTime?: string | null; + /** + * The deletion time of the execution. It is only populated as a response to a Delete request. + */ + deleteTime?: string | null; /** * Name of the execution. */ @@ -521,7 +529,7 @@ export namespace run_v2 { */ export interface Schema$GoogleCloudRunV2GCSVolumeSource { /** - * Cloud Storage Bucket name. TODO (b/344678062) Fix the error validation once dynamic mounting is public. + * Cloud Storage Bucket name. */ bucket?: string | null; /** @@ -990,6 +998,10 @@ export namespace run_v2 { * Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. */ serviceAccount?: string | null; + /** + * Enables service mesh connectivity. + */ + serviceMesh?: Schema$GoogleCloudRunV2ServiceMesh; /** * Enable session affinity. */ @@ -1066,7 +1078,7 @@ export namespace run_v2 { */ labels?: {[key: string]: string} | null; /** - * Optional. Sets the maximum number of requests that each serving instance can receive. + * Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU \>= 1 and defaults to 1 when requested CPU < 1. */ maxInstanceRequestConcurrency?: number | null; /** @@ -1085,6 +1097,10 @@ export namespace run_v2 { * Optional. Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project's default service account. */ serviceAccount?: string | null; + /** + * Optional. Enables service mesh connectivity. + */ + serviceMesh?: Schema$GoogleCloudRunV2ServiceMesh; /** * Optional. Enable session affinity. */ @@ -1282,6 +1298,15 @@ export namespace run_v2 { */ uri?: string | null; } + /** + * Service mesh configuration. + */ + export interface Schema$GoogleCloudRunV2ServiceMesh { + /** + * The service mesh resource name. Format: projects/{project_number\}/locations/global/meshes/{mesh\}. + */ + mesh?: string | null; + } /** * Scaling settings applied at the service level rather than at the revision level. */ @@ -2043,23 +2068,6 @@ export namespace run_v2 { */ fileHash?: Schema$GoogleDevtoolsCloudbuildV1Hash[]; } - /** - * Represents a storage location in Cloud Storage - */ - export interface Schema$GoogleDevtoolsCloudbuildV1GCSLocation { - /** - * Cloud Storage bucket. See https://cloud.google.com/storage/docs/naming#requirements - */ - bucket?: string | null; - /** - * Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. - */ - generation?: string | null; - /** - * Cloud Storage object. See https://cloud.google.com/storage/docs/naming#objectnames - */ - object?: string | null; - } /** * GitConfig is a configuration for git operations. */ @@ -2104,13 +2112,9 @@ export namespace run_v2 { */ export interface Schema$GoogleDevtoolsCloudbuildV1HttpConfig { /** - * SecretVersion resource of the HTTP proxy URL. The proxy URL should be in format protocol://@]proxyhost[:port]. + * SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. */ proxySecretVersionName?: string | null; - /** - * Optional. Cloud Storage object storing the certificate to use with the HTTP proxy. - */ - proxySslCaInfo?: Schema$GoogleDevtoolsCloudbuildV1GCSLocation; } /** * Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value. @@ -3013,6 +3017,101 @@ export namespace run_v2 { return createAPIRequest(parameters); } } + + /** + * Export generated customer metadata for a given project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + options: StreamMethodOptions + ): GaxiosPromise; + exportProjectMetadata( + params?: Params$Resource$Projects$Locations$Exportprojectmetadata, + options?: MethodOptions + ): GaxiosPromise; + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + params: Params$Resource$Projects$Locations$Exportprojectmetadata, + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + callback: BodyResponseCallback + ): void; + exportProjectMetadata( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Exportprojectmetadata + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Exportprojectmetadata; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Exportprojectmetadata; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:exportProjectMetadata').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Exportimage @@ -3041,6 +3140,13 @@ export namespace run_v2 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Exportprojectmetadata + extends StandardParameters { + /** + * Required. The name of the project of which metadata should be exported. Format: `projects/{project_id_or_number\}/locations/{location\}` for Project in a given location. + */ + name?: string; + } export class Resource$Projects$Locations$Jobs { context: APIRequestContext; diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index f5d9a435ab..b20aa24e17 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -308,7 +308,7 @@ export namespace securitycenter_v1 { */ export interface Schema$AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -383,11 +383,11 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format]("https://cloud.google.com/asset-inventory/docs/resource-name-format") + * The name of the resource at this point in the attack path. The format of the name follows the Cloud Asset Inventory [resource name format](https://cloud.google.com/asset-inventory/docs/resource-name-format) */ resource?: string | null; /** - * The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types") + * The [supported resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) */ resourceType?: string | null; /** @@ -507,7 +507,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -546,7 +546,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -642,6 +642,10 @@ export namespace securitycenter_v1 { * This can be a mute configuration name or any identifier for mute/unmute of findings based on the filter. */ muteAnnotation?: string | null; + /** + * Optional. All findings matching the given filter will have their mute state set to this value. The default value is `MUTED`. Setting this to `UNDEFINED` will clear the mute state on all matching findings. + */ + muteState?: string | null; } /** * Fields related to Google Cloud Armor findings. @@ -901,6 +905,10 @@ export namespace securitycenter_v1 { * The exploitation activity of the vulnerability in the wild. */ exploitationActivity?: string | null; + /** + * Date the first publicly available exploit or PoC was released. + */ + exploitReleaseDate?: string | null; /** * The unique identifier for the vulnerability. e.g. CVE-2021-34527 */ @@ -1022,6 +1030,19 @@ export namespace securitycenter_v1 { */ relativePath?: string | null; } + /** + * The record of a dynamic mute rule that matches the finding. + */ + export interface Schema$DynamicMuteRecord { + /** + * When the dynamic mute rule first matched the finding. + */ + matchTime?: string | null; + /** + * The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + */ + muteConfig?: string | null; + } /** * An EffectiveEventThreatDetectionCustomModule is the representation of an Event Threat Detection custom module at a specified level of the resource hierarchy: organization, folder, or project. If a custom module is inherited from a parent organization or folder, the value of the `enablement_state` property in EffectiveEventThreatDetectionCustomModule is set to the value that is effective in the parent, instead of `INHERITED`. For example, if the module is enabled in a parent organization or folder, the effective `enablement_state` for the module in all child folders or projects is also `enabled`. EffectiveEventThreatDetectionCustomModule is read-only. */ @@ -1043,7 +1064,7 @@ export namespace securitycenter_v1 { */ enablementState?: string | null; /** - * Output only. The resource name of the effective ETD custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Output only. The resource name of the effective ETD custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string | null; /** @@ -1097,7 +1118,7 @@ export namespace securitycenter_v1 { */ lastEditor?: string | null; /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string | null; /** @@ -1327,6 +1348,10 @@ export namespace securitycenter_v1 { * Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. */ mute?: string | null; + /** + * Output only. The mute information regarding this finding. + */ + muteInfo?: Schema$MuteInfo; /** * Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. */ @@ -1664,6 +1689,10 @@ export namespace securitycenter_v1 { * The human readable name to be displayed for the mute config. */ displayName?: string | null; + /** + * Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. + */ + expiryTime?: string | null; /** * Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` */ @@ -1673,9 +1702,13 @@ export namespace securitycenter_v1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string | null; + /** + * Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. + */ + type?: string | null; /** * Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. */ @@ -1910,7 +1943,7 @@ export namespace securitycenter_v1 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -1952,11 +1985,11 @@ export namespace securitycenter_v1 { */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"\}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** @@ -1964,7 +1997,7 @@ export namespace securitycenter_v1 { */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -1972,7 +2005,7 @@ export namespace securitycenter_v1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Required. Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -2165,7 +2198,7 @@ export namespace securitycenter_v1 { */ export interface Schema$GoogleCloudSecuritycenterV2AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -2254,7 +2287,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -2293,7 +2326,7 @@ export namespace securitycenter_v1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -2351,7 +2384,7 @@ export namespace securitycenter_v1 { */ createTime?: string | null; /** - * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). */ dataset?: string | null; /** @@ -2367,7 +2400,7 @@ export namespace securitycenter_v1 { */ mostRecentEditor?: string | null; /** - * The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. + * Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. */ name?: string | null; /** @@ -2585,6 +2618,10 @@ export namespace securitycenter_v1 { * The exploitation activity of the vulnerability in the wild. */ exploitationActivity?: string | null; + /** + * Date the first publicly available exploit or PoC was released. + */ + exploitReleaseDate?: string | null; /** * The unique identifier for the vulnerability. e.g. CVE-2021-34527 */ @@ -2706,6 +2743,19 @@ export namespace securitycenter_v1 { */ relativePath?: string | null; } + /** + * The record of a dynamic mute rule that matches the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2DynamicMuteRecord { + /** + * When the dynamic mute rule first matched the finding. + */ + matchTime?: string | null; + /** + * The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + */ + muteConfig?: string | null; + } /** * A name-value pair representing an environment variable used in an operating system process. */ @@ -2967,6 +3017,10 @@ export namespace securitycenter_v1 { * Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. */ mute?: string | null; + /** + * Output only. The mute information regarding this finding. + */ + muteInfo?: Schema$GoogleCloudSecuritycenterV2MuteInfo; /** * Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. */ @@ -3264,6 +3318,10 @@ export namespace securitycenter_v1 { * A description of the mute config. */ description?: string | null; + /** + * Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. + */ + expiryTime?: string | null; /** * Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` */ @@ -3273,7 +3331,7 @@ export namespace securitycenter_v1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` + * Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -3285,6 +3343,19 @@ export namespace securitycenter_v1 { */ updateTime?: string | null; } + /** + * Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. + */ + export interface Schema$GoogleCloudSecuritycenterV2MuteInfo { + /** + * The list of dynamic mute rules that currently match the finding. + */ + dynamicMuteRecords?: Schema$GoogleCloudSecuritycenterV2DynamicMuteRecord[]; + /** + * If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. + */ + staticMute?: Schema$GoogleCloudSecuritycenterV2StaticMute; + } /** * Kubernetes nodes associated with the finding. */ @@ -3571,7 +3642,7 @@ export namespace securitycenter_v1 { */ resourcePath?: Schema$GoogleCloudSecuritycenterV2ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -3626,23 +3697,23 @@ export namespace securitycenter_v1 { */ description?: string | null; /** - * Name for the resource value configuration + * Identifier. Name for the resource value configuration */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** - * Resource value level this expression represents Only required when there is no SDP mapping in the request + * Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope and will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -3650,7 +3721,7 @@ export namespace securitycenter_v1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -3789,6 +3860,19 @@ export namespace securitycenter_v1 { */ principalSubject?: string | null; } + /** + * Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. + */ + export interface Schema$GoogleCloudSecuritycenterV2StaticMute { + /** + * When the static mute was applied. + */ + applyTime?: string | null; + /** + * The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + */ + state?: string | null; + } /** * Represents a Kubernetes subject. */ @@ -3844,7 +3928,7 @@ export namespace securitycenter_v1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4452,6 +4536,19 @@ export namespace securitycenter_v1 { */ version?: string | null; } + /** + * Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. + */ + export interface Schema$MuteInfo { + /** + * The list of dynamic mute rules that currently match the finding. + */ + dynamicMuteRecords?: Schema$DynamicMuteRecord[]; + /** + * If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. + */ + staticMute?: Schema$StaticMute; + } /** * Kubernetes nodes associated with the finding. */ @@ -4622,7 +4719,7 @@ export namespace securitycenter_v1 { */ export interface Schema$PathNodeAssociatedFinding { /** - * Canonical name of the associated findings. Example: organizations/123/sources/456/findings/789 + * Canonical name of the associated findings. Example: `organizations/123/sources/456/findings/789` */ canonicalFinding?: string | null; /** @@ -4853,7 +4950,7 @@ export namespace securitycenter_v1 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id\}/folder/{folder_id\}/folder/{folder_id\}/project/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id\}/folder/{folder_id\}/folder/{folder_id\}/project/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -5167,7 +5264,7 @@ export namespace securitycenter_v1 { */ createTime?: string | null; /** - * Full resource name of the Simulation: organizations/123/simulations/456 + * Full resource name of the Simulation: `organizations/123/simulations/456` */ name?: string | null; /** @@ -5196,6 +5293,19 @@ export namespace securitycenter_v1 { */ name?: string | null; } + /** + * Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. + */ + export interface Schema$StaticMute { + /** + * When the static mute was applied. + */ + applyTime?: string | null; + /** + * The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + */ + state?: string | null; + } /** * 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). */ @@ -5295,7 +5405,7 @@ export namespace securitycenter_v1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -5726,7 +5836,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Assets$Group extends StandardParameters { /** - * Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -5762,7 +5872,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; /** @@ -6275,7 +6385,7 @@ export namespace securitycenter_v1 { */ bigQueryExportId?: string; /** - * Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -6287,14 +6397,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Bigqueryexports$Delete extends StandardParameters { /** - * Required. The name of the BigQuery export to delete. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. The name of the BigQuery export to delete. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } export interface Params$Resource$Folders$Bigqueryexports$Get extends StandardParameters { /** - * Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } @@ -6309,7 +6419,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } @@ -6449,7 +6559,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Validatecustommodule extends StandardParameters { /** - * Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -7044,7 +7154,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Create extends StandardParameters { /** - * Required. The new custom module's parent. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. The new custom module's parent. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -7056,14 +7166,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to delete. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to get. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } @@ -7078,7 +7188,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -7093,14 +7203,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } export interface Params$Resource$Folders$Eventthreatdetectionsettings$Custommodules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; /** @@ -7319,7 +7429,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Eventthreatdetectionsettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string; } @@ -7334,7 +7444,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -7438,7 +7548,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Findings$Bulkmute extends StandardParameters { /** - * Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; @@ -7938,7 +8048,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -7950,14 +8060,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Locations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Folders$Locations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -7972,14 +8082,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Folders$Locations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -8475,7 +8585,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -8487,14 +8597,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Folders$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -8509,14 +8619,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Folders$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -8998,7 +9108,7 @@ export namespace securitycenter_v1 { */ configId?: string; /** - * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -9010,14 +9120,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Notificationconfigs$Delete extends StandardParameters { /** - * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } export interface Params$Resource$Folders$Notificationconfigs$Get extends StandardParameters { /** - * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } @@ -9754,7 +9864,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Securityhealthanalyticssettings$Custommodules$Create extends StandardParameters { /** - * Required. Resource name of the new custom module's parent. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Resource name of the new custom module's parent. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; @@ -9766,14 +9876,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Securityhealthanalyticssettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to delete. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } export interface Params$Resource$Folders$Securityhealthanalyticssettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } @@ -9788,7 +9898,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -9803,7 +9913,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -10041,7 +10151,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Securityhealthanalyticssettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. Name of the effective custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}" + * Required. Name of the effective custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}` */ name?: string; } @@ -10056,7 +10166,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list effective custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list effective custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -10173,7 +10283,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; } @@ -10732,7 +10842,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Sources$Findings$Group extends StandardParameters { /** - * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-, or projects/{project_id\}/sources/- + * Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-`, or `projects/{project_id\}/sources/-` */ parent?: string; @@ -10768,7 +10878,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/- or projects/{projects_id\}/sources/- + * Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-`, `folders/{folder_id\}/sources/-` or `projects/{projects_id\}/sources/-` */ parent?: string; /** @@ -10795,7 +10905,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Sources$Findings$Setmute extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -10807,7 +10917,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Folders$Sources$Findings$Setstate extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -11186,7 +11296,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Getorganizationsettings extends StandardParameters { /** - * Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * Required. Name of the organization to get organization settings for. Its format is `organizations/[organization_id]/organizationSettings`. */ name?: string; } @@ -11578,7 +11688,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Assets$Group extends StandardParameters { /** - * Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -11614,7 +11724,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; /** @@ -11625,7 +11735,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Assets$Rundiscovery extends StandardParameters { /** - * Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * Required. Name of the organization to run asset discovery for. Its format is `organizations/[organization_id]`. */ parent?: string; @@ -12139,7 +12249,7 @@ export namespace securitycenter_v1 { */ bigQueryExportId?: string; /** - * Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -12151,14 +12261,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Bigqueryexports$Delete extends StandardParameters { /** - * Required. The name of the BigQuery export to delete. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. The name of the BigQuery export to delete. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } export interface Params$Resource$Organizations$Bigqueryexports$Get extends StandardParameters { /** - * Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } @@ -12173,7 +12283,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } @@ -12313,7 +12423,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Validatecustommodule extends StandardParameters { /** - * Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -12908,7 +13018,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Create extends StandardParameters { /** - * Required. The new custom module's parent. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. The new custom module's parent. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -12920,14 +13030,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to delete. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to get. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } @@ -12942,7 +13052,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -12957,14 +13067,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Custommodules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; /** @@ -13183,7 +13293,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Eventthreatdetectionsettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string; } @@ -13198,7 +13308,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -13302,7 +13412,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Findings$Bulkmute extends StandardParameters { /** - * Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; @@ -13805,7 +13915,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -13817,14 +13927,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Locations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Organizations$Locations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -13839,14 +13949,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Organizations$Locations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -14342,7 +14452,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -14354,14 +14464,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Organizations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -14376,14 +14486,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Organizations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -14865,7 +14975,7 @@ export namespace securitycenter_v1 { */ configId?: string; /** - * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -14877,14 +14987,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Notificationconfigs$Delete extends StandardParameters { /** - * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } export interface Params$Resource$Organizations$Notificationconfigs$Get extends StandardParameters { /** - * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } @@ -15819,7 +15929,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Resourcevalueconfigs$Get extends StandardParameters { /** - * Required. Name of the resource value config to retrieve. Its format is organizations/{organization\}/resourceValueConfigs/{config_id\}. + * Required. Name of the resource value config to retrieve. Its format is `organizations/{organization\}/resourceValueConfigs/{config_id\}`. */ name?: string; } @@ -15834,7 +15944,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of resource value configs. Its format is "organizations/[organization_id]" + * Required. The parent, which owns the collection of resource value configs. Its format is `organizations/[organization_id]` */ parent?: string; } @@ -16556,7 +16666,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Custommodules$Create extends StandardParameters { /** - * Required. Resource name of the new custom module's parent. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Resource name of the new custom module's parent. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; @@ -16568,14 +16678,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to delete. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } @@ -16590,7 +16700,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -16605,7 +16715,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -16843,7 +16953,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Securityhealthanalyticssettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. Name of the effective custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}" + * Required. Name of the effective custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}` */ name?: string; } @@ -16858,7 +16968,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list effective custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list effective custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -16971,7 +17081,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Simulations$Get extends StandardParameters { /** - * Required. The organization name or simulation name of this simulation Valid format: "organizations/{organization\}/simulations/latest" "organizations/{organization\}/simulations/{simulation\}" + * Required. The organization name or simulation name of this simulation Valid format: `organizations/{organization\}/simulations/latest` `organizations/{organization\}/simulations/{simulation\}` */ name?: string; } @@ -17110,7 +17220,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list attack paths. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. Name of parent to list attack paths. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ parent?: string; } @@ -17226,7 +17336,7 @@ export namespace securitycenter_v1 { */ filter?: string; /** - * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: `exposed_score DESC`. + * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`. */ orderBy?: string; /** @@ -17238,7 +17348,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list valued resources. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" + * Required. Name of parent to list valued resources. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` */ parent?: string; } @@ -17360,7 +17470,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list attack paths. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. Name of parent to list attack paths. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ parent?: string; } @@ -17564,7 +17674,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Simulations$Valuedresources$Get extends StandardParameters { /** - * Required. The name of this valued resource Valid format: "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. The name of this valued resource Valid format: `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ name?: string; } @@ -17575,7 +17685,7 @@ export namespace securitycenter_v1 { */ filter?: string; /** - * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a " ASC" or a " DESC" suffix, respectively; for example: `exposed_score DESC`. + * Optional. The fields by which to order the valued resources response. Supported fields: * `exposed_score` * `resource_value` * `resource_type` * `resource` * `display_name` Values should be a comma separated list of fields. For example: `exposed_score,resource_value`. The default sorting order is descending. To specify ascending or descending order for a field, append a ` ASC` or a ` DESC` suffix, respectively; for example: `exposed_score DESC`. */ orderBy?: string; /** @@ -17587,7 +17697,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list valued resources. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" + * Required. Name of parent to list valued resources. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` */ parent?: string; } @@ -17709,7 +17819,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list attack paths. Valid formats: "organizations/{organization\}", "organizations/{organization\}/simulations/{simulation\}" "organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}" "organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}" + * Required. Name of parent to list attack paths. Valid formats: `organizations/{organization\}`, `organizations/{organization\}/simulations/{simulation\}` `organizations/{organization\}/simulations/{simulation\}/attackExposureResults/{attack_exposure_result_v2\}` `organizations/{organization\}/simulations/{simulation\}/valuedResources/{valued_resource\}` */ parent?: string; } @@ -18353,7 +18463,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Create extends StandardParameters { /** - * Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * Required. Resource name of the new source's parent. Its format should be `organizations/[organization_id]`. */ parent?: string; @@ -18365,7 +18475,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Get extends StandardParameters { /** - * Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + * Required. Relative resource name of the source. Its format is `organizations/[organization_id]/source/[source_id]`. */ name?: string; } @@ -18392,7 +18502,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; } @@ -19086,7 +19196,7 @@ export namespace securitycenter_v1 { */ findingId?: string; /** - * Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * Required. Resource name of the new finding's parent. Its format should be `organizations/[organization_id]/sources/[source_id]`. */ parent?: string; @@ -19098,7 +19208,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Findings$Group extends StandardParameters { /** - * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-, or projects/{project_id\}/sources/- + * Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-`, or `projects/{project_id\}/sources/-` */ parent?: string; @@ -19134,7 +19244,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/- or projects/{projects_id\}/sources/- + * Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-`, `folders/{folder_id\}/sources/-` or `projects/{projects_id\}/sources/-` */ parent?: string; /** @@ -19161,7 +19271,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Findings$Setmute extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -19173,7 +19283,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Organizations$Sources$Findings$Setstate extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -19636,7 +19746,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Assets$Group extends StandardParameters { /** - * Required. The name of the parent to group the assets by. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent to group the assets by. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -19672,7 +19782,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource that contains the assets. The value that you can specify on parent depends on the method in which you specify parent. You can specify one of the following values: `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; /** @@ -20185,7 +20295,7 @@ export namespace securitycenter_v1 { */ bigQueryExportId?: string; /** - * Required. The name of the parent resource of the new BigQuery export. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. The name of the parent resource of the new BigQuery export. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -20197,14 +20307,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Bigqueryexports$Delete extends StandardParameters { /** - * Required. The name of the BigQuery export to delete. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. The name of the BigQuery export to delete. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } export interface Params$Resource$Projects$Bigqueryexports$Get extends StandardParameters { /** - * Required. Name of the BigQuery export to retrieve. Its format is organizations/{organization\}/bigQueryExports/{export_id\}, folders/{folder\}/bigQueryExports/{export_id\}, or projects/{project\}/bigQueryExports/{export_id\} + * Required. Name of the BigQuery export to retrieve. Its format is `organizations/{organization\}/bigQueryExports/{export_id\}`, `folders/{folder\}/bigQueryExports/{export_id\}`, or `projects/{project\}/bigQueryExports/{export_id\}` */ name?: string; } @@ -20219,7 +20329,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of BigQuery exports. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of BigQuery exports. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } @@ -20359,7 +20469,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Validatecustommodule extends StandardParameters { /** - * Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -20954,7 +21064,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Create extends StandardParameters { /** - * Required. The new custom module's parent. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. The new custom module's parent. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; @@ -20966,14 +21076,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to delete. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Required. Name of the custom module to get. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; } @@ -20988,7 +21098,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -21003,14 +21113,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } export interface Params$Resource$Projects$Eventthreatdetectionsettings$Custommodules$Patch extends StandardParameters { /** - * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/customModules/{module\}". + * Immutable. The resource name of the Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/customModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/customModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/customModules/{module\}`. */ name?: string; /** @@ -21229,7 +21339,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Eventthreatdetectionsettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". * "projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}". + * Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `folders/{folder\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. * `projects/{project\}/eventThreatDetectionSettings/effectiveCustomModules/{module\}`. */ name?: string; } @@ -21244,7 +21354,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization\}/eventThreatDetectionSettings". * "folders/{folder\}/eventThreatDetectionSettings". * "projects/{project\}/eventThreatDetectionSettings". + * Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization\}/eventThreatDetectionSettings`. * `folders/{folder\}/eventThreatDetectionSettings`. * `projects/{project\}/eventThreatDetectionSettings`. */ parent?: string; } @@ -21348,7 +21458,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Findings$Bulkmute extends StandardParameters { /** - * Required. The parent, at which bulk action needs to be applied. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, at which bulk action needs to be applied. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; @@ -21848,7 +21958,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -21860,14 +21970,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Locations$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Projects$Locations$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -21882,14 +21992,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Projects$Locations$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -22385,7 +22495,7 @@ export namespace securitycenter_v1 { */ muteConfigId?: string; /** - * Required. Resource name of the new mute configs's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new mute configs's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -22397,14 +22507,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Muteconfigs$Delete extends StandardParameters { /** - * Required. Name of the mute config to delete. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to delete. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } export interface Params$Resource$Projects$Muteconfigs$Get extends StandardParameters { /** - * Required. Name of the mute config to retrieve. Its format is organizations/{organization\}/muteConfigs/{config_id\}, folders/{folder\}/muteConfigs/{config_id\}, projects/{project\}/muteConfigs/{config_id\}, organizations/{organization\}/locations/global/muteConfigs/{config_id\}, folders/{folder\}/locations/global/muteConfigs/{config_id\}, or projects/{project\}/locations/global/muteConfigs/{config_id\}. + * Required. Name of the mute config to retrieve. Its format is `organizations/{organization\}/muteConfigs/{config_id\}`, `folders/{folder\}/muteConfigs/{config_id\}`, `projects/{project\}/muteConfigs/{config_id\}`, `organizations/{organization\}/locations/global/muteConfigs/{config_id\}`, `folders/{folder\}/locations/global/muteConfigs/{config_id\}`, or `projects/{project\}/locations/global/muteConfigs/{config_id\}`. */ name?: string; } @@ -22419,14 +22529,14 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. The parent, which owns the collection of mute configs. Its format is "organizations/[organization_id]", "folders/[folder_id]", "projects/[project_id]". + * Required. The parent, which owns the collection of mute configs. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, `projects/[project_id]`. */ parent?: string; } export interface Params$Resource$Projects$Muteconfigs$Patch extends StandardParameters { /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string; /** @@ -22908,7 +23018,7 @@ export namespace securitycenter_v1 { */ configId?: string; /** - * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the new notification config's parent. Its format is `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; @@ -22920,14 +23030,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Notificationconfigs$Delete extends StandardParameters { /** - * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to delete. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } export interface Params$Resource$Projects$Notificationconfigs$Get extends StandardParameters { /** - * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]", "folders/[folder_id]/notificationConfigs/[config_id]", or "projects/[project_id]/notificationConfigs/[config_id]". + * Required. Name of the notification config to get. Its format is `organizations/[organization_id]/notificationConfigs/[config_id]`, `folders/[folder_id]/notificationConfigs/[config_id]`, or `projects/[project_id]/notificationConfigs/[config_id]`. */ name?: string; } @@ -23664,7 +23774,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Securityhealthanalyticssettings$Custommodules$Create extends StandardParameters { /** - * Required. Resource name of the new custom module's parent. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Resource name of the new custom module's parent. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; @@ -23676,14 +23786,14 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Securityhealthanalyticssettings$Custommodules$Delete extends StandardParameters { /** - * Required. Name of the custom module to delete. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to delete. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } export interface Params$Resource$Projects$Securityhealthanalyticssettings$Custommodules$Get extends StandardParameters { /** - * Required. Name of the custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}" + * Required. Name of the custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/customModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/customModules/{customModule\}` */ name?: string; } @@ -23698,7 +23808,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -23713,7 +23823,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list descendant custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list descendant custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -23951,7 +24061,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Securityhealthanalyticssettings$Effectivecustommodules$Get extends StandardParameters { /** - * Required. Name of the effective custom module to get. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", "folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}", or "projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}" + * Required. Name of the effective custom module to get. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, `folders/{folder\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}`, or `projects/{project\}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule\}` */ name?: string; } @@ -23966,7 +24076,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of parent to list effective custom modules. Its format is "organizations/{organization\}/securityHealthAnalyticsSettings", "folders/{folder\}/securityHealthAnalyticsSettings", or "projects/{project\}/securityHealthAnalyticsSettings" + * Required. Name of parent to list effective custom modules. Its format is `organizations/{organization\}/securityHealthAnalyticsSettings`, `folders/{folder\}/securityHealthAnalyticsSettings`, or `projects/{project\}/securityHealthAnalyticsSettings` */ parent?: string; } @@ -24083,7 +24193,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]", "folders/[folder_id]", or "projects/[project_id]". + * Required. Resource name of the parent of sources to list. Its format should be `organizations/[organization_id]`, `folders/[folder_id]`, or `projects/[project_id]`. */ parent?: string; } @@ -24642,7 +24752,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Sources$Findings$Group extends StandardParameters { /** - * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]", folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]. To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-, or projects/{project_id\}/sources/- + * Required. Name of the source to groupBy. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To groupBy across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/-`, or `projects/{project_id\}/sources/-` */ parent?: string; @@ -24678,7 +24788,7 @@ export namespace securitycenter_v1 { */ pageToken?: string; /** - * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id], folders/[folder_id]/sources/[source_id], or projects/[project_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id\}/sources/-, folders/{folder_id\}/sources/- or projects/{projects_id\}/sources/- + * Required. Name of the source the findings belong to. Its format is `organizations/[organization_id]/sources/[source_id]`, `folders/[folder_id]/sources/[source_id]`, or `projects/[project_id]/sources/[source_id]`. To list across all sources provide a source_id of `-`. For example: `organizations/{organization_id\}/sources/-`, `folders/{folder_id\}/sources/-` or `projects/{projects_id\}/sources/-` */ parent?: string; /** @@ -24705,7 +24815,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Sources$Findings$Setmute extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; @@ -24717,7 +24827,7 @@ export namespace securitycenter_v1 { export interface Params$Resource$Projects$Sources$Findings$Setstate extends StandardParameters { /** - * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: "organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}", "folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}", "projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}". + * Required. The [relative resource name](https://cloud.google.com/apis/design/resource_names#relative_resource_name) of the finding. Example: `organizations/{organization_id\}/sources/{source_id\}/findings/{finding_id\}`, `folders/{folder_id\}/sources/{source_id\}/findings/{finding_id\}`, `projects/{project_id\}/sources/{source_id\}/findings/{finding_id\}`. */ name?: string; diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index d429da079c..92c9eb53ca 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -292,7 +292,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -407,7 +407,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -446,7 +446,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -734,6 +734,10 @@ export namespace securitycenter_v1beta1 { * The exploitation activity of the vulnerability in the wild. */ exploitationActivity?: string | null; + /** + * Date the first publicly available exploit or PoC was released. + */ + exploitReleaseDate?: string | null; /** * The unique identifier for the vulnerability. e.g. CVE-2021-34527 */ @@ -855,6 +859,19 @@ export namespace securitycenter_v1beta1 { */ relativePath?: string | null; } + /** + * The record of a dynamic mute rule that matches the finding. + */ + export interface Schema$DynamicMuteRecord { + /** + * When the dynamic mute rule first matched the finding. + */ + matchTime?: string | null; + /** + * The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + */ + muteConfig?: string | null; + } /** * 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); \} */ @@ -1090,6 +1107,10 @@ export namespace securitycenter_v1beta1 { * Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. */ mute?: string | null; + /** + * Output only. The mute information regarding this finding. + */ + muteInfo?: Schema$MuteInfo; /** * Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. */ @@ -1485,6 +1506,10 @@ export namespace securitycenter_v1beta1 { * The human readable name to be displayed for the mute config. */ displayName?: string | null; + /** + * Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. + */ + expiryTime?: string | null; /** * Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` */ @@ -1494,9 +1519,13 @@ export namespace securitycenter_v1beta1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string | null; + /** + * Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. + */ + type?: string | null; /** * Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. */ @@ -1731,7 +1760,7 @@ export namespace securitycenter_v1beta1 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -1773,11 +1802,11 @@ export namespace securitycenter_v1beta1 { */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"\}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** @@ -1785,7 +1814,7 @@ export namespace securitycenter_v1beta1 { */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -1793,7 +1822,7 @@ export namespace securitycenter_v1beta1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Required. Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -1986,7 +2015,7 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$GoogleCloudSecuritycenterV2AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -2075,7 +2104,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -2114,7 +2143,7 @@ export namespace securitycenter_v1beta1 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -2172,7 +2201,7 @@ export namespace securitycenter_v1beta1 { */ createTime?: string | null; /** - * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). */ dataset?: string | null; /** @@ -2188,7 +2217,7 @@ export namespace securitycenter_v1beta1 { */ mostRecentEditor?: string | null; /** - * The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. + * Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. */ name?: string | null; /** @@ -2406,6 +2435,10 @@ export namespace securitycenter_v1beta1 { * The exploitation activity of the vulnerability in the wild. */ exploitationActivity?: string | null; + /** + * Date the first publicly available exploit or PoC was released. + */ + exploitReleaseDate?: string | null; /** * The unique identifier for the vulnerability. e.g. CVE-2021-34527 */ @@ -2527,6 +2560,19 @@ export namespace securitycenter_v1beta1 { */ relativePath?: string | null; } + /** + * The record of a dynamic mute rule that matches the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2DynamicMuteRecord { + /** + * When the dynamic mute rule first matched the finding. + */ + matchTime?: string | null; + /** + * The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + */ + muteConfig?: string | null; + } /** * A name-value pair representing an environment variable used in an operating system process. */ @@ -2788,6 +2834,10 @@ export namespace securitycenter_v1beta1 { * Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. */ mute?: string | null; + /** + * Output only. The mute information regarding this finding. + */ + muteInfo?: Schema$GoogleCloudSecuritycenterV2MuteInfo; /** * Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. */ @@ -3085,6 +3135,10 @@ export namespace securitycenter_v1beta1 { * A description of the mute config. */ description?: string | null; + /** + * Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. + */ + expiryTime?: string | null; /** * Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` */ @@ -3094,7 +3148,7 @@ export namespace securitycenter_v1beta1 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` + * Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -3106,6 +3160,19 @@ export namespace securitycenter_v1beta1 { */ updateTime?: string | null; } + /** + * Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. + */ + export interface Schema$GoogleCloudSecuritycenterV2MuteInfo { + /** + * The list of dynamic mute rules that currently match the finding. + */ + dynamicMuteRecords?: Schema$GoogleCloudSecuritycenterV2DynamicMuteRecord[]; + /** + * If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. + */ + staticMute?: Schema$GoogleCloudSecuritycenterV2StaticMute; + } /** * Kubernetes nodes associated with the finding. */ @@ -3392,7 +3459,7 @@ export namespace securitycenter_v1beta1 { */ resourcePath?: Schema$GoogleCloudSecuritycenterV2ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -3447,23 +3514,23 @@ export namespace securitycenter_v1beta1 { */ description?: string | null; /** - * Name for the resource value configuration + * Identifier. Name for the resource value configuration */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** - * Resource value level this expression represents Only required when there is no SDP mapping in the request + * Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope and will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -3471,7 +3538,7 @@ export namespace securitycenter_v1beta1 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -3610,6 +3677,19 @@ export namespace securitycenter_v1beta1 { */ principalSubject?: string | null; } + /** + * Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. + */ + export interface Schema$GoogleCloudSecuritycenterV2StaticMute { + /** + * When the static mute was applied. + */ + applyTime?: string | null; + /** + * The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + */ + state?: string | null; + } /** * Represents a Kubernetes subject. */ @@ -3665,7 +3745,7 @@ export namespace securitycenter_v1beta1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4075,6 +4155,19 @@ export namespace securitycenter_v1beta1 { */ version?: string | null; } + /** + * Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. + */ + export interface Schema$MuteInfo { + /** + * The list of dynamic mute rules that currently match the finding. + */ + dynamicMuteRecords?: Schema$DynamicMuteRecord[]; + /** + * If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. + */ + staticMute?: Schema$StaticMute; + } /** * Kubernetes nodes associated with the finding. */ @@ -4586,6 +4679,19 @@ export namespace securitycenter_v1beta1 { */ name?: string | null; } + /** + * Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. + */ + export interface Schema$StaticMute { + /** + * When the static mute was applied. + */ + applyTime?: string | null; + /** + * The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + */ + state?: string | null; + } /** * 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). */ @@ -4676,7 +4782,7 @@ export namespace securitycenter_v1beta1 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index 0912c27e6a..a4e65a7a51 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -254,7 +254,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -343,7 +343,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -382,7 +382,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -655,11 +655,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$ContainerThreatDetectionSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string | null; /** @@ -687,6 +687,10 @@ export namespace securitycenter_v1beta2 { * The exploitation activity of the vulnerability in the wild. */ exploitationActivity?: string | null; + /** + * Date the first publicly available exploit or PoC was released. + */ + exploitReleaseDate?: string | null; /** * The unique identifier for the vulnerability. e.g. CVE-2021-34527 */ @@ -825,6 +829,19 @@ export namespace securitycenter_v1beta2 { */ relativePath?: string | null; } + /** + * The record of a dynamic mute rule that matches the finding. + */ + export interface Schema$DynamicMuteRecord { + /** + * When the dynamic mute rule first matched the finding. + */ + matchTime?: string | null; + /** + * The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + */ + muteConfig?: string | null; + } /** * A name-value pair representing an environment variable used in an operating system process. */ @@ -843,11 +860,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$EventThreatDetectionSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string | null; /** @@ -1077,6 +1094,10 @@ export namespace securitycenter_v1beta2 { * Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. */ mute?: string | null; + /** + * Output only. The mute information regarding this finding. + */ + muteInfo?: Schema$MuteInfo; /** * Records additional information about the mute operation, for example, the [mute configuration](/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. */ @@ -1396,6 +1417,10 @@ export namespace securitycenter_v1beta2 { * The human readable name to be displayed for the mute config. */ displayName?: string | null; + /** + * Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. + */ + expiryTime?: string | null; /** * Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` */ @@ -1405,9 +1430,13 @@ export namespace securitycenter_v1beta2 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. Format "organizations/{organization\}/muteConfigs/{mute_config\}" "folders/{folder\}/muteConfigs/{mute_config\}" "projects/{project\}/muteConfigs/{mute_config\}" "organizations/{organization\}/locations/global/muteConfigs/{mute_config\}" "folders/{folder\}/locations/global/muteConfigs/{mute_config\}" "projects/{project\}/locations/global/muteConfigs/{mute_config\}" + * This field will be ignored if provided on config creation. Format `organizations/{organization\}/muteConfigs/{mute_config\}` `folders/{folder\}/muteConfigs/{mute_config\}` `projects/{project\}/muteConfigs/{mute_config\}` `organizations/{organization\}/locations/global/muteConfigs/{mute_config\}` `folders/{folder\}/locations/global/muteConfigs/{mute_config\}` `projects/{project\}/locations/global/muteConfigs/{mute_config\}` */ name?: string | null; + /** + * Optional. The type of the mute config, which determines what type of mute state the config affects. The static mute state takes precedence over the dynamic mute state. Immutable after creation. STATIC by default if not set during creation. + */ + type?: string | null; /** * Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. */ @@ -1642,7 +1671,7 @@ export namespace securitycenter_v1beta2 { */ resourcePath?: Schema$ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -1684,11 +1713,11 @@ export namespace securitycenter_v1beta2 { */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, `"resource_labels_selector": {"key": "value", "env": "prod"\}` will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** @@ -1696,7 +1725,7 @@ export namespace securitycenter_v1beta2 { */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -1704,7 +1733,7 @@ export namespace securitycenter_v1beta2 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV1SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Required. Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -1897,7 +1926,7 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$GoogleCloudSecuritycenterV2AttackExposure { /** - * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: organizations/123/simulations/456/attackExposureResults/789 + * The resource name of the attack path simulation result that contains the details regarding this attack exposure score. Example: `organizations/123/simulations/456/attackExposureResults/789` */ attackExposureResult?: string | null; /** @@ -1986,7 +2015,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure management group, for example, "20000000-0001-0000-0000-000000000000". + * The UUID of the Azure management group, for example, `20000000-0001-0000-0000-000000000000`. */ id?: string | null; } @@ -2025,7 +2054,7 @@ export namespace securitycenter_v1beta2 { */ displayName?: string | null; /** - * The UUID of the Azure subscription, for example, "291bba3f-e0a5-47bc-a099-3bdcb2a50a05". + * The UUID of the Azure subscription, for example, `291bba3f-e0a5-47bc-a099-3bdcb2a50a05`. */ id?: string | null; } @@ -2083,7 +2112,7 @@ export namespace securitycenter_v1beta2 { */ createTime?: string | null; /** - * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). + * The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). */ dataset?: string | null; /** @@ -2099,7 +2128,7 @@ export namespace securitycenter_v1beta2 { */ mostRecentEditor?: string | null; /** - * The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. + * Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `folders/{folder_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` + `projects/{project_id\}/locations/{location_id\}/bigQueryExports/{export_id\}` This field is provided in responses, and is ignored when provided in create requests. */ name?: string | null; /** @@ -2317,6 +2346,10 @@ export namespace securitycenter_v1beta2 { * The exploitation activity of the vulnerability in the wild. */ exploitationActivity?: string | null; + /** + * Date the first publicly available exploit or PoC was released. + */ + exploitReleaseDate?: string | null; /** * The unique identifier for the vulnerability. e.g. CVE-2021-34527 */ @@ -2438,6 +2471,19 @@ export namespace securitycenter_v1beta2 { */ relativePath?: string | null; } + /** + * The record of a dynamic mute rule that matches the finding. + */ + export interface Schema$GoogleCloudSecuritycenterV2DynamicMuteRecord { + /** + * When the dynamic mute rule first matched the finding. + */ + matchTime?: string | null; + /** + * The relative resource name of the mute rule, represented by a mute config, that created this record, for example `organizations/123/muteConfigs/mymuteconfig` or `organizations/123/locations/global/muteConfigs/mymuteconfig`. + */ + muteConfig?: string | null; + } /** * A name-value pair representing an environment variable used in an operating system process. */ @@ -2699,6 +2745,10 @@ export namespace securitycenter_v1beta2 { * Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. */ mute?: string | null; + /** + * Output only. The mute information regarding this finding. + */ + muteInfo?: Schema$GoogleCloudSecuritycenterV2MuteInfo; /** * Records additional information about the mute operation, for example, the [mute configuration](https://cloud.google.com/security-command-center/docs/how-to-mute-findings) that muted the finding and the user who muted the finding. */ @@ -2996,6 +3046,10 @@ export namespace securitycenter_v1beta2 { * A description of the mute config. */ description?: string | null; + /** + * Optional. The expiry of the mute config. Only applicable for dynamic configs. If the expiry is set, when the config expires, it is removed from all findings. + */ + expiryTime?: string | null; /** * Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` */ @@ -3005,7 +3059,7 @@ export namespace securitycenter_v1beta2 { */ mostRecentEditor?: string | null; /** - * This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` + * Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization\}/muteConfigs/{mute_config\}` + `organizations/{organization\}locations/{location\}//muteConfigs/{mute_config\}` + `folders/{folder\}/muteConfigs/{mute_config\}` + `folders/{folder\}/locations/{location\}/muteConfigs/{mute_config\}` + `projects/{project\}/muteConfigs/{mute_config\}` + `projects/{project\}/locations/{location\}/muteConfigs/{mute_config\}` */ name?: string | null; /** @@ -3017,6 +3071,19 @@ export namespace securitycenter_v1beta2 { */ updateTime?: string | null; } + /** + * Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. + */ + export interface Schema$GoogleCloudSecuritycenterV2MuteInfo { + /** + * The list of dynamic mute rules that currently match the finding. + */ + dynamicMuteRecords?: Schema$GoogleCloudSecuritycenterV2DynamicMuteRecord[]; + /** + * If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. + */ + staticMute?: Schema$GoogleCloudSecuritycenterV2StaticMute; + } /** * Kubernetes nodes associated with the finding. */ @@ -3303,7 +3370,7 @@ export namespace securitycenter_v1beta2 { */ resourcePath?: Schema$GoogleCloudSecuritycenterV2ResourcePath; /** - * A string representation of the resource path. For Google Cloud, it has the format of organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\} where there can be any number of folders. For AWS, it has the format of org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\} where there can be any number of management groups. + * A string representation of the resource path. For Google Cloud, it has the format of `organizations/{organization_id\}/folders/{folder_id\}/folders/{folder_id\}/projects/{project_id\}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id\}/ou/{organizational_unit_id\}/ou/{organizational_unit_id\}/account/{account_id\}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id\}/mg/{management_group_id\}/subscription/{subscription_id\}/rg/{resource_group_name\}` where there can be any number of management groups. */ resourcePathString?: string | null; /** @@ -3358,23 +3425,23 @@ export namespace securitycenter_v1beta2 { */ description?: string | null; /** - * Name for the resource value configuration + * Identifier. Name for the resource value configuration */ name?: string | null; /** - * List of resource labels to search for, evaluated with AND. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels + * List of resource labels to search for, evaluated with `AND`. For example, "resource_labels_selector": {"key": "value", "env": "prod"\} will match resources with labels "key": "value" `AND` "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels */ resourceLabelsSelector?: {[key: string]: string} | null; /** - * Apply resource_value only to resources that match resource_type. resource_type will be checked with AND of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. + * Apply resource_value only to resources that match resource_type. resource_type will be checked with `AND` of other resources. For example, "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. */ resourceType?: string | null; /** - * Resource value level this expression represents Only required when there is no SDP mapping in the request + * Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request */ resourceValue?: string | null; /** - * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope will be checked with AND of other resources. + * Project or folder to scope this configuration to. For example, "project/456" would apply this configuration only to resources in "project/456" scope and will be checked with `AND` of other resources. */ scope?: string | null; /** @@ -3382,7 +3449,7 @@ export namespace securitycenter_v1beta2 { */ sensitiveDataProtectionMapping?: Schema$GoogleCloudSecuritycenterV2SensitiveDataProtectionMapping; /** - * Required. Tag values combined with AND to check against. Values in the form "tagValues/123" Example: [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing + * Tag values combined with `AND` to check against. Values in the form "tagValues/123" Example: `[ "tagValues/123", "tagValues/456", "tagValues/789" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing */ tagValues?: string[] | null; /** @@ -3521,6 +3588,19 @@ export namespace securitycenter_v1beta2 { */ principalSubject?: string | null; } + /** + * Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. + */ + export interface Schema$GoogleCloudSecuritycenterV2StaticMute { + /** + * When the static mute was applied. + */ + applyTime?: string | null; + /** + * The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + */ + state?: string | null; + } /** * Represents a Kubernetes subject. */ @@ -3576,7 +3656,7 @@ export namespace securitycenter_v1beta2 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -3804,6 +3884,19 @@ export namespace securitycenter_v1beta2 { */ version?: string | null; } + /** + * Mute information about the finding, including whether the finding has a static mute or any matching dynamic mute rules. + */ + export interface Schema$MuteInfo { + /** + * The list of dynamic mute rules that currently match the finding. + */ + dynamicMuteRecords?: Schema$DynamicMuteRecord[]; + /** + * If set, the static mute applied to this finding. Static mutes override dynamic mutes. If unset, there is no static mute. + */ + staticMute?: Schema$StaticMute; + } /** * Kubernetes nodes associated with the finding. */ @@ -4143,11 +4236,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$SecurityHealthAnalyticsSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string | null; /** @@ -4247,6 +4340,19 @@ export namespace securitycenter_v1beta2 { */ principalSubject?: string | null; } + /** + * Information about the static mute state. A static mute state overrides any dynamic mute rules that apply to this finding. The static mute state can be set by a static mute rule or by muting the finding directly. + */ + export interface Schema$StaticMute { + /** + * When the static mute was applied. + */ + applyTime?: string | null; + /** + * The static mute state. If the value is `MUTED` or `UNMUTED`, then the finding's overall mute state will have the same value. + */ + state?: string | null; + } /** * Represents a Kubernetes subject. */ @@ -4319,7 +4425,7 @@ export namespace securitycenter_v1beta2 { */ attackExposureScore?: number | null; /** - * List of resource names of findings associated with this toxic combination. For example, organizations/123/sources/456/findings/789. + * List of resource names of findings associated with this toxic combination. For example, `organizations/123/sources/456/findings/789`. */ relatedFindings?: string[] | null; } @@ -4328,11 +4434,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$VirtualMachineThreatDetectionSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string | null; /** @@ -4404,11 +4510,11 @@ export namespace securitycenter_v1beta2 { */ export interface Schema$WebSecurityScannerSettings { /** - * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + * The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. */ modules?: {[key: string]: Schema$Config} | null; /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string | null; /** @@ -5747,7 +5853,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** @@ -5763,7 +5869,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updateeventthreatdetectionsettings extends StandardParameters { /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; /** @@ -5795,7 +5901,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatesecurityhealthanalyticssettings extends StandardParameters { /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; /** @@ -5811,7 +5917,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatevirtualmachinethreatdetectionsettings extends StandardParameters { /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; /** @@ -5827,7 +5933,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Folders$Updatewebsecurityscannersettings extends StandardParameters { /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; /** @@ -7942,7 +8048,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** @@ -7958,7 +8064,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updateeventthreatdetectionsettings extends StandardParameters { /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; /** @@ -7990,7 +8096,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatesecurityhealthanalyticssettings extends StandardParameters { /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; /** @@ -8006,7 +8112,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatevirtualmachinethreatdetectionsettings extends StandardParameters { /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; /** @@ -8022,7 +8128,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Organizations$Updatewebsecurityscannersettings extends StandardParameters { /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; /** @@ -10038,7 +10144,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** @@ -10054,7 +10160,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updateeventthreatdetectionsettings extends StandardParameters { /** - * The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings + * Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization\}/eventThreatDetectionSettings * folders/{folder\}/eventThreatDetectionSettings * projects/{project\}/eventThreatDetectionSettings */ name?: string; /** @@ -10086,7 +10192,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatesecurityhealthanalyticssettings extends StandardParameters { /** - * The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings + * Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization\}/securityHealthAnalyticsSettings * folders/{folder\}/securityHealthAnalyticsSettings * projects/{project\}/securityHealthAnalyticsSettings */ name?: string; /** @@ -10102,7 +10208,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatevirtualmachinethreatdetectionsettings extends StandardParameters { /** - * The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings + * Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization\}/virtualMachineThreatDetectionSettings * folders/{folder\}/virtualMachineThreatDetectionSettings * projects/{project\}/virtualMachineThreatDetectionSettings */ name?: string; /** @@ -10118,7 +10224,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Updatewebsecurityscannersettings extends StandardParameters { /** - * The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings + * Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization\}/webSecurityScannerSettings * folders/{folder\}/webSecurityScannerSettings * projects/{project\}/webSecurityScannerSettings */ name?: string; /** @@ -10583,7 +10689,7 @@ export namespace securitycenter_v1beta2 { export interface Params$Resource$Projects$Locations$Clusters$Updatecontainerthreatdetectionsettings extends StandardParameters { /** - * The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings + * Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization\}/containerThreatDetectionSettings * folders/{folder\}/containerThreatDetectionSettings * projects/{project\}/containerThreatDetectionSettings * projects/{project\}/locations/{location\}/clusters/{cluster\}/containerThreatDetectionSettings */ name?: string; /** diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 2fabfa6bc4..d81daaf437 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -448,11 +448,11 @@ export namespace serviceconsumermanagement_v1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -778,7 +778,7 @@ export namespace serviceconsumermanagement_v1 { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** diff --git a/src/apis/serviceconsumermanagement/v1beta1.ts b/src/apis/serviceconsumermanagement/v1beta1.ts index 81634fcb34..ec485867ab 100644 --- a/src/apis/serviceconsumermanagement/v1beta1.ts +++ b/src/apis/serviceconsumermanagement/v1beta1.ts @@ -392,11 +392,11 @@ export namespace serviceconsumermanagement_v1beta1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -704,7 +704,7 @@ export namespace serviceconsumermanagement_v1beta1 { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index 3479b0df36..dffc30d867 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -1504,6 +1504,10 @@ export namespace servicecontrol_v1 { * Report v2 extension proto for passing the resource metadata associated with a resource create/update/delete/undelete event from ESF to Chemist. ResourceEvent proto should be serialized into the ReportRequest.operations.extensions. */ export interface Schema$V1ResourceEvent { + /** + * The ESF unique context id of the api request, from which this resource event originated. This field is only needed for CAIS integration via api annotation. See go/cais-lro-delete for more details. + */ + contextId?: string | null; /** * The destinations field determines which backend services should handle the event. This should be specified as a comma-delimited string. */ diff --git a/src/apis/servicecontrol/v2.ts b/src/apis/servicecontrol/v2.ts index bfc223decb..6b01ab0e77 100644 --- a/src/apis/servicecontrol/v2.ts +++ b/src/apis/servicecontrol/v2.ts @@ -898,6 +898,10 @@ export namespace servicecontrol_v2 { * Report v2 extension proto for passing the resource metadata associated with a resource create/update/delete/undelete event from ESF to Chemist. ResourceEvent proto should be serialized into the ReportRequest.operations.extensions. */ export interface Schema$V2ResourceEvent { + /** + * The ESF unique context id of the api request, from which this resource event originated. This field is only needed for CAIS integration via api annotation. See go/cais-lro-delete for more details. + */ + contextId?: string | null; /** * The destinations field determines which backend services should handle the event. This should be specified as a comma-delimited string. */ diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 52135ddb0b..3354b2806b 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -517,11 +517,11 @@ export namespace servicemanagement_v1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -936,7 +936,7 @@ export namespace servicemanagement_v1 { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 7bf0a864f5..0065806e1f 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -666,11 +666,11 @@ export namespace servicenetworking_v1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -813,7 +813,7 @@ export namespace servicenetworking_v1 { producerPrivateZone?: Schema$DnsZone; } /** - * `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: \> ... - selector: google.calendar.Calendar.Put description: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. + * `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: \> ... - selector: google.calendar.Calendar.Put description: \> ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -1132,7 +1132,7 @@ export namespace servicenetworking_v1 { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index b4767ebdac..b69561c680 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -562,11 +562,11 @@ export namespace servicenetworking_v1beta { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -678,7 +678,7 @@ export namespace servicenetworking_v1beta { name?: string | null; } /** - * `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: \> ... - selector: google.calendar.Calendar.Put description: \> ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. + * `Documentation` provides the information for describing a service. Example: documentation: summary: \> The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: \> ... - selector: google.calendar.Calendar.Put description: \> ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. */ export interface Schema$Documentation { /** @@ -971,7 +971,7 @@ export namespace servicenetworking_v1beta { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index a294ccc4ce..bc5dfce379 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -172,6 +172,53 @@ export namespace serviceusage_v1 { */ unit?: string | null; } + /** + * A message to group the analysis information. + */ + export interface Schema$Analysis { + /** + * Output only. Analysis result of updating a policy. + */ + analysis?: Schema$AnalysisResult; + /** + * Output only. The type of analysis. + */ + analysisType?: string | null; + /** + * Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc. + */ + displayName?: string | null; + /** + * The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`. + */ + service?: string | null; + } + /** + * An analysis result including blockers and warnings. + */ + export interface Schema$AnalysisResult { + /** + * Blocking information that would prevent the policy changes at runtime. + */ + blockers?: Schema$Impact[]; + /** + * Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime. + */ + warnings?: Schema$Impact[]; + } + /** + * Metadata for the `AnalyzeConsumerPolicy` method. + */ + export interface Schema$AnalyzeConsumerPolicyMetadata {} + /** + * The response of analyzing a consumer policy update. + */ + export interface Schema$AnalyzeConsumerPolicyResponse { + /** + * The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers. + */ + analysis?: Schema$Analysis[]; + } /** * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ @@ -516,11 +563,11 @@ export namespace serviceusage_v1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -1182,7 +1229,7 @@ export namespace serviceusage_v1 { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** @@ -1226,6 +1273,19 @@ export namespace serviceusage_v1 { */ selector?: string | null; } + /** + * A message to group impacts of updating a policy. + */ + export interface Schema$Impact { + /** + * Output only. User friendly impact detail in a free form message. + */ + detail?: string | null; + /** + * Output only. The type of impact. + */ + impactType?: string | null; + } /** * Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides. */ diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index f5e74b9c85..5f479375b0 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -172,6 +172,53 @@ export namespace serviceusage_v1beta1 { */ unit?: string | null; } + /** + * A message to group the analysis information. + */ + export interface Schema$Analysis { + /** + * Output only. Analysis result of updating a policy. + */ + analysis?: Schema$AnalysisResult; + /** + * Output only. The type of analysis. + */ + analysisType?: string | null; + /** + * Output only. The user friendly display name of the analysis type. E.g. service dependency analysis, service resource usage analysis, etc. + */ + displayName?: string | null; + /** + * The names of the service that has analysis result of warnings or blockers. Example: `services/storage.googleapis.com`. + */ + service?: string | null; + } + /** + * An analysis result including blockers and warnings. + */ + export interface Schema$AnalysisResult { + /** + * Blocking information that would prevent the policy changes at runtime. + */ + blockers?: Schema$Impact[]; + /** + * Warning information indicating that the policy changes might be unsafe, but will not block the changes at runtime. + */ + warnings?: Schema$Impact[]; + } + /** + * Metadata for the `AnalyzeConsumerPolicy` method. + */ + export interface Schema$AnalyzeConsumerPolicyMetadata {} + /** + * The response of analyzing a consumer policy update. + */ + export interface Schema$AnalyzeConsumerPolicyResponse { + /** + * The list of analyses returned from performing the intended policy update analysis. The analysis is grouped by service name and different analysis types. The empty analysis list means that the consumer policy can be updated without any warnings or blockers. + */ + analysis?: Schema$Analysis[]; + } /** * Api is a light-weight descriptor for an API Interface. Interfaces are also described as "protocol buffer services" in some contexts, such as by the "service" keyword in a .proto file, but they are different from API Services, which represent a concrete implementation of an interface as opposed to simply a description of methods and bindings. They are also sometimes simply referred to as "APIs" in other contexts, such as the name of this message itself. See https://cloud.google.com/apis/design/glossary for detailed terminology. */ @@ -565,11 +612,11 @@ export namespace serviceusage_v1beta1 { */ allowedResponseExtensions?: string[] | null; /** - * A list of full type names of provided contexts. + * A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. */ provided?: string[] | null; /** - * A list of full type names of requested contexts. + * A list of full type names of requested contexts, only the requested context will be made available to the backend. */ requested?: string[] | null; /** @@ -1222,7 +1269,7 @@ export namespace serviceusage_v1beta1 { rules?: Schema$HttpRule[]; } /** - * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + * gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/x\}" \}; \} \} message GetMessageRequest { string name = 1; // Mapped to URL path. \} message Message { string text = 1; // The resource content. \} This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id\}" \}; \} \} message GetMessageRequest { message SubMessage { string subfield = 1; \} string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. \} This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "message" \}; \} \} message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body \} The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" \})` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id\}" body: "*" \}; \} \} message Message { string message_id = 1; string text = 2; \} The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" \}` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id\}" additional_bindings { get: "/v1/users/{user_id\}/messages/{message_id\}" \} \}; \} \} message GetMessageRequest { string message_id = 1; string user_id = 2; \} This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment \} ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "\}" ; FieldPath = IDENT { "." IDENT \} ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var\}` is equivalent to `{var=*\}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var\}"` or `"{var=*\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var\}`. If a variable contains multiple path segments, such as `"{var=foo/x\}"` or `"{var=**\}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var\}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id\}/{sub.subfield\} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var\}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. */ export interface Schema$HttpRule { /** @@ -1266,6 +1313,19 @@ export namespace serviceusage_v1beta1 { */ selector?: string | null; } + /** + * A message to group impacts of updating a policy. + */ + export interface Schema$Impact { + /** + * Output only. User friendly impact detail in a free form message. + */ + detail?: string | null; + /** + * Output only. The type of impact. + */ + impactType?: string | null; + } /** * Metadata message that provides information such as progress, partial failures, and similar information on each GetOperation call of LRO returned by ImportAdminOverrides. */ diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 4f48dcb946..42e88c468a 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -174,7 +174,7 @@ export namespace sheets_v4 { rule?: Schema$ConditionalFormatRule; } /** - * Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope. + * Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source. */ export interface Schema$AddDataSourceRequest { /** @@ -1055,7 +1055,7 @@ export namespace sheets_v4 { series?: Schema$ChartData; } /** - * Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. + * Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source. */ export interface Schema$CancelDataSourceRefreshRequest { /** @@ -1908,6 +1908,10 @@ export namespace sheets_v4 { * A BigQueryDataSourceSpec. */ bigQuery?: Schema$BigQueryDataSourceSpec; + /** + * A LookerDatasourceSpec. + */ + looker?: Schema$LookerDataSourceSpec; /** * The parameters of the data source, used when querying the data source. */ @@ -2879,6 +2883,23 @@ export namespace sheets_v4 { */ uri?: string | null; } + /** + * The specification of a Looker data source. + */ + export interface Schema$LookerDataSourceSpec { + /** + * Name of a Looker model explore. + */ + explore?: string | null; + /** + * A Looker instance URL. + */ + instanceUri?: string | null; + /** + * Name of a Looker model. + */ + model?: string | null; + } /** * Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+ */ @@ -3407,7 +3428,7 @@ export namespace sheets_v4 { reference?: Schema$DataSourceObjectReference; } /** - * Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. + * Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. */ export interface Schema$RefreshDataSourceRequest { /** @@ -4590,7 +4611,7 @@ export namespace sheets_v4 { oldRule?: Schema$ConditionalFormatRule; } /** - * Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope. + * Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source. */ export interface Schema$UpdateDataSourceRequest { /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index c7d879f791..5d600321da 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -127,7 +127,7 @@ export namespace spanner_v1 { } /** - * Autoscaling config for an instance. + * Autoscaling configuration for an instance. */ export interface Schema$AutoscalingConfig { /** @@ -177,6 +177,10 @@ export namespace spanner_v1 { * A backup of a Cloud Spanner database. */ export interface Schema$Backup { + /** + * Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + */ + backupSchedules?: string[] | null; /** * Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. */ @@ -197,10 +201,22 @@ export namespace spanner_v1 { * Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The `encryption_status' field inside of each `EncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined. */ encryptionInformation?: Schema$EncryptionInfo[]; + /** + * Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired. This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field. + */ + exclusiveSizeBytes?: string | null; /** * Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. */ expireTime?: string | null; + /** + * Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired. + */ + freeableSizeBytes?: string | null; + /** + * Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup `version_time`. + */ + incrementalBackupChainId?: string | null; /** * Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. */ @@ -209,6 +225,10 @@ export namespace spanner_v1 { * Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. */ name?: string | null; + /** + * Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system. + */ + oldestVersionTime?: string | null; /** * Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. */ @@ -218,7 +238,7 @@ export namespace spanner_v1 { */ referencingDatabases?: string[] | null; /** - * Output only. Size of the backup in bytes. + * Output only. Size of the backup in bytes. For a backup in an incremental backup chain, this is the sum of the `exclusive_size_bytes` of itself and all older backups in the chain. */ sizeBytes?: string | null; /** @@ -251,6 +271,48 @@ export namespace spanner_v1 { */ versionTime?: string | null; } + /** + * BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10 + */ + export interface Schema$BackupSchedule { + /** + * Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. + */ + encryptionConfig?: Schema$CreateBackupEncryptionConfig; + /** + * The schedule creates only full backups. + */ + fullBackupSpec?: Schema$FullBackupSpec; + /** + * The schedule creates incremental backup chains. + */ + incrementalBackupSpec?: Schema$IncrementalBackupSpec; + /** + * Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. + */ + name?: string | null; + /** + * Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. + */ + retentionDuration?: string | null; + /** + * Optional. The schedule specification based on which the backup creations are triggered. + */ + spec?: Schema$BackupScheduleSpec; + /** + * Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. + */ + updateTime?: string | null; + } + /** + * Defines specifications of the backup schedule. + */ + export interface Schema$BackupScheduleSpec { + /** + * Cron style schedule specification. + */ + cronSpec?: Schema$CrontabSpec; + } /** * The request for BatchCreateSessions. */ @@ -359,15 +421,15 @@ export namespace spanner_v1 { */ export interface Schema$ChangeQuorumRequest { /** - * Optional. The etag is the hash of the QuorumInfo. The ChangeQuorum operation will only be performed if the etag matches that of the QuorumInfo in the current database resource. Otherwise the API will return an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition. + * Optional. The etag is the hash of the `QuorumInfo`. The `ChangeQuorum` operation is only performed if the etag matches that of the `QuorumInfo` in the current database resource. Otherwise the API returns an `ABORTED` error. The etag is used for optimistic concurrency control as a way to help prevent simultaneous change quorum requests that could create a race condition. */ etag?: string | null; /** - * Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`. + * Required. Name of the database in which to apply `ChangeQuorum`. Values are of the form `projects//instances//databases/`. */ name?: string | null; /** - * Required. The type of this Quorum. + * Required. The type of this quorum. */ quorumType?: Schema$QuorumType; } @@ -519,6 +581,23 @@ export namespace spanner_v1 { */ sourceBackup?: string | null; } + /** + * Encryption configuration for the backup to create. + */ + export interface Schema$CreateBackupEncryptionConfig { + /** + * Required. The encryption type of the backup. + */ + encryptionType?: string | null; + /** + * Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. + */ + kmsKeyName?: string | null; + /** + * Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. + */ + kmsKeyNames?: string[] | null; + } /** * Metadata type for the operation returned by CreateBackup. */ @@ -570,7 +649,7 @@ export namespace spanner_v1 { */ extraStatements?: string[] | null; /** - * Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + * Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). */ protoDescriptors?: string | null; } @@ -583,7 +662,7 @@ export namespace spanner_v1 { */ cancelTime?: string | null; /** - * The target instance config end state. + * The target instance configuration end state. */ instanceConfig?: Schema$InstanceConfig; /** @@ -596,11 +675,11 @@ export namespace spanner_v1 { */ export interface Schema$CreateInstanceConfigRequest { /** - * Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. + * Required. The `InstanceConfig` proto of the configuration to create. `instance_config.name` must be `/instanceConfigs/`. `instance_config.base_config` must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3. */ instanceConfig?: Schema$InstanceConfig; /** - * Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations. + * Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations. */ instanceConfigId?: string | null; /** @@ -689,6 +768,23 @@ export namespace spanner_v1 { */ session?: Schema$Session; } + /** + * CrontabSpec can be used to specify the version time and frequency at which the backup should be created. + */ + export interface Schema$CrontabSpec { + /** + * Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`. + */ + creationWindow?: string | null; + /** + * Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC. + */ + text?: string | null; + /** + * Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported. + */ + timeZone?: string | null; + } /** * A Cloud Spanner database. */ @@ -710,7 +806,7 @@ export namespace spanner_v1 { */ earliestVersionTime?: string | null; /** - * Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). + * Optional. Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). */ enableDropProtection?: boolean | null; /** @@ -726,7 +822,7 @@ export namespace spanner_v1 { */ name?: string | null; /** - * Output only. Applicable only for databases that use dual region instance configurations. Contains information about the quorum. + * Output only. Applicable only for databases that use dual-region instance configurations. Contains information about the quorum. */ quorumInfo?: Schema$QuorumInfo; /** @@ -1021,6 +1117,10 @@ export namespace spanner_v1 { */ upgradeTime?: string | null; } + /** + * The specification for full backups. A full backup stores the entire contents of the database at a given version time. + */ + export interface Schema$FullBackupSpec {} /** * The response for GetDatabaseDdl. */ @@ -1065,6 +1165,10 @@ export namespace spanner_v1 { */ replicaSelections?: Schema$ReplicaSelection[]; } + /** + * The specification for incremental backup chains. An incremental backup stores the delta of changes between a previous backup and the database contents at a given version time. An incremental backup chain consists of a full backup and zero or more successive incremental backups. The first backup created for an incremental backup chain is always a full backup. + */ + export interface Schema$IncrementalBackupSpec {} /** * Recommendation to add new indexes to run queries more efficiently. */ @@ -1116,6 +1220,10 @@ export namespace spanner_v1 { * Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. */ displayName?: string | null; + /** + * Optional. The `Edition` of the current instance. + */ + edition?: string | null; /** * Deprecated. This field is not populated. */ @@ -1137,11 +1245,11 @@ export namespace spanner_v1 { */ name?: string | null; /** - * The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + * The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the `node_count` field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, `node_count` is treated as an `OUTPUT_ONLY` field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity). */ nodeCount?: number | null; /** - * The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + * The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes and processing units](https://cloud.google.com/spanner/docs/compute-capacity). */ processingUnits?: number | null; /** @@ -1158,11 +1266,11 @@ export namespace spanner_v1 { */ export interface Schema$InstanceConfig { /** - * Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration. + * Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration. */ baseConfig?: string | null; /** - * Output only. Whether this instance config is a Google or User Managed Configuration. + * Output only. Whether this instance configuration is a Google-managed or user-managed configuration. */ configType?: string | null; /** @@ -1170,11 +1278,11 @@ export namespace spanner_v1 { */ displayName?: string | null; /** - * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. + * etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly. */ etag?: string | null; /** - * Output only. Describes whether free instances are available to be created in this instance config. + * Output only. Describes whether free instances are available to be created in this instance configuration. */ freeInstanceAvailability?: string | null; /** @@ -1186,11 +1294,11 @@ export namespace spanner_v1 { */ leaderOptions?: string[] | null; /** - * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */ name?: string | null; /** - * Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + * Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. */ optionalReplicas?: Schema$ReplicaInfo[]; /** @@ -1198,15 +1306,15 @@ export namespace spanner_v1 { */ quorumType?: string | null; /** - * Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. + * Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance configuration. */ reconciling?: boolean | null; /** - * The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. + * The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`. */ replicas?: Schema$ReplicaInfo[]; /** - * Output only. The current instance config state. Applicable only for USER_MANAGED configs. + * Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. */ state?: string | null; /** @@ -1256,15 +1364,15 @@ export namespace spanner_v1 { */ name?: string | null; /** - * The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + * The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. */ nodeCount?: number | null; /** - * The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + * The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. */ processingUnits?: number | null; /** - * Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. + * Output only. Deprecated: This field is not populated. Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. */ referencingBackups?: string[] | null; /** @@ -1385,6 +1493,19 @@ export namespace spanner_v1 { */ operations?: Schema$Operation[]; } + /** + * The response for ListBackupSchedules. + */ + export interface Schema$ListBackupSchedulesResponse { + /** + * The list of backup schedules for a database. + */ + backupSchedules?: Schema$BackupSchedule[]; + /** + * `next_page_token` can be sent in a subsequent ListBackupSchedules call to fetch more of the schedules. + */ + nextPageToken?: string | null; + } /** * The response for ListBackups. */ @@ -1446,7 +1567,7 @@ export namespace spanner_v1 { */ nextPageToken?: string | null; /** - * The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. + * The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the name of the instance configuration. The operation's metadata field type `metadata.type_url` describes the type of the metadata. */ operations?: Schema$Operation[]; } @@ -1646,7 +1767,7 @@ export namespace spanner_v1 { */ export interface Schema$MoveInstanceRequest { /** - * Required. The target instance config for the instance to move. Values are of the form `projects//instanceConfigs/`. + * Required. The target instance configuration where to move the instance. Values are of the form `projects//instanceConfigs/`. */ targetConfig?: string | null; } @@ -1807,7 +1928,7 @@ export namespace spanner_v1 { */ partitionOptions?: Schema$PartitionOptions; /** - * Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. + * Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations. */ sql?: string | null; /** @@ -1968,15 +2089,15 @@ export namespace spanner_v1 { queryAdvice?: Schema$QueryAdvisorResult; } /** - * Information about the dual region quorum. + * Information about the dual-region quorum. */ export interface Schema$QuorumInfo { /** - * Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous ChangeQuorum requests that could create a race condition. + * Output only. The etag is used for optimistic concurrency control as a way to help prevent simultaneous `ChangeQuorum` requests that might create a race condition. */ etag?: string | null; /** - * Output only. Whether this ChangeQuorum is a Google or User initiated. + * Output only. Whether this `ChangeQuorum` is Google or User initiated. */ initiator?: string | null; /** @@ -1989,15 +2110,15 @@ export namespace spanner_v1 { startTime?: string | null; } /** - * Information about the database quorum type. this applies only for dual region instance configs. + * Information about the database quorum type. This only applies to dual-region instance configs. */ export interface Schema$QuorumType { /** - * Dual region quorum type. + * Dual-region quorum type. */ dualRegion?: Schema$DualRegionQuorum; /** - * Single region quorum type. + * Single-region quorum type. */ singleRegion?: Schema$SingleRegionQuorum; } @@ -2153,7 +2274,7 @@ export namespace spanner_v1 { */ kmsKeyName?: string | null; /** - * Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. + * Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations. */ kmsKeyNames?: string[] | null; } @@ -2378,7 +2499,7 @@ export namespace spanner_v1 { */ export interface Schema$SingleRegionQuorum { /** - * Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual region instance configuration of your database. The list of valid locations is available via [GetInstanceConfig[InstanceAdmin.GetInstanceConfig] API. This should only be used if you plan to change quorum in single-region quorum type. + * Required. The location of the serving region, e.g. "us-central1". The location must be one of the regions within the dual-region instance configuration of your database. The list of valid locations is available using the GetInstanceConfig API. This should only be used if you plan to change quorum to the single-region quorum type. */ servingLocation?: string | null; } @@ -2604,7 +2725,7 @@ export namespace spanner_v1 { */ cancelTime?: string | null; /** - * The desired instance config after updating. + * The desired instance configuration after updating. */ instanceConfig?: Schema$InstanceConfig; /** @@ -2617,7 +2738,7 @@ export namespace spanner_v1 { */ export interface Schema$UpdateInstanceConfigRequest { /** - * Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. + * Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used. */ instanceConfig?: Schema$InstanceConfig; /** @@ -2784,7 +2905,7 @@ export namespace spanner_v1 { } /** - * Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation. + * Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2884,7 +3005,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigoperations$List extends StandardParameters { /** - * An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error. + * An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `\>`, `<=`, `\>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error. */ filter?: string; /** @@ -2896,7 +3017,7 @@ export namespace spanner_v1 { */ pageToken?: string; /** - * Required. The project of the instance config operations. Values are of the form `projects/`. + * Required. The project of the instance configuration operations. Values are of the form `projects/`. */ parent?: string; } @@ -2916,7 +3037,7 @@ export namespace spanner_v1 { } /** - * Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. + * Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance configuration. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance configuration's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance configuration's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance configuration. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3004,7 +3125,7 @@ export namespace spanner_v1 { } /** - * Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. + * Deletes the instance configuration. Deletion is only allowed when no instances are using the configuration. If any instances are using the configuration, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3174,7 +3295,7 @@ export namespace spanner_v1 { } /** - * Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs. + * Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3269,7 +3390,7 @@ export namespace spanner_v1 { } /** - * Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. + * Updates an instance configuration. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance configuration's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The new values of the instance configuration are readable via the API. * The instance configuration's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3357,7 +3478,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigs$Create extends StandardParameters { /** - * Required. The name of the project in which to create the instance config. Values are of the form `projects/`. + * Required. The name of the project in which to create the instance configuration. Values are of the form `projects/`. */ parent?: string; @@ -3369,7 +3490,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigs$Delete extends StandardParameters { /** - * Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config. + * Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance configuration. Otherwise, deletes the instance configuration without checking the current status of the requested instance configuration. */ etag?: string; /** @@ -3406,7 +3527,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instanceconfigs$Patch extends StandardParameters { /** - * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + * A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. */ name?: string; @@ -4689,7 +4810,7 @@ export namespace spanner_v1 { } /** - * Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance). + * Moves an instance to the target instance configuration. You can use the returned long-running operation to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Is undergoing a move to a different instance configuration * Has backups * Has an ongoing update * Contains any CMEK-enabled databases * Is a free trial instance While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * `DatabaseAdmin.CreateDatabase` * `DatabaseAdmin.UpdateDatabaseDdl` (disabled if default_leader is specified in the request.) * `DatabaseAdmin.RestoreDatabase` * `DatabaseAdmin.CreateBackup` * `DatabaseAdmin.CopyBackup` * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance might experience higher read-write latencies and a higher transaction abort rate. However, moving an instance doesn't cause any downtime. The returned long-running operation has a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate because it involves moving any data previously moved to the target instance configuration back to the original instance configuration. You can use this operation to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. If not cancelled, upon completion of the returned operation: * The instance successfully moves to the target instance configuration. * You are billed for compute and storage in target instance configuration. Authorization requires the `spanner.instances.update` permission on the resource instance. For more details, see [Move an instance](https://cloud.google.com/spanner/docs/move-instance). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6735,11 +6856,14 @@ export namespace spanner_v1 { export class Resource$Projects$Instances$Databases { context: APIRequestContext; + backupSchedules: Resource$Projects$Instances$Databases$Backupschedules; databaseRoles: Resource$Projects$Instances$Databases$Databaseroles; operations: Resource$Projects$Instances$Databases$Operations; sessions: Resource$Projects$Instances$Databases$Sessions; constructor(context: APIRequestContext) { this.context = context; + this.backupSchedules = + new Resource$Projects$Instances$Databases$Backupschedules(this.context); this.databaseRoles = new Resource$Projects$Instances$Databases$Databaseroles(this.context); this.operations = new Resource$Projects$Instances$Databases$Operations( @@ -6751,7 +6875,7 @@ export namespace spanner_v1 { } /** - * ChangeQuorum is strictly restricted to databases that use dual region instance configurations. Initiates a background operation to change quorum a database from dual-region mode to single-region mode and vice versa. The returned long-running operation will have a name of the format `projects//instances//databases//operations/` and can be used to track execution of the ChangeQuorum. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database. + * `ChangeQuorum` is strictly restricted to databases that use dual-region instance configurations. Initiates a background operation to change the quorum of a database from dual-region mode to single-region mode or vice versa. The returned long-running operation has a name of the format `projects//instances//databases//operations/` and can be used to track execution of the `ChangeQuorum`. The metadata field type is ChangeQuorumMetadata. Authorization requires `spanner.databases.changequorum` permission on the resource database. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6840,7 +6964,7 @@ export namespace spanner_v1 { } /** - * Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. + * Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7908,7 +8032,7 @@ export namespace spanner_v1 { export interface Params$Resource$Projects$Instances$Databases$Changequorum extends StandardParameters { /** - * Required. Name of the database in which to apply the ChangeQuorum. Values are of the form `projects//instances//databases/`. + * Required. Name of the database in which to apply `ChangeQuorum`. Values are of the form `projects//instances//databases/`. */ name?: string; @@ -8061,6 +8185,828 @@ export namespace spanner_v1 { requestBody?: Schema$UpdateDatabaseDdlRequest; } + export class Resource$Projects$Instances$Databases$Backupschedules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new backup schedule. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupSchedules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a backup schedule. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets backup schedule for the input schedule name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all the backup schedules for the database. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/backupSchedules').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a backup schedule. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://spanner.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Create + extends StandardParameters { + /** + * Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`. + */ + backupScheduleId?: string; + /** + * Required. The name of the database that this backup schedule applies to. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupSchedule; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Delete + extends StandardParameters { + /** + * Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Get + extends StandardParameters { + /** + * Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`. + */ + name?: string; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Getiampolicy + extends StandardParameters { + /** + * REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$List + extends StandardParameters { + /** + * Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. + */ + pageSize?: number; + /** + * Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`. + */ + pageToken?: string; + /** + * Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/ + */ + parent?: string; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Patch + extends StandardParameters { + /** + * Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form `projects//instances//databases//backupSchedules/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. + */ + name?: string; + /** + * Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BackupSchedule; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Setiampolicy + extends StandardParameters { + /** + * REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Databases$Backupschedules$Testiampermissions + extends StandardParameters { + /** + * REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export class Resource$Projects$Instances$Databases$Databaseroles { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index eb99174933..6ecc42d98d 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -359,6 +359,10 @@ export namespace sqladmin_v1 { * Location of the backups. */ location?: string | null; + /** + * Output only. The maximum chargeable bytes for the backup. + */ + maxChargeableBytes?: string | null; /** * The URI of this resource. */ @@ -491,6 +495,10 @@ export namespace sqladmin_v1 { * SSL configuration. */ serverCaCert?: Schema$SslCert; + /** + * Specify what type of CA is used for the server certificate. + */ + serverCaMode?: string | null; } /** * Represents a SQL database on the Cloud SQL instance. @@ -675,6 +683,10 @@ export namespace sqladmin_v1 { * Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */ rootPassword?: string | null; + /** + * Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * This status indicates whether the instance satisfies PZS. The status is reserved for future use. */ @@ -712,6 +724,10 @@ export namespace sqladmin_v1 { * If the instance state is SUSPENDED, the reason for the suspension. */ suspensionReason?: string[] | null; + /** + * Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. + */ + switchTransactionLogsToCloudStorageEnabled?: boolean | null; /** * Output only. All database versions that are available for upgrade. */ @@ -916,6 +932,7 @@ export namespace sqladmin_v1 { sqlExportOptions?: { mysqlExportOptions?: {masterData?: number}; parallel?: boolean; + postgresExportOptions?: {clean?: boolean; ifExists?: boolean}; schemaOnly?: boolean; tables?: string[]; threads?: number; @@ -1105,7 +1122,11 @@ export namespace sqladmin_v1 { /** * Optional. Options for importing data from SQL statements. */ - sqlImportOptions?: {parallel?: boolean; threads?: number} | null; + sqlImportOptions?: { + parallel?: boolean; + postgresImportOptions?: {clean?: boolean; ifExists?: boolean}; + threads?: number; + } | null; /** * Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file. */ @@ -1319,6 +1340,10 @@ export namespace sqladmin_v1 { * Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. */ requireSsl?: boolean | null; + /** + * Specify what type of CA is used for the server certificate. + */ + serverCaMode?: string | null; /** * Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. */ @@ -3905,7 +3930,7 @@ export namespace sqladmin_v1 { } /** - * Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. + * Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5581,7 +5606,7 @@ export namespace sqladmin_v1 { } /** - * Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. + * Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 4bec6e3de5..8d1e3dca39 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -359,6 +359,10 @@ export namespace sqladmin_v1beta4 { * Location of the backups. */ location?: string | null; + /** + * Output only. The maximum chargeable bytes for the backup. + */ + maxChargeableBytes?: string | null; /** * The URI of this resource. */ @@ -491,6 +495,10 @@ export namespace sqladmin_v1beta4 { * SSL configuration. */ serverCaCert?: Schema$SslCert; + /** + * Specify what type of CA is used for the server certificate. + */ + serverCaMode?: string | null; } /** * Represents a SQL database on the Cloud SQL instance. @@ -675,6 +683,10 @@ export namespace sqladmin_v1beta4 { * Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. */ rootPassword?: string | null; + /** + * Output only. This status indicates whether the instance satisfies PZI. The status is reserved for future use. + */ + satisfiesPzi?: boolean | null; /** * This status indicates whether the instance satisfies PZS. The status is reserved for future use. */ @@ -715,6 +727,10 @@ export namespace sqladmin_v1beta4 { * If the instance state is SUSPENDED, the reason for the suspension. */ suspensionReason?: string[] | null; + /** + * Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. + */ + switchTransactionLogsToCloudStorageEnabled?: boolean | null; /** * Output only. All database versions that are available for upgrade. */ @@ -919,6 +935,7 @@ export namespace sqladmin_v1beta4 { sqlExportOptions?: { mysqlExportOptions?: {masterData?: number}; parallel?: boolean; + postgresExportOptions?: {clean?: boolean; ifExists?: boolean}; schemaOnly?: boolean; tables?: string[]; threads?: number; @@ -1108,7 +1125,11 @@ export namespace sqladmin_v1beta4 { /** * Optional. Options for importing data from SQL statements. */ - sqlImportOptions?: {parallel?: boolean; threads?: number} | null; + sqlImportOptions?: { + parallel?: boolean; + postgresImportOptions?: {clean?: boolean; ifExists?: boolean}; + threads?: number; + } | null; /** * Path to the import file in Cloud Storage, in the form `gs://bucketName/fileName`. Compressed gzip files (.gz) are supported when `fileType` is `SQL`. The instance must have write permissions to the bucket and read access to the file. */ @@ -1322,6 +1343,10 @@ export namespace sqladmin_v1beta4 { * Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. */ requireSsl?: boolean | null; + /** + * Specify what type of CA is used for the server certificate. + */ + serverCaMode?: string | null; /** * Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. */ @@ -3906,7 +3931,7 @@ export namespace sqladmin_v1beta4 { } /** - * Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. + * Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5587,7 +5612,7 @@ export namespace sqladmin_v1beta4 { } /** - * Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. + * Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index fb1042e7c7..ef5d34db78 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -259,6 +259,10 @@ export namespace storage_v1 { * HTTP 1.1 Entity tag for the bucket. */ etag?: string | null; + /** + * The generation of this bucket. + */ + generation?: string | null; /** * The bucket's hierarchical namespace configuration. */ @@ -275,6 +279,17 @@ export namespace storage_v1 { * The ID of the bucket. For buckets, the id and name properties are the same. */ id?: string | null; + /** + * The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'. + */ + ipFilter?: { + mode?: string; + publicNetworkSource?: {allowedIpCidrRanges?: string[]}; + vpcNetworkSources?: Array<{ + allowedIpCidrRanges?: string[]; + network?: string; + }>; + } | null; /** * The kind of item this is. For buckets, this is always storage#bucket. */ @@ -284,7 +299,7 @@ export namespace storage_v1 { */ labels?: {[key: string]: string} | null; /** - * The bucket's lifecycle configuration. See lifecycle management for more information. + * The bucket's lifecycle configuration. See [Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle) for more information. */ lifecycle?: { rule?: Array<{ @@ -306,7 +321,7 @@ export namespace storage_v1 { }>; } | null; /** - * The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. + * The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [Developer's Guide](https://cloud.google.com/storage/docs/locations) for the authoritative list. */ location?: string | null; /** @@ -349,6 +364,10 @@ export namespace storage_v1 { * The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. */ rpo?: string | null; + /** + * Reserved for future use. + */ + satisfiesPZI?: boolean | null; /** * Reserved for future use. */ @@ -365,7 +384,7 @@ export namespace storage_v1 { retentionDurationSeconds?: string; } | null; /** - * The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. + * The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes). */ storageClass?: string | null; /** @@ -381,7 +400,7 @@ export namespace storage_v1 { */ versioning?: {enabled?: boolean} | null; /** - * The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. + * The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the [Static Website Examples](https://cloud.google.com/storage/docs/static-website) for more information. */ website?: {mainPageSuffix?: string; notFoundPage?: string} | null; } @@ -965,7 +984,7 @@ export namespace storage_v1 { */ contentType?: string | null; /** - * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. + * CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation). */ crc32c?: string | null; /** @@ -1008,7 +1027,7 @@ export namespace storage_v1 { */ kmsKeyName?: string | null; /** - * MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. + * MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation). */ md5Hash?: string | null; /** @@ -2663,7 +2682,7 @@ export namespace storage_v1 { } /** - * Permanently deletes an empty bucket. + * Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3357,6 +3376,91 @@ export namespace storage_v1 { } } + /** + * Restores a soft-deleted bucket. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + restore( + params: Params$Resource$Buckets$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Buckets$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Buckets$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Buckets$Restore, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Buckets$Restore, + callback: BodyResponseCallback + ): void; + restore(callback: BodyResponseCallback): void; + restore( + paramsOrCallback?: + | Params$Resource$Buckets$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: BodyResponseCallback | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Buckets$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Buckets$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/storage/v1/b/{bucket}/restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['bucket', 'generation'], + pathParams: ['bucket'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Updates an IAM policy for the specified bucket. * @@ -3650,6 +3754,10 @@ export namespace storage_v1 { * Name of a bucket. */ bucket?: string; + /** + * If present, specifies the generation of the bucket. This is required if softDeleted is true. + */ + generation?: string; /** * Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value. */ @@ -3662,6 +3770,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to noAcl. */ projection?: string; + /** + * If true, return the soft-deleted version of this bucket. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). + */ + softDeleted?: boolean; /** * The project to be billed for this request. Required for Requester Pays buckets. */ @@ -3745,6 +3857,10 @@ export namespace storage_v1 { * Set of properties to return. Defaults to noAcl. */ projection?: string; + /** + * If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). + */ + softDeleted?: boolean; /** * The project to be billed for this request. */ @@ -3800,6 +3916,20 @@ export namespace storage_v1 { */ requestBody?: Schema$Bucket; } + export interface Params$Resource$Buckets$Restore extends StandardParameters { + /** + * Name of a bucket. + */ + bucket?: string; + /** + * Generation of a bucket. + */ + generation?: string; + /** + * The project to be billed for this request. Required for Requester Pays buckets. + */ + userProject?: string; + } export interface Params$Resource$Buckets$Setiampolicy extends StandardParameters { /** @@ -8572,7 +8702,7 @@ export namespace storage_v1 { */ projection?: string; /** - * If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete. + * If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */ softDeleted?: boolean; /** @@ -8707,7 +8837,7 @@ export namespace storage_v1 { */ projection?: string; /** - * If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete. + * If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete). */ softDeleted?: boolean; /** @@ -8719,7 +8849,7 @@ export namespace storage_v1 { */ userProject?: string; /** - * If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. + * If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning). */ versions?: boolean; } @@ -8804,7 +8934,7 @@ export namespace storage_v1 { */ ifMetagenerationNotMatch?: string; /** - * Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts. + * Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). */ object?: string; /** @@ -9039,7 +9169,7 @@ export namespace storage_v1 { */ userProject?: string; /** - * If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning. + * If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning). */ versions?: boolean; @@ -9734,7 +9864,7 @@ export namespace storage_v1 { } /** - * Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states. + * Updates the state of an HMAC key. See the [HMAC Key resource descriptor](https://cloud.google.com/storage/docs/json_api/v1/projects/hmacKeys/update#request-body) for valid states. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/sts/v1.ts b/src/apis/sts/v1.ts index 89344283e5..15a886a274 100644 --- a/src/apis/sts/v1.ts +++ b/src/apis/sts/v1.ts @@ -243,6 +243,10 @@ export namespace sts_v1 { * Response message for ExchangeToken. */ export interface Schema$GoogleIdentityStsV1ExchangeTokenResponse { + /** + * The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`. + */ + access_boundary_session_key?: string | null; /** * An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time. */ diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 7998521657..798aa2d146 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -2687,7 +2687,7 @@ export namespace tagmanager_v2 { } /** - * Looks up a Container by destination ID. + * Looks up a Container by destination ID or tag ID. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3104,9 +3104,13 @@ export namespace tagmanager_v2 { export interface Params$Resource$Accounts$Containers$Lookup extends StandardParameters { /** - * Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id\}. + * Destination ID linked to a GTM Container, e.g. AW-123456789. Example: accounts/containers:lookup?destination_id={destination_id\}. Only one of destination_id or tag_id should be set. */ destinationId?: string; + /** + * Tag ID for a GTM Container, e.g. GTM-123456789. Example: accounts/containers:lookup?tag_id={tag_id\}. Only one of destination_id or tag_id should be set. + */ + tagId?: string; } export interface Params$Resource$Accounts$Containers$Move_tag_id extends StandardParameters { diff --git a/src/apis/transcoder/v1.ts b/src/apis/transcoder/v1.ts index 4245d6f739..dbde1eab17 100644 --- a/src/apis/transcoder/v1.ts +++ b/src/apis/transcoder/v1.ts @@ -990,7 +990,7 @@ export namespace transcoder_v1 { */ export interface Schema$Output { /** - * URI for the output file(s). For example, `gs://my-bucket/outputs/`. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). + * URI for the output file(s). For example, `gs://my-bucket/outputs/`. Must be a directory and not a top-level bucket. If empty, the value is populated from Job.output_uri. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). */ uri?: string | null; } diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts index b3afeb4cc5..062c95ca35 100644 --- a/src/apis/translate/v3.ts +++ b/src/apis/translate/v3.ts @@ -212,18 +212,30 @@ export namespace translate_v3 { */ export interface Schema$AdaptiveMtTranslateRequest { /** - * Required. The content of the input in string format. For now only one sentence per request is supported. + * Required. The content of the input in string format. */ content?: string[] | null; /** * Required. The resource name for the dataset to use for adaptive MT. `projects/{project\}/locations/{location-id\}/adaptiveMtDatasets/{dataset\}` */ dataset?: string | null; + /** + * Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. + */ + glossaryConfig?: Schema$TranslateTextGlossaryConfig; + /** + * Configuration for caller provided reference sentences. + */ + referenceSentenceConfig?: Schema$ReferenceSentenceConfig; } /** * An AdaptiveMtTranslate response. */ export interface Schema$AdaptiveMtTranslateResponse { + /** + * Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply. + */ + glossaryTranslations?: Schema$AdaptiveMtTranslation[]; /** * Output only. The translation's language code. */ @@ -628,7 +640,7 @@ export namespace translate_v3 { */ description?: string | null; /** - * Required. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" + * Identifier. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" */ name?: string | null; /** @@ -997,6 +1009,45 @@ export namespace translate_v3 { */ gcsDestination?: Schema$GcsDestination; } + /** + * Message of caller-provided reference configuration. + */ + export interface Schema$ReferenceSentenceConfig { + /** + * Reference sentences pair lists. Each list will be used as the references to translate the sentence under "content" field at the corresponding index. Length of the list is required to be equal to the length of "content" field. + */ + referenceSentencePairLists?: Schema$ReferenceSentencePairList[]; + /** + * Source language code. + */ + sourceLanguageCode?: string | null; + /** + * Target language code. + */ + targetLanguageCode?: string | null; + } + /** + * A pair of sentences used as reference in source and target languages. + */ + export interface Schema$ReferenceSentencePair { + /** + * Source sentence in the sentence pair. + */ + sourceSentence?: string | null; + /** + * Target sentence in the sentence pair. + */ + targetSentence?: string | null; + } + /** + * A list of reference sentence pairs. + */ + export interface Schema$ReferenceSentencePairList { + /** + * Reference sentence pairs. + */ + referenceSentencePairs?: Schema$ReferenceSentencePair[]; + } /** * A single romanization response. */ @@ -1183,7 +1234,7 @@ export namespace translate_v3 { */ mimeType?: string | null; /** - * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id\}/locations/{location-id\}/models/{model-id\}` - General (built-in) models: `projects/{project-number-or-id\}/locations/{location-id\}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id\}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used + * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id\}/locations/{location-id\}/models/{model-id\}` - General (built-in) models: `projects/{project-number-or-id\}/locations/{location-id\}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id\}/locations/{location-id\}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id\}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used */ model?: string | null; /** @@ -5580,7 +5631,7 @@ export namespace translate_v3 { export interface Params$Resource$Projects$Locations$Glossaries$Glossaryentries$Patch extends StandardParameters { /** - * Required. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" + * Identifier. The resource name of the entry. Format: "projects/x/locations/x/glossaries/x/glossaryEntries/x" */ name?: string; diff --git a/src/apis/vault/v1.ts b/src/apis/vault/v1.ts index 03505551ac..4d37a16741 100644 --- a/src/apis/vault/v1.ts +++ b/src/apis/vault/v1.ts @@ -857,6 +857,10 @@ export namespace vault_v1 { * Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have. */ matterPermissions?: Schema$MatterPermission[]; + /** + * Optional. The requested data region for the matter. + */ + matterRegion?: string | null; /** * The name of the matter. */ diff --git a/src/apis/vmmigration/v1.ts b/src/apis/vmmigration/v1.ts index 7613ece9c1..62c5138f10 100644 --- a/src/apis/vmmigration/v1.ts +++ b/src/apis/vmmigration/v1.ts @@ -549,6 +549,10 @@ export namespace vmmigration_v1 { * Request message for 'CancelCutoverJob' request. */ export interface Schema$CancelCutoverJobRequest {} + /** + * Request message for 'CancelDiskMigrationJob' request. + */ + export interface Schema$CancelDiskMigrationJobRequest {} /** * Request message for 'CancelImageImportJob' request. */ @@ -1081,7 +1085,7 @@ export namespace vmmigration_v1 { */ export interface Schema$DiskImageTargetDetails { /** - * Optional. Additional licenses to assign to the image. + * Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME */ additionalLicenses?: string[] | null; /** @@ -1290,6 +1294,10 @@ export namespace vmmigration_v1 { * Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. */ encryption?: Schema$Encryption; + /** + * Immutable. Target details for importing a machine image, will be used by ImageImportJob. + */ + machineImageTargetDefaults?: Schema$MachineImageTargetDetails; /** * Output only. The resource path of the ImageImport. */ @@ -1327,6 +1335,10 @@ export namespace vmmigration_v1 { * Output only. Provides details on the error that led to the image import state in case of an error. */ errors?: Schema$Status[]; + /** + * Output only. Target details used to import a machine image. + */ + machineImageTargetDetails?: Schema$MachineImageTargetDetails; /** * Output only. The resource path of the ImageImportJob. */ @@ -1666,6 +1678,76 @@ export namespace vmmigration_v1 { */ name?: string | null; } + /** + * Parameters overriding decisions based on the source machine image configurations. + */ + export interface Schema$MachineImageParametersOverrides { + /** + * Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + */ + machineType?: string | null; + } + /** + * The target details of the machine image resource that will be created by the image import job. + */ + export interface Schema$MachineImageTargetDetails { + /** + * Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + */ + additionalLicenses?: string[] | null; + /** + * Optional. An optional description of the machine image. + */ + description?: string | null; + /** + * Immutable. The encryption to apply to the machine image. + */ + encryption?: Schema$Encryption; + /** + * Optional. The labels to apply to the instance created by the machine image. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The name of the machine image to be created. + */ + machineImageName?: string | null; + /** + * Optional. Parameters overriding decisions based on the source machine image configurations. + */ + machineImageParametersOverrides?: Schema$MachineImageParametersOverrides; + /** + * Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + */ + networkInterfaces?: Schema$NetworkInterface[]; + /** + * Optional. Use to set the parameters relevant for the OS adaptation process. + */ + osAdaptationParameters?: Schema$ImageImportOsAdaptationParameters; + /** + * Optional. The service account to assign to the instance created by the machine image. + */ + serviceAccount?: Schema$ServiceAccount; + /** + * Optional. Shielded instance configuration. + */ + shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; + /** + * Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + */ + singleRegionStorage?: boolean | null; + /** + * Optional. Use to skip OS adaptation process. + */ + skipOsAdaptation?: Schema$SkipOsAdaptation; + /** + * Optional. The tags to apply to the instance created by the machine image. + */ + tags?: string[] | null; + /** + * Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + */ + targetProject?: string | null; + } /** * MigratingVm describes the VM that will be migrated from a Source environment and its replication state. */ @@ -1843,7 +1925,11 @@ export namespace vmmigration_v1 { */ network?: string | null; /** - * The subnetwork to connect the NIC to. + * Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + */ + networkTier?: string | null; + /** + * Optional. The subnetwork to connect the NIC to. */ subnetwork?: string | null; } @@ -1985,7 +2071,7 @@ export namespace vmmigration_v1 { */ sourceDiskNumber?: number | null; /** - * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM. + * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. */ vmAttachmentDetails?: Schema$VmAttachmentDetails; } @@ -2085,6 +2171,10 @@ export namespace vmmigration_v1 { * Request message for 'ResumeMigration' request. */ export interface Schema$ResumeMigrationRequest {} + /** + * Request message for 'RunDiskMigrationJobRequest' request. + */ + export interface Schema$RunDiskMigrationJobRequest {} /** * A policy for scheduling replications. */ @@ -2115,10 +2205,44 @@ export namespace vmmigration_v1 { */ values?: string[] | null; } + /** + * Service account to assign to the instance created by the machine image. + */ + export interface Schema$ServiceAccount { + /** + * Required. The email address of the service account. + */ + email?: string | null; + /** + * Optional. The list of scopes to be made available for this service account. + */ + scopes?: string[] | null; + } + /** + * Shielded instance configuration. + */ + export interface Schema$ShieldedInstanceConfig { + /** + * Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + */ + enableIntegrityMonitoring?: boolean | null; + /** + * Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + */ + enableVtpm?: boolean | null; + /** + * Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + */ + secureBoot?: string | null; + } /** * ShuttingDownSourceVMStep contains specific step details. */ export interface Schema$ShuttingDownSourceVMStep {} + /** + * Mentions that the machine image import is not using OS adaptation process. + */ + export interface Schema$SkipOsAdaptation {} /** * Source message describes a specific vm migration Source resource. It contains the source environment information. */ @@ -4611,6 +4735,7 @@ export namespace vmmigration_v1 { export class Resource$Projects$Locations$Sources { context: APIRequestContext; datacenterConnectors: Resource$Projects$Locations$Sources$Datacenterconnectors; + diskMigrationJobs: Resource$Projects$Locations$Sources$Diskmigrationjobs; migratingVms: Resource$Projects$Locations$Sources$Migratingvms; utilizationReports: Resource$Projects$Locations$Sources$Utilizationreports; constructor(context: APIRequestContext) { @@ -4619,6 +4744,8 @@ export namespace vmmigration_v1 { new Resource$Projects$Locations$Sources$Datacenterconnectors( this.context ); + this.diskMigrationJobs = + new Resource$Projects$Locations$Sources$Diskmigrationjobs(this.context); this.migratingVms = new Resource$Projects$Locations$Sources$Migratingvms( this.context ); @@ -5791,6 +5918,210 @@ export namespace vmmigration_v1 { requestBody?: Schema$UpgradeApplianceRequest; } + export class Resource$Projects$Locations$Sources$Diskmigrationjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Runs the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions + ): GaxiosPromise; + run( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelDiskMigrationJobRequest; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunDiskMigrationJobRequest; + } + export class Resource$Projects$Locations$Sources$Migratingvms { context: APIRequestContext; cloneJobs: Resource$Projects$Locations$Sources$Migratingvms$Clonejobs; diff --git a/src/apis/vmmigration/v1alpha1.ts b/src/apis/vmmigration/v1alpha1.ts index 9caa2714c1..b7342a8efd 100644 --- a/src/apis/vmmigration/v1alpha1.ts +++ b/src/apis/vmmigration/v1alpha1.ts @@ -549,6 +549,10 @@ export namespace vmmigration_v1alpha1 { * Request message for 'CancelCutoverJob' request. */ export interface Schema$CancelCutoverJobRequest {} + /** + * Request message for 'CancelDiskMigrationJob' request. + */ + export interface Schema$CancelDiskMigrationJobRequest {} /** * Request message for 'CancelImageImportJob' request. */ @@ -1102,7 +1106,7 @@ export namespace vmmigration_v1alpha1 { */ export interface Schema$DiskImageTargetDetails { /** - * Optional. Additional licenses to assign to the image. + * Optional. Additional licenses to assign to the image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME */ additionalLicenses?: string[] | null; /** @@ -1311,6 +1315,10 @@ export namespace vmmigration_v1alpha1 { * Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. */ encryption?: Schema$Encryption; + /** + * Immutable. Target details for importing a machine image, will be used by ImageImportJob. + */ + machineImageTargetDefaults?: Schema$MachineImageTargetDetails; /** * Output only. The resource path of the ImageImport. */ @@ -1348,6 +1356,10 @@ export namespace vmmigration_v1alpha1 { * Output only. Provides details on the error that led to the image import state in case of an error. */ errors?: Schema$Status[]; + /** + * Output only. Target details used to import a machine image. + */ + machineImageTargetDetails?: Schema$MachineImageTargetDetails; /** * Output only. The resource path of the ImageImportJob. */ @@ -1687,6 +1699,76 @@ export namespace vmmigration_v1alpha1 { */ name?: string | null; } + /** + * Parameters overriding decisions based on the source machine image configurations. + */ + export interface Schema$MachineImageParametersOverrides { + /** + * Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + */ + machineType?: string | null; + } + /** + * The target details of the machine image resource that will be created by the image import job. + */ + export interface Schema$MachineImageTargetDetails { + /** + * Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + */ + additionalLicenses?: string[] | null; + /** + * Optional. An optional description of the machine image. + */ + description?: string | null; + /** + * Immutable. The encryption to apply to the machine image. + */ + encryption?: Schema$Encryption; + /** + * Optional. The labels to apply to the instance created by the machine image. + */ + labels?: {[key: string]: string} | null; + /** + * Required. The name of the machine image to be created. + */ + machineImageName?: string | null; + /** + * Optional. Parameters overriding decisions based on the source machine image configurations. + */ + machineImageParametersOverrides?: Schema$MachineImageParametersOverrides; + /** + * Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + */ + networkInterfaces?: Schema$NetworkInterface[]; + /** + * Optional. Use to set the parameters relevant for the OS adaptation process. + */ + osAdaptationParameters?: Schema$ImageImportOsAdaptationParameters; + /** + * Optional. The service account to assign to the instance created by the machine image. + */ + serviceAccount?: Schema$ServiceAccount; + /** + * Optional. Shielded instance configuration. + */ + shieldedInstanceConfig?: Schema$ShieldedInstanceConfig; + /** + * Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + */ + singleRegionStorage?: boolean | null; + /** + * Optional. Use to skip OS adaptation process. + */ + skipOsAdaptation?: Schema$SkipOsAdaptation; + /** + * Optional. The tags to apply to the instance created by the machine image. + */ + tags?: string[] | null; + /** + * Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + */ + targetProject?: string | null; + } /** * MigratingVm describes the VM that will be migrated from a Source environment and its replication state. */ @@ -1872,7 +1954,11 @@ export namespace vmmigration_v1alpha1 { */ network?: string | null; /** - * The subnetwork to connect the NIC to. + * Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM. + */ + networkTier?: string | null; + /** + * Optional. The subnetwork to connect the NIC to. */ subnetwork?: string | null; } @@ -2014,7 +2100,7 @@ export namespace vmmigration_v1alpha1 { */ sourceDiskNumber?: number | null; /** - * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attacked to a target VM. + * Optional. Details for attachment of the disk to a VM. Used when the disk is set to be attached to a target VM. */ vmAttachmentDetails?: Schema$VmAttachmentDetails; } @@ -2118,6 +2204,10 @@ export namespace vmmigration_v1alpha1 { * Request message for 'ResumeMigration' request. */ export interface Schema$ResumeMigrationRequest {} + /** + * Request message for 'RunDiskMigrationJobRequest' request. + */ + export interface Schema$RunDiskMigrationJobRequest {} /** * A policy for scheduling replications. */ @@ -2148,10 +2238,44 @@ export namespace vmmigration_v1alpha1 { */ values?: string[] | null; } + /** + * Service account to assign to the instance created by the machine image. + */ + export interface Schema$ServiceAccount { + /** + * Required. The email address of the service account. + */ + email?: string | null; + /** + * Optional. The list of scopes to be made available for this service account. + */ + scopes?: string[] | null; + } + /** + * Shielded instance configuration. + */ + export interface Schema$ShieldedInstanceConfig { + /** + * Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + */ + enableIntegrityMonitoring?: boolean | null; + /** + * Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + */ + enableVtpm?: boolean | null; + /** + * Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + */ + secureBoot?: string | null; + } /** * ShuttingDownSourceVMStep contains specific step details. */ export interface Schema$ShuttingDownSourceVMStep {} + /** + * Mentions that the machine image import is not using OS adaptation process. + */ + export interface Schema$SkipOsAdaptation {} /** * Source message describes a specific vm migration Source resource. It contains the source environment information. */ @@ -4783,6 +4907,7 @@ export namespace vmmigration_v1alpha1 { export class Resource$Projects$Locations$Sources { context: APIRequestContext; datacenterConnectors: Resource$Projects$Locations$Sources$Datacenterconnectors; + diskMigrationJobs: Resource$Projects$Locations$Sources$Diskmigrationjobs; migratingVms: Resource$Projects$Locations$Sources$Migratingvms; utilizationReports: Resource$Projects$Locations$Sources$Utilizationreports; constructor(context: APIRequestContext) { @@ -4791,6 +4916,8 @@ export namespace vmmigration_v1alpha1 { new Resource$Projects$Locations$Sources$Datacenterconnectors( this.context ); + this.diskMigrationJobs = + new Resource$Projects$Locations$Sources$Diskmigrationjobs(this.context); this.migratingVms = new Resource$Projects$Locations$Sources$Migratingvms( this.context ); @@ -5963,6 +6090,216 @@ export namespace vmmigration_v1alpha1 { requestBody?: Schema$UpgradeApplianceRequest; } + export class Resource$Projects$Locations$Sources$Diskmigrationjobs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Cancels the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Runs the disk migration job. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions + ): GaxiosPromise; + run( + params?: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run, + callback: BodyResponseCallback + ): void; + run(callback: BodyResponseCallback): void; + run( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmmigration.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}:run').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Cancel + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelDiskMigrationJobRequest; + } + export interface Params$Resource$Projects$Locations$Sources$Diskmigrationjobs$Run + extends StandardParameters { + /** + * Required. The name of the DiskMigrationJob. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunDiskMigrationJobRequest; + } + export class Resource$Projects$Locations$Sources$Migratingvms { context: APIRequestContext; cloneJobs: Resource$Projects$Locations$Sources$Migratingvms$Clonejobs; diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts index 8d4a4f6d8d..faf3ffb915 100644 --- a/src/apis/vmwareengine/v1.ts +++ b/src/apis/vmwareengine/v1.ts @@ -150,6 +150,56 @@ export namespace vmwareengine_v1 { */ logType?: string | null; } + /** + * Autoscaling policy describes the behavior of the autoscaling with respect to the resource utilization. The scale-out operation is initiated if the utilization exceeds ANY of the respective thresholds. The scale-in operation is initiated if the utilization is below ALL of the respective thresholds. + */ + export interface Schema$AutoscalingPolicy { + /** + * Optional. Utilization thresholds pertaining to amount of consumed memory. + */ + consumedMemoryThresholds?: Schema$Thresholds; + /** + * Optional. Utilization thresholds pertaining to CPU utilization. + */ + cpuThresholds?: Schema$Thresholds; + /** + * Optional. Utilization thresholds pertaining to amount of granted memory. + */ + grantedMemoryThresholds?: Schema$Thresholds; + /** + * Required. The canonical identifier of the node type to add or remove. Corresponds to the `NodeType`. + */ + nodeTypeId?: string | null; + /** + * Required. Number of nodes to add to a cluster during a scale-out operation. Must be divisible by 2 for stretched clusters. During a scale-in operation only one node (or 2 for stretched clusters) are removed in a single iteration. + */ + scaleOutSize?: number | null; + /** + * Optional. Utilization thresholds pertaining to amount of consumed storage. + */ + storageThresholds?: Schema$Thresholds; + } + /** + * Autoscaling settings define the rules used by VMware Engine to automatically scale-out and scale-in the clusters in a private cloud. + */ + export interface Schema$AutoscalingSettings { + /** + * Required. The map with autoscaling policies applied to the cluster. The key is the identifier of the policy. It must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) Currently there map must contain only one element that describes the autoscaling policy for compute nodes. + */ + autoscalingPolicies?: {[key: string]: Schema$AutoscalingPolicy} | null; + /** + * Optional. The minimum duration between consecutive autoscale operations. It starts once addition or removal of nodes is fully completed. Defaults to 30 minutes if not specified. Cool down period must be in whole minutes (for example, 30, 31, 50, 180 minutes). + */ + coolDownPeriod?: string | null; + /** + * Optional. Maximum number of nodes of any type in a cluster. If not specified the default limits apply. + */ + maxClusterNodeCount?: number | null; + /** + * Optional. Minimum number of nodes of any type in a cluster. If not specified the default limits apply. + */ + minClusterNodeCount?: number | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -171,6 +221,10 @@ export namespace vmwareengine_v1 { * A cluster in a private cloud. */ export interface Schema$Cluster { + /** + * Optional. Configuration of the autoscaling applied to this cluster. + */ + autoscalingSettings?: Schema$AutoscalingSettings; /** * Output only. Creation time of this resource. */ @@ -1524,6 +1578,19 @@ export namespace vmwareengine_v1 { */ permissions?: string[] | null; } + /** + * Thresholds define the utilization of resources triggering scale-out and scale-in operations. + */ + export interface Schema$Thresholds { + /** + * Required. The utilization triggering the scale-in operation in percent. + */ + scaleIn?: number | null; + /** + * Required. The utilization triggering the scale-out operation in percent. + */ + scaleOut?: number | null; + } /** * Request message for VmwareEngine.UndeletePrivateCloud */ diff --git a/src/apis/walletobjects/v1.ts b/src/apis/walletobjects/v1.ts index be9f6a99f1..9c44d497f5 100644 --- a/src/apis/walletobjects/v1.ts +++ b/src/apis/walletobjects/v1.ts @@ -1003,6 +1003,10 @@ export namespace walletobjects_v1 { * Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketObject"`. */ kind?: string | null; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this event ticket object. If a user had saved this event ticket, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * A list of offer objects linked to this event ticket. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. */ @@ -1031,6 +1035,10 @@ export namespace walletobjects_v1 { * The rotating barcode type and value. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * Seating details for this ticket. */ @@ -1248,15 +1256,15 @@ export namespace walletobjects_v1 { */ linksModuleData?: Schema$LinksModuleData; /** - * The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + * The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. */ localBoardingDateTime?: string | null; /** - * The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + * The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. */ localEstimatedOrActualArrivalDateTime?: string | null; /** - * The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + * The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. */ localEstimatedOrActualDepartureDateTime?: string | null; /** @@ -1268,7 +1276,7 @@ export namespace walletobjects_v1 { */ localizedIssuerName?: Schema$LocalizedString; /** - * The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + * The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. */ localScheduledArrivalDateTime?: string | null; /** @@ -1427,6 +1435,10 @@ export namespace walletobjects_v1 { * Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`. */ kind?: string | null; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this flight object. If a user had saved this boarding pass, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * Links module data. If links module data is also defined on the class, both will be displayed. */ @@ -1455,6 +1467,10 @@ export namespace walletobjects_v1 { * The rotating barcode type and value. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * An image for the security program that applies to the passenger. */ @@ -1641,6 +1657,10 @@ export namespace walletobjects_v1 { * Image module data. Only one of the image from class and one from object level will be rendered when both set. */ imageModulesData?: Schema$ImageModuleData[]; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this generic object. If a user had saved this generic card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * Links module data. If `linksModuleData` is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from class and 10 from object. */ @@ -1649,6 +1669,10 @@ export namespace walletobjects_v1 { * The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter of `cardTitle` would be shown as logo. */ logo?: Schema$Image; + /** + * An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + */ + messages?: Schema$Message[]; /** * The notification settings that are enabled for this object. */ @@ -1661,6 +1685,10 @@ export namespace walletobjects_v1 { * The rotating barcode settings/details. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. */ @@ -1947,6 +1975,10 @@ export namespace walletobjects_v1 { * Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardObject"`. */ kind?: string | null; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this giftcard object. If a user had saved this gift card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * Links module data. If links module data is also defined on the class, both will be displayed. */ @@ -1971,6 +2003,10 @@ export namespace walletobjects_v1 { * The rotating barcode type and value. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. */ @@ -2474,6 +2510,10 @@ export namespace walletobjects_v1 { * Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyObject"`. */ kind?: string | null; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this loyalty object. If a user had saved this loyalty card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * A list of offer objects linked to this loyalty card. The offer objects must already exist. Offer object IDs should follow the format issuer ID. identifier where the former is issued by Google and latter is chosen by you. */ @@ -2502,6 +2542,10 @@ export namespace walletobjects_v1 { * The rotating barcode type and value. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. */ @@ -3073,6 +3117,10 @@ export namespace walletobjects_v1 { * Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerObject"`. */ kind?: string | null; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this offer object. If a user had saved this offer, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID.identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * Links module data. If links module data is also defined on the class, both will be displayed. */ @@ -3093,6 +3141,10 @@ export namespace walletobjects_v1 { * The rotating barcode type and value. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. */ @@ -3355,6 +3407,15 @@ export namespace walletobjects_v1 { */ values?: string[] | null; } + /** + * Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. + */ + export interface Schema$SaveRestrictions { + /** + * Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + */ + restrictToEmailSha256?: string | null; + } export interface Schema$SecurityAnimation { /** * Type of animation. @@ -3863,6 +3924,10 @@ export namespace walletobjects_v1 { * Deprecated. Use textModulesData instead. */ infoModuleData?: Schema$InfoModuleData; + /** + * linked_object_ids are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this transit object. If a user had saved this transit card, then these linked_object_ids would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linked_object_ids are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format issuer ID. identifier where the former is issued by Google and the latter is chosen by you. + */ + linkedObjectIds?: string[] | null; /** * Links module data. If links module data is also defined on the class, both will be displayed. */ @@ -3895,6 +3960,10 @@ export namespace walletobjects_v1 { * The rotating barcode type and value. */ rotatingBarcode?: Schema$RotatingBarcode; + /** + * Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + */ + saveRestrictions?: Schema$SaveRestrictions; /** * The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. */ diff --git a/src/apis/workflowexecutions/v1.ts b/src/apis/workflowexecutions/v1.ts index 40a8c31153..a4d7aabb90 100644 --- a/src/apis/workflowexecutions/v1.ts +++ b/src/apis/workflowexecutions/v1.ts @@ -207,6 +207,10 @@ export namespace workflowexecutions_v1 { * Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`. */ error?: Schema$Error; + /** + * Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. + */ + executionHistoryLevel?: string | null; /** * Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. */ diff --git a/src/apis/workflows/v1.ts b/src/apis/workflows/v1.ts index 3e52117792..49c285c585 100644 --- a/src/apis/workflows/v1.ts +++ b/src/apis/workflows/v1.ts @@ -290,7 +290,7 @@ export namespace workflows_v1 { message?: string | null; } /** - * Workflow program to be executed by Workflows. + * LINT.IfChange Workflow program to be executed by Workflows. */ export interface Schema$Workflow { /** diff --git a/src/apis/workloadmanager/v1.ts b/src/apis/workloadmanager/v1.ts index addad6a975..deb479ccaf 100644 --- a/src/apis/workloadmanager/v1.ts +++ b/src/apis/workloadmanager/v1.ts @@ -141,6 +141,10 @@ export namespace workloadmanager_v1 { * Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf. */ export interface Schema$AssetLocation { + /** + * Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata. + */ + ccfeRmsPath?: string | null; /** * Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation. */ @@ -340,7 +344,7 @@ export namespace workloadmanager_v1 { */ export interface Schema$ExternalDataSources { /** - * Required. The asset type of the external data source must be one of go/cai-asset-types + * Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule */ assetType?: string | null; /** @@ -400,6 +404,10 @@ export namespace workloadmanager_v1 { sqlserverValidation?: Schema$SqlserverValidation; } export interface Schema$IsolationExpectations { + /** + * Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic. + */ + requirementOverride?: Schema$RequirementOverride; ziOrgPolicy?: string | null; ziRegionPolicy?: string | null; ziRegionState?: string | null; @@ -630,6 +638,10 @@ export namespace workloadmanager_v1 { */ zones?: Schema$ZoneConfiguration[]; } + export interface Schema$RequirementOverride { + ziOverride?: string | null; + zsOverride?: string | null; + } /** * Message represent resource in execution result */ @@ -1083,6 +1095,13 @@ export namespace workloadmanager_v1 { timeoutSeconds?: number | null; } export interface Schema$SpannerLocation { + /** + * Set of backups used by the resource with name in the same format as what is available at http://table/spanner_automon.backup_metadata + */ + backupName?: string[] | null; + /** + * Set of databases used by the resource in format /span// + */ dbName?: string[] | null; } /** diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index 8559cdfca6..da74558266 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -227,11 +227,11 @@ export namespace workstations_v1 { kmsKeyServiceAccount?: string | null; } /** - * Configuration options for private workstation clusters. + * Configuration options for a custom domain. */ export interface Schema$DomainConfig { /** - * Immutable. Whether Workstations endpoint is private. + * Immutable. Domain used by Workstations for HTTP ingress. */ domain?: string | null; } @@ -303,7 +303,7 @@ export namespace workstations_v1 { */ disableSsh?: boolean | null; /** - * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. */ enableNestedVirtualization?: boolean | null; /** @@ -335,7 +335,7 @@ export namespace workstations_v1 { */ tags?: string[] | null; /** - * Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as https://cloud.google.com/resource-manager/docs/tags/tags-overview Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. + * Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. */ vmTags?: {[key: string]: string} | null; } @@ -673,10 +673,38 @@ export namespace workstations_v1 { */ version?: number | null; } + /** + * A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + */ + export interface Schema$PortRange { + /** + * Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. + */ + first?: number | null; + /** + * Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. + */ + last?: number | null; + } + /** + * Configuration options for private workstation clusters. + */ export interface Schema$PrivateClusterConfig { + /** + * Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + */ allowedProjects?: string[] | null; + /** + * Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + */ clusterHostname?: string | null; + /** + * Immutable. Whether Workstations endpoint is private. + */ enablePrivateEndpoint?: boolean | null; + /** + * Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + */ serviceAttachmentUri?: string | null; } /** @@ -908,6 +936,10 @@ export namespace workstations_v1 { * A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. */ export interface Schema$WorkstationConfig { + /** + * Optional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535. + */ + allowedPorts?: Schema$PortRange[]; /** * Optional. Client-specified annotations. */ @@ -941,7 +973,7 @@ export namespace workstations_v1 { */ displayName?: string | null; /** - * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" */ enableAuditAgent?: boolean | null; /** diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index abc12a1cdc..7ea46d3e2a 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -193,7 +193,7 @@ export namespace workstations_v1beta { */ bootDiskSizeGb?: number | null; /** - * Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + * Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. */ enableNestedVirtualization?: boolean | null; /** @@ -256,11 +256,11 @@ export namespace workstations_v1beta { kmsKeyServiceAccount?: string | null; } /** - * Configuration options for private workstation clusters. + * Configuration options for a custom domain. */ export interface Schema$DomainConfig { /** - * Immutable. Whether Workstations endpoint is private. + * Immutable. Domain used by Workstations for HTTP ingress. */ domain?: string | null; } @@ -336,7 +336,7 @@ export namespace workstations_v1beta { */ disableSsh?: boolean | null; /** - * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. */ enableNestedVirtualization?: boolean | null; /** @@ -368,7 +368,7 @@ export namespace workstations_v1beta { */ tags?: string[] | null; /** - * Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as https://cloud.google.com/resource-manager/docs/tags/tags-overview Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. + * Optional. Resource manager tags to be bound to this instance. Tag keys and values have the same definition as [resource manager tags](https://cloud.google.com/resource-manager/docs/tags/tags-overview). Keys must be in the format `tagKeys/{tag_key_id\}`, and values are in the format `tagValues/456`. */ vmTags?: {[key: string]: string} | null; } @@ -479,7 +479,7 @@ export namespace workstations_v1beta { gceInstance?: Schema$GceInstance; } /** - * Http options for the running workstations. + * HTTP options for the running workstations. */ export interface Schema$HttpOptions { /** @@ -678,22 +678,37 @@ export namespace workstations_v1beta { version?: number | null; } /** - * A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + * A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. */ export interface Schema$PortRange { /** - * Required. Starting port number for the current range of ports. + * Required. Starting port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. */ first?: number | null; /** - * Required. Ending port number for the current range of ports. + * Required. Ending port number for the current range of ports. Valid ports are 22, 80, and ports within the range 1024-65535. */ last?: number | null; } + /** + * Configuration options for private workstation clusters. + */ export interface Schema$PrivateClusterConfig { + /** + * Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + */ allowedProjects?: string[] | null; + /** + * Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + */ clusterHostname?: string | null; + /** + * Immutable. Whether Workstations endpoint is private. + */ enablePrivateEndpoint?: boolean | null; + /** + * Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + */ serviceAttachmentUri?: string | null; } /** @@ -795,6 +810,10 @@ export namespace workstations_v1beta { * Optional. Client-specified annotations. */ annotations?: {[key: string]: string} | null; + /** + * Output only. List of available boost configuration ids that this workstation can be boosted up to + */ + boostConfigs?: Schema$WorkstationBoostConfig[]; /** * Output only. Time when this workstation was created. */ @@ -836,7 +855,15 @@ export namespace workstations_v1beta { */ reconciling?: boolean | null; /** - * Optional. The source workstation from which this workstations persistent directories were cloned on creation. + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; + /** + * Optional. The source workstation from which this workstation's persistent directories were cloned on creation. */ sourceWorkstation?: string | null; /** @@ -856,6 +883,15 @@ export namespace workstations_v1beta { */ updateTime?: string | null; } + /** + * Boost config for this workstation. This object is populated from the parent workstation config. + */ + export interface Schema$WorkstationBoostConfig { + /** + * Output only. Boost config id. + */ + id?: string | null; + } /** * A workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to. */ @@ -916,6 +952,14 @@ export namespace workstations_v1beta { * Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. */ reconciling?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. */ @@ -934,7 +978,7 @@ export namespace workstations_v1beta { */ export interface Schema$WorkstationConfig { /** - * Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + * Optional. A list of PortRanges specifying single ports or ranges of ports that are externally accessible in the workstation. Allowed ports must be one of 22, 80, or within range 1024-65535. If not specified defaults to ports 22, 80, and ports 1024-65535. */ allowedPorts?: Schema$PortRange[]; /** @@ -970,7 +1014,7 @@ export namespace workstations_v1beta { */ displayName?: string | null; /** - * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + * Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" */ enableAuditAgent?: boolean | null; /** @@ -990,7 +1034,7 @@ export namespace workstations_v1beta { */ host?: Schema$Host; /** - * Optional. Http options that customize the behavior of the workstation service's http proxy. + * Optional. HTTP options that customize the behavior of the workstation service's HTTP proxy. */ httpOptions?: Schema$HttpOptions; /** @@ -1001,6 +1045,10 @@ export namespace workstations_v1beta { * Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. */ labels?: {[key: string]: string} | null; + /** + * Optional. Maximum number of workstations under this config a user can have `workstations.workstation.use` permission on. Only enforced on CreateWorkstation API calls on the user issuing the API request. Can be overridden by: - granting a user workstations.workstationConfigs.exemptMaxUsableWorkstationLimit permission, or - having a user with that permission create a workstation and granting another user `workstations.workstation.use` permission on that workstation. If not specified defaults to 0 which indicates unlimited. + */ + maxUsableWorkstations?: number | null; /** * Identifier. Full name of this workstation configuration. */ @@ -1025,6 +1073,14 @@ export namespace workstations_v1beta { * Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. */ runningTimeout?: string | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzi?: boolean | null; + /** + * Output only. Reserved for future use. + */ + satisfiesPzs?: boolean | null; /** * Output only. A system-assigned unique identifier for this workstation configuration. */ diff --git a/src/index.ts b/src/index.ts index 48dd806f8e..66531feb19 100644 --- a/src/index.ts +++ b/src/index.ts @@ -39,6 +39,8 @@ export {admob_v1beta} from './apis/admob/v1beta'; export {adsense_v1_4} from './apis/adsense/v1.4'; export {adsense_v2} from './apis/adsense/v2'; export {adsensehost_v4_1} from './apis/adsensehost/v4.1'; +export {adsenseplatform_v1} from './apis/adsenseplatform/v1'; +export {adsenseplatform_v1alpha} from './apis/adsenseplatform/v1alpha'; export {advisorynotifications_v1} from './apis/advisorynotifications/v1'; export {aiplatform_v1} from './apis/aiplatform/v1'; export {aiplatform_v1beta1} from './apis/aiplatform/v1beta1'; @@ -80,6 +82,7 @@ export {artifactregistry_v1beta2} from './apis/artifactregistry/v1beta2'; export {assuredworkloads_v1} from './apis/assuredworkloads/v1'; export {assuredworkloads_v1beta1} from './apis/assuredworkloads/v1beta1'; export {authorizedbuyersmarketplace_v1} from './apis/authorizedbuyersmarketplace/v1'; +export {authorizedbuyersmarketplace_v1alpha} from './apis/authorizedbuyersmarketplace/v1alpha'; export {backupdr_v1} from './apis/backupdr/v1'; export {baremetalsolution_v1} from './apis/baremetalsolution/v1'; export {baremetalsolution_v1alpha1} from './apis/baremetalsolution/v1alpha1'; @@ -181,6 +184,7 @@ export {containeranalysis_v1beta1} from './apis/containeranalysis/v1beta1'; export {content_v2_1} from './apis/content/v2.1'; export {content_v2} from './apis/content/v2'; export {contentwarehouse_v1} from './apis/contentwarehouse/v1'; +export {css_v1} from './apis/css/v1'; export {customsearch_v1} from './apis/customsearch/v1'; export {datacatalog_v1} from './apis/datacatalog/v1'; export {datacatalog_v1beta1} from './apis/datacatalog/v1beta1'; @@ -291,6 +295,7 @@ export {gkehub_v1alpha2} from './apis/gkehub/v1alpha2'; export {gkehub_v1beta} from './apis/gkehub/v1beta'; export {gkehub_v1beta1} from './apis/gkehub/v1beta1'; export {gkehub_v2alpha} from './apis/gkehub/v2alpha'; +export {gkehub_v2beta} from './apis/gkehub/v2beta'; export {gkeonprem_v1} from './apis/gkeonprem/v1'; export {gmail_v1} from './apis/gmail/v1'; export {gmailpostmastertools_v1} from './apis/gmailpostmastertools/v1'; @@ -317,6 +322,7 @@ export {jobs_v2} from './apis/jobs/v2'; export {jobs_v3} from './apis/jobs/v3'; export {jobs_v3p1beta1} from './apis/jobs/v3p1beta1'; export {jobs_v4} from './apis/jobs/v4'; +export {keep_v1} from './apis/keep/v1'; export {kgsearch_v1} from './apis/kgsearch/v1'; export {kmsinventory_v1} from './apis/kmsinventory/v1'; export {language_v1} from './apis/language/v1';